POST api/OntimePerformance/Report

Retrieve the Ontime Performance report (pdf)

Request Information

URI Parameters

None.

Body Parameters

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

OntimePerformanceReportResp

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.
FileData	The raw file data	string	None.
FileName	Name of the file	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "FileData": "sample string 3",
  "FileName": "sample string 4",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<OntimePerformanceReportResp 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>
</OntimePerformanceReportResp>