Consignment Image

import consignment Image data/images

/Api/ConsignmentImage

The consignment Image API method allows HTTP Put actions and requires the consignment to already exist in the system. It allows you to upload general consignment images 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
ImageType		The type of image [Pod, DamagePhoto, ConsignmentPhoto, LeftAsInstructedPhoto, PaperPodPhoto]
ImageLat		The geo latitude that this Image was obtained at
ImageLong		The geo longitude that this Image was obtained at
ImageGeoReadTime		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)
DateTime		The datetime of the Image. Format: yyyy-MM-dd HH:mm (for UTC) or yyyy-MM-ddTHH:mm+Z (for local Ex: 2016-05-10T10:30+10:00)
ImageBy		The user that created the image
Base64Image	Yes	Base 64 encoded value for the image
UniqueIdImage		Your unique ID of this Image
PickupRelated		The Image 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", "DateTime" : "2015-10-15 13:33", "Base64Image" : "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
2150	ConsignmentMissing
2151	ImageMissing
2152	FailedBase64ImageConversion