Planning Status API (3.0)

The Planning Status Service keeps track of various planning status results for processing trip data and provides endpoints to easily retrieve which planning imports succeeded and which failed, when and how.

Make sure you request the Auth API first

Get By PlanningId

Get all planning updates for the planning with the provided id (UUID)

SecurityBearerAuth
Request
path Parameters
planningUUID
required
string

The unique identifier of the planning itself

Responses
200

The planning import attempt with all intermediate steps for the given ID

401

Unauthorized: Whenever you will get this status, you have either provided the wrong credentials or none at all. Check if you bearer token has not expired.

403

Forbidden: You will receive this status, when you successfully supplied credentials, but your username does not have the necessary permissions for the resource.

404

Not Found: Whenever you will get a 404, you are probably using a malformed or incorrect URL.

get/get_by_planning_id/{planningUUID}
Request samples
import requests

planning_uuid = "YOUR_planningUUID_PARAMETER"
url = "https://planning-status-api.services.simacan.com/api/public/v3/get_by_planning_id/" + planning_uuid

headers = {"Authorization": "Bearer <YOUR_JWT_HERE>"}

response = requests.get(url, headers=headers)

data = response.json()
print(data)
Response samples
application/json
{
  • "id": "39e8d454-87b4-427d-a4f3-c50ed2677644",
  • "name": "peterson/2020-09-02T12:26:47.585271Z.json",
  • "planningCreationTime": "2020-09-02T12:26:47.705Z",
  • "shipper": "peterson",
  • "triggerType": "Automatic",
  • "status": "ShouldStart",
  • "file": {
    },
  • "tags": {
    },
  • "steps": [
    ]
}