For more information on configuration options for the Transportation API please visit our API reference

​
Create BSL Train Announcement Request

Use this API endpoint to make a BSL Train Announcement request.

curl --location 'https://sign.client.api.stag.signapsesolutions.com
/v1/sign-requests/train-announcements' \

--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
    "destination": "HOB",
    "timing": "1210",
    "platform": "1",
    "operator": "SE"
    "updatedTiming": "",
    "updatedPlatform": "",
    "shortDelay": false,
    "busReplacement": false,
    "cancelled": false,
    "noPlatform": false,
    "callingAt": "POO,BMH,WAT",
		"notCallingAt": "",
    "currentStation": ""
    "bgColour": "18,195,83",
    "metaData": {
        "messageId": "messageId here - record of the request id of the client system",
        "tenantId": "tenantId here - client which system",
        "userRequestingId": "userRequestingId here - person who made the request",
        "requestTime": "requestTime here - request time from the client side"
    }
}'

This endpoint will return the below response with 200 status code.

{
    "data": {
        "id": "c4c7ac45-79c2-48b2-99ff-61775e2d3d3e"
    }
}

id here is the request/job/submission id. Use this id to get the status of the request and link for the result output file.

NOTE: There is a request limit of 1,500 requests per 5 minutes on both Staging and Production.