POST api/OntimePerformance/Data
Retrieve the Ontime Performance data
Request Information
URI Parameters
None.
Body Parameters
OntimePerformanceParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| StartDate |
Start date for report (yyyy-MM-dd) |
string |
None. |
| EndDate |
End date for report (yyyy-MM-dd) |
string |
None. |
| AccountNumber | string |
None. |
|
| ServiceID | integer |
None. |
|
| Format |
DETAIL or SUMMARY |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AccountNumber": "sample string 4",
"EndDate": "sample string 3",
"Format": "sample string 5",
"ServiceID": 1,
"StartDate": "sample string 2",
"auth": "sample string 1"
}
application/xml, text/xml
Sample:
<OntimePerformanceParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <AccountNumber>sample string 4</AccountNumber> <EndDate>sample string 3</EndDate> <Format>sample string 5</Format> <ServiceID>1</ServiceID> <StartDate>sample string 2</StartDate> <auth>sample string 1</auth> </OntimePerformanceParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
OntimePerformanceResp| Name | 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. |
| Items | Collection of OntimePerformanceItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorMessage": "sample string 2",
"IsSuccessful": true,
"Items": [
{
"AccountName": "sample string 6",
"AccountNumber": "sample string 5",
"ActualDeliveryDateTime": "2025-12-17T10:42:54.649-08:00",
"ClassName": "sample string 21",
"ClassSortOrder": 22,
"CountControllable": 18,
"CountIsLate": 17,
"CountUncontrollable": 19,
"CountUnknown": 20,
"DeliveryAirportID": "sample string 10",
"IsLate": true,
"LogoUrl": "sample string 12",
"OfficeCode": "sample string 4",
"OrderState": "sample string 11",
"PickupAirportID": "sample string 9",
"QualityControlCode": "sample string 13",
"QualityControlID": 1,
"QualityControlIsControllable": true,
"QualityControlName": "sample string 14",
"QuotedDeliveryDateTime": "2025-12-17T10:42:54.649-08:00",
"ServiceCode": "sample string 7",
"ServiceName": "sample string 8",
"ShipmentGUID": "sample string 1",
"ShipmentNumber": 2,
"Signature": "sample string 3",
"TrackingLink": "sample string 23"
},
{
"AccountName": "sample string 6",
"AccountNumber": "sample string 5",
"ActualDeliveryDateTime": "2025-12-17T10:42:54.649-08:00",
"ClassName": "sample string 21",
"ClassSortOrder": 22,
"CountControllable": 18,
"CountIsLate": 17,
"CountUncontrollable": 19,
"CountUnknown": 20,
"DeliveryAirportID": "sample string 10",
"IsLate": true,
"LogoUrl": "sample string 12",
"OfficeCode": "sample string 4",
"OrderState": "sample string 11",
"PickupAirportID": "sample string 9",
"QualityControlCode": "sample string 13",
"QualityControlID": 1,
"QualityControlIsControllable": true,
"QualityControlName": "sample string 14",
"QuotedDeliveryDateTime": "2025-12-17T10:42:54.649-08:00",
"ServiceCode": "sample string 7",
"ServiceName": "sample string 8",
"ShipmentGUID": "sample string 1",
"ShipmentNumber": 2,
"Signature": "sample string 3",
"TrackingLink": "sample string 23"
}
]
}
application/xml, text/xml
Sample:
<OntimePerformanceResp 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>
<IsSuccessful>true</IsSuccessful>
<Items>
<OntimePerformanceItem>
<AccountName>sample string 6</AccountName>
<AccountNumber>sample string 5</AccountNumber>
<ActualDeliveryDateTime>2025-12-17T10:42:54.6498795-08:00</ActualDeliveryDateTime>
<ClassName>sample string 21</ClassName>
<ClassSortOrder>22</ClassSortOrder>
<CountControllable>18</CountControllable>
<CountIsLate>17</CountIsLate>
<CountUncontrollable>19</CountUncontrollable>
<CountUnknown>20</CountUnknown>
<DeliveryAirportID>sample string 10</DeliveryAirportID>
<IsLate>true</IsLate>
<LogoUrl>sample string 12</LogoUrl>
<OfficeCode>sample string 4</OfficeCode>
<OrderState>sample string 11</OrderState>
<PickupAirportID>sample string 9</PickupAirportID>
<QualityControlCode>sample string 13</QualityControlCode>
<QualityControlID>1</QualityControlID>
<QualityControlIsControllable>true</QualityControlIsControllable>
<QualityControlName>sample string 14</QualityControlName>
<QuotedDeliveryDateTime>2025-12-17T10:42:54.6498795-08:00</QuotedDeliveryDateTime>
<ServiceCode>sample string 7</ServiceCode>
<ServiceName>sample string 8</ServiceName>
<ShipmentGUID>sample string 1</ShipmentGUID>
<ShipmentNumber>2</ShipmentNumber>
<Signature>sample string 3</Signature>
<TrackingLink>sample string 23</TrackingLink>
</OntimePerformanceItem>
<OntimePerformanceItem>
<AccountName>sample string 6</AccountName>
<AccountNumber>sample string 5</AccountNumber>
<ActualDeliveryDateTime>2025-12-17T10:42:54.6498795-08:00</ActualDeliveryDateTime>
<ClassName>sample string 21</ClassName>
<ClassSortOrder>22</ClassSortOrder>
<CountControllable>18</CountControllable>
<CountIsLate>17</CountIsLate>
<CountUncontrollable>19</CountUncontrollable>
<CountUnknown>20</CountUnknown>
<DeliveryAirportID>sample string 10</DeliveryAirportID>
<IsLate>true</IsLate>
<LogoUrl>sample string 12</LogoUrl>
<OfficeCode>sample string 4</OfficeCode>
<OrderState>sample string 11</OrderState>
<PickupAirportID>sample string 9</PickupAirportID>
<QualityControlCode>sample string 13</QualityControlCode>
<QualityControlID>1</QualityControlID>
<QualityControlIsControllable>true</QualityControlIsControllable>
<QualityControlName>sample string 14</QualityControlName>
<QuotedDeliveryDateTime>2025-12-17T10:42:54.6498795-08:00</QuotedDeliveryDateTime>
<ServiceCode>sample string 7</ServiceCode>
<ServiceName>sample string 8</ServiceName>
<ShipmentGUID>sample string 1</ShipmentGUID>
<ShipmentNumber>2</ShipmentNumber>
<Signature>sample string 3</Signature>
<TrackingLink>sample string 23</TrackingLink>
</OntimePerformanceItem>
</Items>
</OntimePerformanceResp>