MiFleet | DMN API Documentation

Movements API

API actions to interact with DMN movements including booking moves, checking move status, and retrieveing POC / POD.

GET: /moves/accounts

List Movement Accounts

Lists movement accounts accessable with the current API key:

Example Response


[
    {
        "Code": "DMN001",
        "CustName": "DMN Logistics",
        "Addr1": "Scott House",
        "Addr2": "Gibb Street",
        "Addr3": "Digbeth",
        "Addr4": "Birmingham",
        "PostCode": "B9 4AA",
        "ContactName": "Will Brazier",
        "ContactTel": "07000000000",
        "Email": "it@dmnlogistics.co.uk"
    }
]

GET: /moves/account/:account_code/job/:job_number

Get Movement Status

Retrieves current status of movement:

Example Response


{
    "JobNumber": 123456,
    "CustOrderNum": "Order01",
    "Reg": "AB12CDE",
    "DueDate": "2020-12-31",
    "ColDate": "2020-12-31",
    "DelDate": "2020-12-31",
    "Progress": "OUTSTANDING",
    "POCName": null,
    "POCDate": null,
    "POCTime": null,
    "POCMileage": "0",
    "PODName": null,
    "PODDate": null,
    "PODTime": null,
    "PODMiles": "0",
    "update_type": "general"
}

POST: /moves/account/:account_code/job

Book Movement

Book new Momvement:

Example Payload


{ "job": {
    "CustOrderNum": "ORDER01",
    "Reg": "AB01CDE",
    "DueDate": "01/01/2019",
    "DelType": "DelOn",
    "ColDate": "01/02/2019",
    "ColTime": "AM",
    "ColContact": "John Doe",
    "ColTel": "0123456789",
    "ColMobileNumber": "07123456789",
    "ColEmailAdd": "JohnD@example.com",
    "CollAdd1": "My Business",
    "CollAdd2": "My Road",
    "CollAdd3": "My District",
    "CollTown": "My County",
    "CollPCode": "A1 2BC",
    "DelDate": "01/05/2019",
    "DelContact": "John Smith ",
    "DelTel": "0123456789",
    "DelMobileNumber": 07123456789,
    "DelEmailAdd": "JohnS@example.co.uk",
    "DelAdd1": "2 Some Street",
    "DelAdd2": "Nice Place",
    "DelAdd3": "",
    "DelTown": "Nice City",
    "DelPCode": "B2 1CD",
    "SpecialInstructions": "Please Wash Before Delivery"
    }
}

Example Response


{
"JobNumber":177718,
"CustOrderNum":"168365",
"Reg":"AB12CDE",
"DueDate":"2016-04-18",
"ColDate":"2016-06-24",
"DelDate":"2016-06-27",
"Progress":"PICKED UP",
"POCName":null,
"POCDate":null,
"POCTime":null,
"POCMileage":null,
"PODName":null,
"PODDate":null,
"PODTime":null,
"PODMiles":"0",
"ColETA":null,
"DelETA":null
}

GET: /moves/account/:account_code/job/:job_number/:type.format

Get POC/POD Signature

Retrieves POC / POD signature for jobs that have been colected or delivered.

can specify either json or png format.

Example JSON Response


{
    "JobNumber": 123456,
    "CustOrderNum": "",
    "Reg": "AB12CDE",
    "col_signature": "data:image/png;base64,....."
}

GET: /moves/account/:account_code

List Movements

List of movements booked against an account.

Example JSON Response

 
 [
	{
	     	"JobNumber": 123456,
     		"CustOrderNum": "REF01",
     		"Reg": "AB12CDE"
 	},
	{
	     	"JobNumber": 123457,
     		"CustOrderNum": "REF02",
     		"Reg": "AB12CDF"
	}
]

GET: /moves/account/:account_code/job/:job_number/images

List Images from Move

List of images stored against a job.

Example JSON Response

 
 [
	{
	     	"HashFileName": "2827393847281732.jpg",
		"Description": "Photo of front of vehicle"
 	},
	{
	     	"HashFileName": "2827393847281733.jpg",
		"Description": "Photo of rear of vehicle"
	}
]

GET: /moves/account/:account_code/image/:image_id?mode=:mode

Download Image

Fetches an image from a job using the hash file name from the list images function. By default the image is displayed inline, however the mode parameter can be used with a value of download and the API will send the file as a file download instead.