POST Partner/GetOrderList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PageIndex	integer	Required
PageSize	integer	Required
PaginationField	string	Required
PaginationAsc	boolean	Required
ParticipantName	string	None.
ParticipantSSN	string	None.
StartDate	string	None.
EndDate	string	None.
ParticipantIDs	Collection of integer	None.
SupplierID	integer	None.
SubSupplierID	integer	None.
OrderID	integer	None.
ExternalOrderID	string	None.
PartnerAccessKey	string	None.
CampaignID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 1,
  "PageSize": 2,
  "PaginationField": "sample string 3",
  "PaginationAsc": true,
  "ParticipantName": "sample string 5",
  "ParticipantSSN": "sample string 6",
  "StartDate": "sample string 7",
  "EndDate": "sample string 8",
  "ParticipantIDs": [
    1,
    2
  ],
  "SupplierID": 1,
  "SubSupplierID": 1,
  "OrderID": 1,
  "ExternalOrderID": "sample string 9",
  "PartnerAccessKey": "sample string 10",
  "CampaignID": 11
}

application/xml, text/xml

Sample:

<GetOrderListDTORequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PartnerAccessKey>sample string 10</PartnerAccessKey>
  <CampaignID>11</CampaignID>
  <PageIndex>1</PageIndex>
  <PageSize>2</PageSize>
  <PaginationField>sample string 3</PaginationField>
  <PaginationAsc>true</PaginationAsc>
  <ParticipantName>sample string 5</ParticipantName>
  <ParticipantSSN>sample string 6</ParticipantSSN>
  <StartDate>sample string 7</StartDate>
  <EndDate>sample string 8</EndDate>
  <ParticipantIDs>
    <long>1</long>
    <long>2</long>
  </ParticipantIDs>
  <SupplierID>1</SupplierID>
  <SubSupplierID>1</SubSupplierID>
  <OrderID>1</OrderID>
  <ExternalOrderID>sample string 9</ExternalOrderID>
</GetOrderListDTORequest>

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 'GetOrderListDTORequest'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.