POST api/MailTracking/GetCertifiedDeliveryStatus

Gets recipient delivery status details for the provided list of receipt numbers.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId		integer	None.
AuthToken		string	None.
ReceiptIdList	The receipt numbers that will be used to search for invoice details. Client Id is required and must be a positive number.	Collection of string	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "ReceiptIdList": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetCertifiedDeliveryStatusRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <ReceiptIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ReceiptIdList>
  <UserId>1</UserId>
</GetCertifiedDeliveryStatusRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing recipient delivery status details for the provided list of receipt numbers

GetCertifiedDeliveryStatusesResponseModel

Name	Description	Type	Additional information
DeliveryStatuses		Collection of GetCertifiedDeliveryStatusResponseModel	None.
ErrorDetails		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "DeliveryStatuses": [
    {
      "ReceiptId": "sample string 1",
      "TrackingStatus": "sample string 2"
    },
    {
      "ReceiptId": "sample string 1",
      "TrackingStatus": "sample string 2"
    }
  ],
  "ErrorDetails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetCertifiedDeliveryStatusesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <DeliveryStatuses>
    <GetCertifiedDeliveryStatusResponseModel>
      <ReceiptId>sample string 1</ReceiptId>
      <TrackingStatus>sample string 2</TrackingStatus>
    </GetCertifiedDeliveryStatusResponseModel>
    <GetCertifiedDeliveryStatusResponseModel>
      <ReceiptId>sample string 1</ReceiptId>
      <TrackingStatus>sample string 2</TrackingStatus>
    </GetCertifiedDeliveryStatusResponseModel>
  </DeliveryStatuses>
  <ErrorDetails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorDetails>
</GetCertifiedDeliveryStatusesResponseModel>