POST FNF/GetWaybillStatus

Request Information

URI Parameters

None.

Body Parameters

WaybillStatusRequest
NameDescriptionTypeAdditional information
SecurityToken

string

None.

WaybillNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SecurityToken": "sample string 1",
  "WaybillNumber": "sample string 2"
}

application/xml, text/xml

Sample:
<WaybillStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fnf.oneplan.co.za.Models">
  <SecurityToken>sample string 1</SecurityToken>
  <WaybillNumber>sample string 2</WaybillNumber>
</WaybillStatusRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WaybillStatusRequest'.

Response Information

Resource Description

ResponseOfWaybillStatus
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

WaybillStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "CardId": 1,
    "TrackingNumber": "sample string 2",
    "IsSignatureDownloaded": true,
    "IsIdentityDocumentDownloaded": true,
    "IsProofofDelivery001Downloaded": true,
    "IsProofofDelivery002Downloaded": true,
    "IsReadyForPopi": true
  }
}

application/xml, text/xml

Sample:
<ResponseOfFNFRepo.WaybillStatusV_SiB8Oif xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/fnf.oneplan.co.za.Models.Repo">
    <d2p1:CardId>1</d2p1:CardId>
    <d2p1:IsIdentityDocumentDownloaded>true</d2p1:IsIdentityDocumentDownloaded>
    <d2p1:IsProofofDelivery001Downloaded>true</d2p1:IsProofofDelivery001Downloaded>
    <d2p1:IsProofofDelivery002Downloaded>true</d2p1:IsProofofDelivery002Downloaded>
    <d2p1:IsReadyForPopi>true</d2p1:IsReadyForPopi>
    <d2p1:IsSignatureDownloaded>true</d2p1:IsSignatureDownloaded>
    <d2p1:TrackingNumber>sample string 2</d2p1:TrackingNumber>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfFNFRepo.WaybillStatusV_SiB8Oif>