POST api/ExportData/RunReport/Order
Retrieve the Export Data file (when ExportSourceID=10001)
Request Information
URI Parameters
None.
Body Parameters
ExportDataOrderParmName | Description | Type | Additional information |
---|---|---|---|
auth | string |
None. |
|
ExportMasterID | integer |
None. |
|
UpdatedPickupDateTime_Start |
Updated pickup date/time - start date (yyyy-MM-dd HH:mm) |
string |
None. |
UpdatedPickupDateTime_End |
Updated pickup date/time - end date (yyyy-MM-dd HH:mm) |
string |
None. |
AccountNumber | string |
None. |
|
PickupNumber | integer |
None. |
|
InvoiceNumber | integer |
None. |
|
IncludeDeleted | boolean |
None. |
|
OfficeID | integer |
None. |
|
PickupAirportID | string |
None. |
|
ServiceCodeList | string |
None. |
|
IncludeOnlyScreened | boolean |
None. |
|
UpdatedDeliveryDateTime_Start |
Updated delivery date/time - start date (yyyy-MM-dd HH:mm) |
string |
None. |
UpdatedDeliveryDateTime_End |
Updated delivery date/time - end date (yyyy-MM-dd HH:mm) |
string |
None. |
ArriveDateTime_Start |
Flight arrival date/time - start date (yyyy-MM-dd HH:mm) |
string |
None. |
ArriveDateTime_End |
Flight arrival date/time - end date (yyyy-MM-dd HH:mm) |
string |
None. |
PickupCityName | string |
None. |
|
PickupCountryID | string |
None. |
|
DeliveryCityName | string |
None. |
|
DeliveryCountryID | string |
None. |
|
RecoverAirportID | string |
None. |
|
Reference | string |
None. |
Request Formats
application/json, text/json
{ "AccountNumber": "sample string 5", "ArriveDateTime_End": "sample string 13", "ArriveDateTime_Start": "sample string 12", "DeliveryCityName": "sample string 16", "DeliveryCountryID": "sample string 17", "ExportMasterID": 2, "IncludeDeleted": true, "IncludeOnlyScreened": true, "InvoiceNumber": 1, "OfficeID": 1, "PickupAirportID": "sample string 7", "PickupCityName": "sample string 14", "PickupCountryID": "sample string 15", "PickupNumber": 1, "RecoverAirportID": "sample string 18", "Reference": "sample string 19", "ServiceCodeList": "sample string 8", "UpdatedDeliveryDateTime_End": "sample string 11", "UpdatedDeliveryDateTime_Start": "sample string 10", "UpdatedPickupDateTime_End": "sample string 4", "UpdatedPickupDateTime_Start": "sample string 3", "auth": "sample string 1" }
application/xml, text/xml
<ExportDataOrderParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <AccountNumber>sample string 5</AccountNumber> <ArriveDateTime_End>sample string 13</ArriveDateTime_End> <ArriveDateTime_Start>sample string 12</ArriveDateTime_Start> <DeliveryCityName>sample string 16</DeliveryCityName> <DeliveryCountryID>sample string 17</DeliveryCountryID> <ExportMasterID>2</ExportMasterID> <IncludeDeleted>true</IncludeDeleted> <IncludeOnlyScreened>true</IncludeOnlyScreened> <InvoiceNumber>1</InvoiceNumber> <OfficeID>1</OfficeID> <PickupAirportID>sample string 7</PickupAirportID> <PickupCityName>sample string 14</PickupCityName> <PickupCountryID>sample string 15</PickupCountryID> <PickupNumber>1</PickupNumber> <RecoverAirportID>sample string 18</RecoverAirportID> <Reference>sample string 19</Reference> <ServiceCodeList>sample string 8</ServiceCodeList> <UpdatedDeliveryDateTime_End>sample string 11</UpdatedDeliveryDateTime_End> <UpdatedDeliveryDateTime_Start>sample string 10</UpdatedDeliveryDateTime_Start> <UpdatedPickupDateTime_End>sample string 4</UpdatedPickupDateTime_End> <UpdatedPickupDateTime_Start>sample string 3</UpdatedPickupDateTime_Start> <auth>sample string 1</auth> </ExportDataOrderParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ExportDataOrderRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
FileData |
The raw file data |
string |
None. |
FileName |
The name of the data file created |
string |
None. |
Response Formats
application/json, text/json
{ "ErrorMessage": "sample string 2", "FileData": "sample string 3", "FileName": "sample string 4", "IsSuccessful": true }
application/xml, text/xml
<ExportDataOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <FileData>sample string 3</FileData> <FileName>sample string 4</FileName> <IsSuccessful>true</IsSuccessful> </ExportDataOrderResp>