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 .xml suffix or ?format=xml

HTTP + XML

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

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

<SearchCompetitor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Competitor">
  <AppNameString xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</AppNameString>
  <Ip xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</Ip>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MetaData>
  <Page xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">0</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">0</PageSize>
  <RequestId xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">00000000-0000-0000-0000-000000000000</RequestId>
  <RequestUrl xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</RequestUrl>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</SortField>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</SortOrder>
  <Version xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto.Base">String</Version>
  <Active>false</Active>
  <Company>String</Company>
  <Id>0</Id>
  <ScrapeType>String</ScrapeType>
</SearchCompetitor>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiMultipleResultsOfCompetitory7S3chsu xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Dto">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Gapi.Client.Model.Competitor" i:nil="true" />
  <RecordsFiltered>0</RecordsFiltered>
  <TotalRecords>0</TotalRecords>
</ApiMultipleResultsOfCompetitory7S3chsu>