Versions Compared

Old Version 11

changes.mady.by.user Svein Are Grønsund (Deactivated)

Saved on

compared with

New Version 12

changes.mady.by.user Svein Are Grønsund (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For each session, first get authenticated with /auth/generate/, then use the received token in the header for all the other calls. Like this:

Code Block
curl https://dev-planandgo.di.no/pl/api/v-1/routePlan 
-H "Content-Type:application/json" 
-H "X-API-Token:olof:5f9a3609a5a295eff861d930a0c75bbee7991842" 
-d "{
    \"companyId\": 1,
    \"date\": '2015-12-04T00:00:00.000+0100',
    \"name\": \"Kolonihagen uke 9\"
}"

Environments

  • DEV: https://dev-planandgo.di.no
  • STAGING: https://staging-planandgo.di.no
  • PROD: https://planandgo.di.no

API-methods

# MethodURLDescriptionExample - RequestExample - Response
1

🔓

POST/auth/generate

Fetches an login-token that the application can use to gain access to the API.

Get the username/password from DI.

Code Block
{
    "username": "olof",
    "password": "secret123"
}
Code Block
{
	"token": "olof:5f9...842",
	"userId": 23432,
	"customerSystemId": 233,
	"roles: [...]
}
2

🔒

POST/routePlan

Create an empty route plan (for a given distribution date).

Create a route plan for each area (each plan has a given start-point).

Code Block
{
    companyId: 1,
    date: '2015-12-04T00:00:00.000+0100',
    name: 'Kolonihagen uke 9'
}
Code Block
{
	id: 344,
	date: '2015-12-04T00:00:00.000+0100',
	name: 'Kolonihagen uke 9',
	...
}
3🔒POST/routePlan/<rp_id>/customerSystem/<cs_id>

Create an empty file (prepare for a file-upload).

Step 1 in file upload.

Code Block
{
    name: 'my-file-name.csv'
}
Code Block
{
	id: 6722,
	name: 'my-file-name.csv',
	...
}
4🔒POST/file/<f_id>

Upload the content of the file you have prepared.

Filetypes supported:

  • .csv
  • .xls
  • .xlsx

Mimetype: multipart/form-data

Name the file-field: "file".

See file specification.

Step 2 in file upload.

 
Code Block
{
	status: 'ok'
}
5🔒GET/customerSystem/<cs_id>/publishedOrders/<yyyy-mm-dd>

Fetch the published orders including the routename of each order.

This will return orders across many routePlans, but only from published plans for the given distribution-date.

(info) Assumes that imported customers/deliveries used the ORDER_ID field.

 

 

List of orders

Code Block
[
	{
		orderId: '12452',
		routeName: 'Asker'
	},
	{
		orderId: '12454',
		routeName: 'Asker'
	},
	...
	{
		orderId: '29452',
		routeName: 'Skøyen'
	},
	...
]

...