Create a Timeline

Developing

Testing Env

https://demo.modaltrans.com

POST

/api/v1/timelines

Creates a Timeline.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

parent_type

string

required

Type of the parent object to which the timeline is related.

uuid

string

required

The UUID of the parent object.(Vehicle,Booking e.g.)

timeline

object

required

Timeline Attributes

status_date

string <date-time>

required

The date and time when the status was updated.

status_code

string

optional

Activity code

place_id

integer

optional

ID of the location you want to add to the timeline.

place_name

string

optional

Name of the location you want to add to the timeline.

source

string

optional

Source of the timeline

Examples:

apiuser

notes

string

optional

Additional notes or comments related to the timeline.

customer_inform_type

boolean

optional

Indicates if the customer wants to informed or not.

Example

{
    "parent_type": "Fleet::Vehicles",
    "uuid": "33a6e5bd-fad6-4f42-8f89-c77e2a8d3b1b",
    "timeline": {
        "status_date": "2024-08-07",
        "status_code": "Cleared and Released",
        "place_id": 64699,
        "place_name": "London, United Kingdom",
        "notes": "TestApi",
        "customer_inform_type": false,
        "source": "api"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://demo.modaltrans.com/api/v1/timelines' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parent_type": "Fleet::Vehicles",
    "uuid": "33a6e5bd-fad6-4f42-8f89-c77e2a8d3b1b",
    "timeline": {
        "status_date": "2024-08-07",
        "status_code": "Cleared and Released",
        "place_id": 64699,
        "place_name": "London, United Kingdom",
        "notes": "TestApi",
        "customer_inform_type": false,
        "source": "api"
    }
}'

Responses

🟢201Created

application/json

Body

integer

required

ID of the timeline.

status_date

string <date-time>

required

Timestamp of the activity.

status_code

string

required

Activity code

notes

string

required

Notes

source

string

required

Source of the created timeline.

country_id

string

required

ID of the country

Examples:

GBCN

lng

number

required

Longitude

lat

number

required

Latitude

Example

{
    "id": 0,
    "status_date": "2019-08-24T14:15:22Z",
    "status_code": "string",
    "notes": "string",
    "source": "string",
    "country_id": "GB",
    "lng": 0,
    "lat": 0
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠422Unprocessable Entity

Modified at 2024-08-23 14:33:10

List Timelines

List all S3Files