POST Account/GetCompetitorListForSIDCollection?includesubscriber={includesubscriber}

Request Information

URI Parameters

Name	Description	Type	Additional information
includesubscriber		boolean	Default value is False

Body Parameters

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

text/html

Sample:

[1,2]

application/xml, text/xml

Sample:

<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <int>1</int>
  <int>2</int>
</ArrayOfint>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

ResponseOfListOfCompetitorData

Name	Type	Additional information
Message	string	None.
Status	boolean	None.
Body	Collection of CompetitorData	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Status": true,
  "Body": [
    {
      "SID": 1,
      "HMID": 1,
      "Name": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "CityCode": "sample string 5",
      "State": "sample string 6",
      "StateCode": "sample string 7",
      "Country": "sample string 8",
      "CountryCode": "sample string 9",
      "Currency": "sample string 10",
      "ZipCode": "sample string 11",
      "Long": 1.1,
      "Lat": 1.1,
      "BrandID": 1,
      "BrandName": "sample string 12",
      "SortOrder": 13
    },
    {
      "SID": 1,
      "HMID": 1,
      "Name": "sample string 1",
      "Address1": "sample string 2",
      "Address2": "sample string 3",
      "City": "sample string 4",
      "CityCode": "sample string 5",
      "State": "sample string 6",
      "StateCode": "sample string 7",
      "Country": "sample string 8",
      "CountryCode": "sample string 9",
      "Currency": "sample string 10",
      "ZipCode": "sample string 11",
      "Long": 1.1,
      "Lat": 1.1,
      "BrandID": 1,
      "BrandName": "sample string 12",
      "SortOrder": 13
    }
  ]
}

text/html

Sample:

{"Message":"sample string 1","Status":true,"Body":[{"SID":1,"HMID":1,"Name":"sample string 1","Address1":"sample string 2","Address2":"sample string 3","City":"sample string 4","CityCode":"sample string 5","State":"sample string 6","StateCode":"sample string 7","Country":"sample string 8","CountryCode":"sample string 9","Currency":"sample string 10","ZipCode":"sample string 11","Long":1.1,"Lat":1.1,"BrandID":1,"BrandName":"sample string 12","SortOrder":13},{"SID":1,"HMID":1,"Name":"sample string 1","Address1":"sample string 2","Address2":"sample string 3","City":"sample string 4","CityCode":"sample string 5","State":"sample string 6","StateCode":"sample string 7","Country":"sample string 8","CountryCode":"sample string 9","Currency":"sample string 10","ZipCode":"sample string 11","Long":1.1,"Lat":1.1,"BrandID":1,"BrandName":"sample string 12","SortOrder":13}]}

application/xml, text/xml

Sample:

<ResponseOfArrayOfCompetitorDataQzIzD0mn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body>
    <CompetitorData>
      <Address1>sample string 2</Address1>
      <Address2>sample string 3</Address2>
      <BrandID>1</BrandID>
      <BrandName>sample string 12</BrandName>
      <City>sample string 4</City>
      <CityCode>sample string 5</CityCode>
      <Country>sample string 8</Country>
      <CountryCode>sample string 9</CountryCode>
      <Currency>sample string 10</Currency>
      <HMID>1</HMID>
      <Lat>1.1</Lat>
      <Long>1.1</Long>
      <Name>sample string 1</Name>
      <SID>1</SID>
      <SortOrder>13</SortOrder>
      <State>sample string 6</State>
      <StateCode>sample string 7</StateCode>
      <ZipCode>sample string 11</ZipCode>
    </CompetitorData>
    <CompetitorData>
      <Address1>sample string 2</Address1>
      <Address2>sample string 3</Address2>
      <BrandID>1</BrandID>
      <BrandName>sample string 12</BrandName>
      <City>sample string 4</City>
      <CityCode>sample string 5</CityCode>
      <Country>sample string 8</Country>
      <CountryCode>sample string 9</CountryCode>
      <Currency>sample string 10</Currency>
      <HMID>1</HMID>
      <Lat>1.1</Lat>
      <Long>1.1</Long>
      <Name>sample string 1</Name>
      <SID>1</SID>
      <SortOrder>13</SortOrder>
      <State>sample string 6</State>
      <StateCode>sample string 7</StateCode>
      <ZipCode>sample string 11</ZipCode>
    </CompetitorData>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfArrayOfCompetitorDataQzIzD0mn>