Api.Gapi

<back to all web services

SearchCompetitor

This service is used to add a new competitor to the marketing database.

The following routes are available for this service:
GET/competitor

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/SearchCompetitor HTTP/1.1 
Host: gapi-api.hotelplan.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	company: String,
	scrapeType: String,
	active: False,
	appNameString: String,
	version: String,
	requestUrl: String,
	ip: String,
	requestId: 00000000000000000000000000000000,
	page: 0,
	pageSize: 0,
	sortField: String,
	sortOrder: String,
	metaData: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalRecords: 0,
	recordsFiltered: 0
}