POST api/{siteCode}/Transport/WritePOD

Writes a pod to the originating job. Where the delivery reference is in the format xxxxxx-nnnn parse xxxxxx as the JobNumber and nnnn as the DocumentID. Where the delivery reference is in the format xxxxxx parse xxxxxx as the JobNumber and ignore DocumentID.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteCode	The site code.	integer	Required

Body Parameters

The pod record.

PODRecord

Name	Type	Additional information
DocumentID	integer	None.
JobNumber	string	None.
SignatureName	string	None.
DeliveredDate	date	None.
DeliveredTime	date	None.
Comments	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentID": 5081,
  "JobNumber": "HD6832",
  "SignatureName": "A Recipient",
  "DeliveredDate": "2025-02-04T00:00:00+00:00",
  "DeliveredTime": "2025-02-04T23:06:22.8890533+00:00",
  "Comments": "Any delivery comments would be entered here."
}

application/xml, text/xml

Sample:

<PODRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocumentID>5081</DocumentID>
  <JobNumber>HD6832</JobNumber>
  <SignatureName>A Recipient</SignatureName>
  <DeliveredDate>2025-02-04T00:00:00+00:00</DeliveredDate>
  <DeliveredTime>2025-02-04T23:06:22.8890533+00:00</DeliveredTime>
  <Comments>Any delivery comments would be entered here.</Comments>
</PODRecord>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.