GET api/v1/delivery/{ticket}

Fetch information about a delivery

Request Information

URI Parameters

Name	Description	Type	Additional information
ticket	A unique identifier used to fetch a delivery	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Delivery result with any potential errors that where caught during validation

DeliveryResult

Name	Description	Type	Additional information
successfulValidation	Validation was successful	boolean	None.
ticket	The ticket for the requested delivery	globally unique identifier	None.
errors	Error object containing potential errors for the delivery.	Collection of DeliveryError	None.

Response Formats

application/json, text/json

Sample:

{
  "successfulValidation": false,
  "ticket": "00ebfe42-a11e-4216-8cc8-5ee2ba75a8b5",
  "errors": [
    {
      "httpStatusCode": "BadRequest",
      "errorCode": "500",
      "errorReason": "Not validated",
      "errorMessage": "Error 1",
      "rowErrors": [
        {
          "errorDescription": "Wrong number of Fields",
          "rowData": "Field"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<DeliveryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydraHelpPage.Models">
  <errors>
    <DeliveryError>
      <errorCode>500</errorCode>
      <errorMessage>Error 1</errorMessage>
      <errorReason>Not validated</errorReason>
      <httpStatusCode>BadRequest</httpStatusCode>
      <rowErrors>
        <RowError>
          <errorDescription>Wrong number of Fields</errorDescription>
          <rowData>Field</rowData>
        </RowError>
      </rowErrors>
    </DeliveryError>
  </errors>
  <successfulValidation>false</successfulValidation>
  <ticket>00ebfe42-a11e-4216-8cc8-5ee2ba75a8b5</ticket>
</DeliveryResult>