POST api/OmniPay/GetPaginatedOmnipayPushOrders

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LgaId	integer	None.
StateId	integer	None.
Status	PushOrderStatus	None.
DriverId	integer	None.
ReportsTo	integer	None.
OrgType	integer	None.
Search	string	None.
StartDate	date	None.
EndDate	date	None.
PageNo	integer	None.
PageRows	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LgaId": 1,
  "StateId": 2,
  "Status": 0,
  "DriverId": 3,
  "ReportsTo": 4,
  "OrgType": 5,
  "Search": "sample string 6",
  "StartDate": "2025-04-28T14:49:35.2571644+00:00",
  "EndDate": "2025-04-28T14:49:35.2571644+00:00",
  "PageNo": 7,
  "PageRows": 8
}

application/xml, text/xml

Sample:

<PushOrdersFilters xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PageNo>7</PageNo>
  <PageRows>8</PageRows>
  <LgaId>1</LgaId>
  <StateId>2</StateId>
  <Status>All</Status>
  <DriverId>3</DriverId>
  <ReportsTo>4</ReportsTo>
  <OrgType>5</OrgType>
  <Search>sample string 6</Search>
  <StartDate>2025-04-28T14:49:35.2571644+00:00</StartDate>
  <EndDate>2025-04-28T14:49:35.2571644+00:00</EndDate>
</PushOrdersFilters>

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/28 14:49:35",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StatusCode>1</StatusCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
</VCAPIResponse>