POST api/OnBoarding/getAdvorderid

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Typeid	integer	None.
Stateids	string	None.
Segmentsid	string	None.
startdate	date	None.
enddate	date	None.
budget	integer	None.
businessid	integer	None.
CountryCode	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Typeid": 1,
  "Stateids": "sample string 2",
  "Segmentsid": "sample string 3",
  "startdate": "2025-04-04T04:02:21.1914337+00:00",
  "enddate": "2025-04-04T04:02:21.1914337+00:00",
  "budget": 6,
  "businessid": 7,
  "CountryCode": 8
}

application/xml, text/xml

Sample:

<getadvertisementPrm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <CountryCode>8</CountryCode>
  <Segmentsid>sample string 3</Segmentsid>
  <Stateids>sample string 2</Stateids>
  <Typeid>1</Typeid>
  <budget>6</budget>
  <businessid>7</businessid>
  <enddate>2025-04-04T04:02:21.1914337+00:00</enddate>
  <startdate>2025-04-04T04:02:21.1914337+00:00</startdate>
</getadvertisementPrm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/04/04 04:02:21",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>