Consignment POD

import consignment POD data/images

/Api/ConsignmentPod

The consignment POD API method allows HTTP Put actions and requires the consignment to already exist in the system. It allows you to upload consignment POD images or POD signatures and associated data

HTTP Put

Allows you to insert a consignment POD in your TransVirtual database.

Request Properties

Property Name	Required	Description
ConsignmentNumber		Consignment number (also the tracking number).[Required if UniqueId or Id not provided] Max length: 100
Id		A unique TransVirtual key value that our system returned on consignment creation.[Required if ConsignmentNumber or UniqueId not provided] Max length: 20
UniqueId		A unique key value that your system will identify with the consignment.[Required if ConsignmentNumber or Id not provided] Max length: 200
DateTime		The datetime of the POD. Format: yyyy-MM-dd HH:mm (for UTC) or yyyy-MM-ddTHH:mm+Z (for local Ex: 2016-05-10T10:30+10:00)
ArriveDateTime		The datetime that the driver arrived at location. Format: yyyy-MM-dd HH:mm (for UTC) or yyyy-MM-ddTHH:mm+Z (for local Ex: 2016-05-10T10:30+10:00)
DriverName		The driver name
ReceivedBy		The person that signed for the goods
RejectedNotes		Notes given for rejected consignments
DriverNotes		Notes created by the driver
PodType		The type of the POD [Complete, Rejected, LeftAsInstructed, Short]
Base64PodImage		Base 64 encoded value for the full POD image
UniqueIdPod		Your unique ID of this POD
Base64SignatureImage		Base 64 encoded value for just the signature obtained
PodGeoLat		The geo latitude that this POD was obtained at
PodGeoLong		The geo longitude that this POD was obtained at
PodGeoReadTime		The datetime that the geo location was obtained. Format: yyyy-MM-dd HH:mm (for UTC) or yyyy-MM-ddTHH:mm+Z (for local Ex: 2016-05-10T10:30+10:00)
PodQtySignedFor		The quantity signed for
PodUrl		The URL we can obtain the full POD image from
SignatureUrl		The URL we can obtain the signature image from
PickupRelated		The POD relates to the pickup component of this consignment
ApiImportTag		A tag that can be used to assist with generating advanced export rules. Max length: 50

Response Properties

The response properties for the HTTP Put found within the Data field of the reponse

Property Name	Description
Id	The TransVirtual Id of the consignment pod created

Example Put

Request (json)


                    PUT /Api/ConsignmentStatus HTTP/1.1
            Host: api.transvirtual.com.au
            Accept: */*
            Authorization: 11111|QHYKGDFDSL
            Content-Type: application/json
            Content-Length: 0

            {"UniqueId":"476332","ConsignmentNumber":"HA8833223","PodType":"Completed", "DateTime" : "2015-10-15 13:33", "Base64SignatureImage" : "A63529....."}

Response (json)


                    HTTP/1.1 200 OK
            Content-Type: application/json; charset=utf-8
            Content-Length: 82

            {"TransactionID":11244,"StatusCode":200,"StatusText":"OK", "Data":{"Id":"76334"}}

Error Codes

Error Code	Description
2100	ConsignmentMissing
2101	ImageMissing
2102	FailedBase64PodImageConversion
2103	FailedBase64SingatureImageConversion
2104	PodTypeMissing