POST api/Movam/GetPaginatedVsrShipmentList

Request Information

URI Parameters

None.

Body Parameters

GetPaginatedVsrShipmentFilter
NameDescriptionTypeAdditional information
VsrId

integer

None.

ShipmentStatus

integer

None.

ShipmentId

string

None.

IsPaid

integer

None.

StartDate

date

None.

EndDate

date

None.

PageNo

integer

None.

PageRows

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "VsrId": 1,
  "ShipmentStatus": 2,
  "ShipmentId": "sample string 3",
  "IsPaid": 4,
  "StartDate": "2024-09-19T18:19:29.8907753+01:00",
  "EndDate": "2024-09-19T18:19:29.8907753+01:00",
  "PageNo": 5,
  "PageRows": 6
}

application/xml, text/xml

Sample:
<GetPaginatedVsrShipmentFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <PageNo>5</PageNo>
  <PageRows>6</PageRows>
  <EndDate>2024-09-19T18:19:29.8907753+01:00</EndDate>
  <IsPaid>4</IsPaid>
  <ShipmentId>sample string 3</ShipmentId>
  <ShipmentStatus>2</ShipmentStatus>
  <StartDate>2024-09-19T18:19:29.8907753+01:00</StartDate>
  <VsrId>1</VsrId>
</GetPaginatedVsrShipmentFilter>

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

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional 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": "2024/09/19 18:19:29",
  "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>