Skip to content

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

Download OpenAPI description
planning-status.json
planning-status.yaml
Overview
Languages
Servers
Mock server
https://developer.simacan.com/_mock/openapi/planning/planning-status/
Production Environment
https://planning-status-api.services.simacan.com/api/public/v3/
Staging Environment
https://planning-status-api-stg.services.simacan.com/api/public/v3/

Get By PlanningId

Request

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

Security
BearerAuth
Path
planningUUIDstringrequired

The unique identifier of the planning itself

curl -i -X GET \
  'https://developer.simacan.com/_mock/openapi/planning/planning-status/get_by_planning_id/{planningUUID}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Bodyapplication/json
idstring(uuid)

This is the Simacan generated universally unique identifier

Example: "39e8d454-87b4-427d-a4f3-c50ed2677644"
namestring

The name of the planning

Example: "peterson/2020-09-02T12:26:47.585271Z.json"
planningCreationTimestring(date-time)

The creation time of the planning

Example: "2020-09-02T12:26:47.705Z"
shipperstring

The shipper to which the planning belongs

Example: "peterson"
triggerTypestring

Defines how the job should be triggered

Example: "Automatic"
statusstring

Defines current status of the job

Enum"ShouldStart""Running""Succeeded""Failed"
Example: "ShouldStart"
fileobject
tagsobject
stepsArray of objects(step)
Response
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": {
    "fileName": "peterson/2020-09-02T12:26:47.585271Z.json",
    "directory": "simacan-planning-data"
  },
  "tags": {
    "mimeType": "application/json",
    "version": "1",
    "schema": "json",
    "source": "planning-receive-api"
  },
  "steps": [
    { … }
  ]
}