APIVersion
| API | Description |
|---|---|
| GET api/APIVersion |
Return the Current API Version |
Authenticate
Allows a user to be authenticated on the server, it returns A RemoteUserRecord object that contains the AuthToken
| API | Description |
|---|---|
| GET api/Authenticate?Username={Username}&Password={Password}&DeviceID={DeviceID} |
Allows a user to be authenticated on the server, it returns A RemoteUserRecord object that contains the AuthToken |
GenerateConditionReport
| API | Description |
|---|---|
| POST api/GenerateConditionReport?AuthToken={AuthToken}&JobID={JobID} |
Request the Server to Generate a PDF of the Condition Report |
GetConditionReportQuestions
Get a list of questions for Condition Reports
| API | Description |
|---|---|
| GET api/GetConditionReportQuestions?AuthToken={AuthToken} |
Get a list of Jobs for Condition Report |
GetContainersForAdditionalImages
Get a list of Jobs That can have additional Images
| API | Description |
|---|---|
| GET api/GetContainersForAdditionalImages?AuthToken={AuthToken}&numberOfDays={numberOfDays} |
Get a list of Jobs That can have additional Images |
GetContainersForCollection
Get a list of Containers For Collection
| API | Description |
|---|---|
| GET api/GetContainersForCollection?AuthToken={AuthToken}&JobType={JobType} |
Get a list of Containers For Collection |
GetContainersForDeliveryToQuay
| API | Description |
|---|---|
| GET api/GetContainersForDeliveryToQuay?AuthToken={AuthToken} |
Get a list of Containers For Delivery to Quay |
GetContainersForLoad
| API | Description |
|---|---|
| GET api/GetContainersForLoad?AuthToken={AuthToken} |
Get a list of Containers For Collection |
GetContainersForRestitution
| API | Description |
|---|---|
| GET api/GetContainersForRestitution?AuthToken={AuthToken} |
Get a list of Containers that require restitution |
GetContainersForUnLoad
| API | Description |
|---|---|
| GET api/GetContainersForUnLoad?AuthToken={AuthToken} |
Get a list of Containers For Collection |
GetDeliveryAgents
Get a list of Delivery Agents
| API | Description |
|---|---|
| GET api/GetDeliveryAgents?AuthToken={AuthToken} |
Get a list of Delivery Agents |
GetDocument
| API | Description |
|---|---|
| GET api/GetDocument?AuthToken={AuthToken}&JobIDorLoadRef={JobIDorLoadRef}&DocumentType={DocumentType} |
PDF document for a specified job id |
GetHandlers
Get a list of Handlers
| API | Description |
|---|---|
| GET api/GetHandlers?AuthToken={AuthToken} |
Get a list of Handlers |
GetImageNames
Get information on images for a specified job id
| API | Description |
|---|---|
| GET api/GetImageNames?AuthToken={AuthToken}&RecordRef={RecordRef}&SearchString={SearchString}&ImageType={ImageType} |
Get information on images for a specified job , Container ref or Transport ref |
GetJobImage
Get Image(s) for a specified job id, passing only the AuthToken and Job ID will return the primary thumbnail
| API | Description |
|---|---|
| GET api/GetJobImage?AuthToken={AuthToken}&JobID={JobID}&ImageType={ImageType}&ImageOption={ImageOption}&ReturnCount={ReturnCount} |
Get Image(s) for a specified job id, passing only the AuthToken and Job ID will return the primary thumbnail |
| GET api/GetJobImage?AuthToken={AuthToken}&JobID={JobID}&FileName={FileName}&ImageOption={ImageOption} |
Get single Image |
GetJobImageInfo
Get information on images for a specified job id
| API | Description |
|---|---|
| GET api/GetJobImageInfo?AuthToken={AuthToken}&JobID={JobID} |
Get information on images for a specified job id |
GetJobRecord
Get a Job Record
| API | Description |
|---|---|
| GET api/GetJobRecord?AuthToken={AuthToken}&JobID={JobID} |
Get a Job Record |
GetJobsForAdditionalImages
Get a list of Jobs That can have additional Images
| API | Description |
|---|---|
| GET api/GetJobsForAdditionalImages?AuthToken={AuthToken}&numberOfDays={numberOfDays} |
Get a list of Jobs That can have additional Images |
GetJobsForAdditionalRequirements
Get a list of Jobs for Additional Requirements
| API | Description |
|---|---|
| GET api/GetJobsForAdditionalRequirements?AuthToken={AuthToken}&MakeOfCar={MakeOfCar} |
Get a list of Jobs for Additional Requirements |
GetJobsForArrival
Get a list of Jobs to be Arrived
| API | Description |
|---|---|
| GET api/GetJobsForArrival?AuthToken={AuthToken}&MakeOfCar={MakeOfCar} |
Get a list of Jobs to be Arrived |
GetJobsForArrivalFull
Get a list of Jobs to be Arrived-Full Job Data
| API | Description |
|---|---|
| GET api/GetJobsForArrivalFull?AuthToken={AuthToken}&MakeOfCar={MakeOfCar} |
Get a list of Jobs to be Arrived-Full Job Data |
GetJobsForCollection
Get a list of Jobs to be collected
| API | Description |
|---|---|
| GET api/GetJobsForCollection?AuthToken={AuthToken}&LoadRef={LoadRef} |
Get a list of Jobs to be collected |
GetJobsForConditionReport
Get a list of Jobs for Condition Report
| API | Description |
|---|---|
| GET api/GetJobsForConditionReport?AuthToken={AuthToken}&MakeOfCar={MakeOfCar} |
Get a list of Jobs for Condition Report |
GetJobsForContainer
Get a list of Jobs for a container
| API | Description |
|---|---|
| GET api/GetJobsForContainer?AuthToken={AuthToken}&ContainerNo={ContainerNo} |
Get a list of Jobs for a container |
GetJobsForDelivery
Get a list of Jobs to be delivered
| API | Description |
|---|---|
| GET api/GetJobsForDelivery?AuthToken={AuthToken}&LoadRef={LoadRef} |
Get a list of Jobs to be delivered |
GetJobsForRelease
Get a list of Jobs to be collected
| API | Description |
|---|---|
| GET api/GetJobsForRelease?AuthToken={AuthToken}&HaulierName={HaulierName} |
Get a list of Jobs to be release for a given Haulier |
GetResponseOptions
| API | Description |
|---|---|
| GET api/GetResponseOptions?AuthToken={AuthToken} |
Get a list of the Response Options for Condition Reports/Additional Requirements |
GetStringList
Get a list of records based on the list name supplied
| API | Description |
|---|---|
| GET api/GetStringList?AuthToken={AuthToken}&ListName={ListName} |
Supported List Names : "Colours", "Makes", "DeliveryAgents", "ContainersForLoad", "ContainersForUnLoad", "CollectionLoadRefs", "DeliveryLoadRefs", "ReleaseHaulierNames", "MakesForArrival" "MakesForConditionReport", "MakesForAddtionalRequirements" |
GetTransportJobsForAdditionalImages
Get a list of Jobs That can have additional Images
| API | Description |
|---|---|
| GET api/GetTransportJobsForAdditionalImages?AuthToken={AuthToken}&numberOfDays={numberOfDays} |
Get a list of Jobs That can have additional Images |
GetWhatToSync
| API | Description |
|---|---|
| GET api/GetWhatToSync?AuthToken={AuthToken} |
Provides a list of items that need to be syncronized. This should be called each time a sync is performed to determine what data will need to sync / Status codes, Products etc Each item in the list referes to a Method in the API - e.g. CarColours implies a call is needed to the api/GetStringList?AuthToken=&ListName=CarColours to get a new list of the colours on the system. If new items are added to the system this will ensure all are correct on the remote clients. |
ImageUpload
Upload Images to Specific Jobs, Containers or Transport
| API | Description |
|---|---|
| POST api/ImageUpload?AuthToken={AuthToken}&JobID={JobID}&FileNamePrefix={FileNamePrefix}&ImageType={ImageType} |
Upload Images for a Job |
| POST api/ImageUpload?AuthToken={AuthToken}&ContainerNo={ContainerNo}&FileNamePrefix={FileNamePrefix}&SealNo={SealNo} |
Upload Images for a Container (DEPRECIATED) |
| POST api/ImageUpload?AuthToken={AuthToken}&ContainerNo={ContainerNo}&ShippingLineRef={ShippingLineRef}&FileNamePrefix={FileNamePrefix}&SealNo={SealNo} |
Upload Images for a Container using the Container and Shipping Line Ref supplied (NEW) |
| POST api/ImageUpload?AuthToken={AuthToken}&ContainerNo={ContainerNo}&ShippingLineRef={ShippingLineRef}&FileNamePrefix={FileNamePrefix} |
Upload Images for a Container using the Container and Shipping Line Ref supplied (NEW - No Seal) |
| POST api/ImageUpload?AuthToken={AuthToken}&TransportRef={TransportRef}&FileNamePrefix={FileNamePrefix}&TransportType={TransportType}&Overwrite={Overwrite} |
Upload Transport Images for a Delivery/Collection |
Logout
Logout the user
| API | Description |
|---|---|
| GET api/Logout?AuthToken={AuthToken} |
Logout the user |
PutAdditionalRequirements
| API | Description |
|---|---|
| POST api/PutAdditionalRequirements?AuthToken={AuthToken} |
Upload the Additional Requirements Data for a Job |
PutArriveJob
| API | Description |
|---|---|
| POST api/PutArriveJob?AuthToken={AuthToken} |
Upload the Arrive job |
PutConditionReport
| API | Description |
|---|---|
| POST api/PutConditionReport?AuthToken={AuthToken} |
Upload the Condition Report Data for a Job |
PutContainerCollected
| API | Description |
|---|---|
| POST api/PutContainerCollected?AuthToken={AuthToken} |
Upload the Container Collection Data |
PutContainerComplete
Record Container is now complete
| API | Description |
|---|---|
| PUT api/PutContainerComplete?AuthToken={AuthToken}&ContainerNo={ContainerNo} |
Record Container is now complete (DEPRECIATED) |
| PUT api/PutContainerComplete?AuthToken={AuthToken}&ContainerNo={ContainerNo}&ShippingLineRef={ShippingLineRef} |
Record Container is now complete |
PutContainerDeliveredToQuay
| API | Description |
|---|---|
| POST api/PutContainerDeliveredToQuay?AuthToken={AuthToken} |
Upload the Container Date on Quay Date |
PutContainerJobLoaded
Upload the Container Load Data for a Job
| API | Description |
|---|---|
| POST api/PutContainerJobLoaded?AuthToken={AuthToken} |
Upload the Container Load Data for a Job |
PutContainerJobUnloaded
Upload the Container UnLoad Data for a Job (Import)-(DEPRECIATED)
| API | Description |
|---|---|
| POST api/PutContainerJobUnloaded?AuthToken={AuthToken} |
Upload the Container UnLoad Data for a Job (Import)-(DEPRECIATED) |
PutContainerJobUnloadedNew
Upload the Container UnLoad Data for a Job (Import)
| API | Description |
|---|---|
| POST api/PutContainerJobUnloadedNew?AuthToken={AuthToken} |
Upload the Container UnLoad Data for a Job (Import) with ability to create unexpected jobs |
PutContainerRestitution
| API | Description |
|---|---|
| POST api/PutContainerRestitution?AuthToken={AuthToken} |
Upload the Container Restitution Date |
PutJobInProgress
Record a joib as in progress
| API | Description |
|---|---|
| PUT api/PutJobInProgress?AuthToken={AuthToken}&JobID={JobID} |
Record a joib as in progress |
PutLoadCollected
| API | Description |
|---|---|
| POST api/PutLoadCollected?AuthToken={AuthToken}&LoadRef={LoadRef}&FromJAM={FromJAM} |
Upload collected jobs |
PutLoadDelivered
| API | Description |
|---|---|
| POST api/PutLoadDelivered?AuthToken={AuthToken}&LoadRef={LoadRef}&ToJAM={ToJAM} |
Upload delivered jobs |
PutReleaseJob
| API | Description |
|---|---|
| POST api/PutReleaseJob?AuthToken={AuthToken} |
Upload the Container UnLoad Data for a Job |
PutUnexpectedJobCollected
| API | Description |
|---|---|
| POST api/PutUnexpectedJobCollected?AuthToken={AuthToken}&LoadRef={LoadRef} |
Upload unexpected job(s) collected |