API docs by Redocly

Assignment Gateway Public API (3.0.0)

Download OpenAPI specification:

Definitions for Assignment Gateway Public API

OpenID Configuration

Endpoint for discovering all OpenId Connect endpoints

Responses

Response samples

Content type
application/json
{
  • "issuer": "string",
  • "token_endpoint": "string",
  • "jwks_uri": "string",
  • "scopes_supported": [
    ],
  • "response_types_supported": [
    ],
  • "subject_types_supported": [
    ],
  • "id_token_signing_alg_values_supported": [
    ]
}

Retrieve Token

Endpoint for exchanging credentials for tokens (access token and ID token)

Authorizations:
basicAuth
Request Body schema: application/x-www-form-urlencoded
required
grant_type
string
scope
string

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 0,
  • "scope": "string",
  • "id_token": "string"
}

JWKS

Endpoint for fetching JSON Web Key Set (JWKS) to verify the retrieved tokens

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

postAssignmentAttempt

Post an assignment attempt to sign on / sign off a vehicle.

Authorizations:
bearerAuth
header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Request Body schema: application/json
required

Assignment attempt request

vehicleId
string

Required unique vehicle id 17 characters.

object (AssignmentAttemptRequestSignOn)

Attempt to sign the vehicle on to a specified vehicle task or one or more journey(s).

object (AssignmentAttemptRequestSignOff)

Request to sign the vehicle out from assigned journey. The result is effective immediately. It signals that the vehicle will no longer service journey.

Responses

Request samples

Content type
application/json
{
  • "vehicleId": "string",
  • "signOn": {
    },
  • "signOff": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "vehicleState": {
    }
}

getAssignmentVehicleState

Look up a vehicle's (assignment) state.

Authorizations:
bearerAuth
path Parameters
vehicleId
required
string

Unique vehicle identifier

query Parameters
includeCalls
boolean

Flag indicating if returned journeys should include call data or not (default: false).

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "vehicleState": {
    }
}

findJourneys

Find journeys for a given set of search criteria.

Authorizations:
bearerAuth
query Parameters
query
string

General-purpose search parameter that can accept various identifiers like vehicle journey ID (e.g., "86"), journey references, or pattern references to return matching journeys with their associated details including external IDs and pattern references.

stopPoint
string

Filters journeys by stop point identifier. Accepts various stop point identifiers such as NSR:Quay IDs (e.g., "NSR:Quay:109233") and returns journeys that serve the specified stop point, including details like stop name (e.g., "Nationaltheatret"), public code, and related stop area references.

vehicleTask
string

Filters journeys by vehicle task identifier. Accepts a numeric vehicle task ID (e.g., "1702") to return journeys associated with the specified vehicle task.

line
string

Filters journeys by line identifier. Accepts a line number or code (e.g., "70") and returns journeys operating on that line, including details like line reference ("RUT:Line:70"), public code, and transport mode information.

lat
string

Specifies the latitude coordinate for location-based journey queries. Used in combination with the 'lon' parameter to find journeys near a specific geographic location.

lon
string

Specifies the longitude coordinate for location-based journey queries. Used in combination with the 'lat' parameter to find journeys near a specific geographic location.

direction
string (JourneyDirectionCode)
Example: direction=ANY # Any direction.&direction=NONE # No direction (dead-run journeys).&direction=INBOUND # Inbound to city center.&direction=OUTBOUND # Outbound from city center.

Line direction code, indicating direction of line relative to city center.

fromDateTime
string

First arrival / departure date in ISO 8601 date-time format with time-zone offset. If not set, search result may be limited to current day.

toDateTime
string

Last arrival / departure date in ISO 8601 date-time format with time-zone offset. If not set, search result may be limited to current day.

includeCalls
boolean

Flag indicating if returned journeys should include call data or not (default: false).

limit
integer

Maximum number of items to return in response.

offset
integer

Item offset for returned response.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "items": [
    ],
  • "page": {
    }
}

findLines

Return list of unique lines matching search criteria.

Authorizations:
bearerAuth
query Parameters
query
string

Lines search query string.

limit
integer

Maximum number of items to return in response.

offset
integer

Item offset for returned response.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "items": [
    ],
  • "page": {
    }
}

findStopPoints

Return list of unique stop points matching search criteria.

Authorizations:
bearerAuth
query Parameters
query
string

Stop point search query string.

limit
integer

Maximum number of items to return in response.

offset
integer

Item offset for returned response.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "items": [
    ],
  • "page": {
    }
}

findServiceDeviations

Return a list of service deviations matching a given set of criteria.

Authorizations:
bearerAuth
query Parameters
fromDateTime
string

Optional dateTime to filter out deviations before this point in time. ISO-8601 format, including time-zone offset (format: YYYY-MM-DD_T_hh:mm:ssZ)

toDateTime
string

Optional dateTime to filter out deviations after this point in time. ISO-8601 format, including time-zone offset (format: YYYY-MM-DD_T_hh:mm:ssZ)

limit
integer

Maximum number of items to return in response.

offset
integer

Item offset for returned response.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "items": [
    ],
  • "page": {
    }
}

postServiceDeviation

Post a service deviation registration request

Authorizations:
bearerAuth
header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Request Body schema: application/json
required

Service deviation registration request

object (ServiceDeviationSpec)
action
string (PostRequestType)

Post Request Type

comment
string

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "action": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "deviation": {
    }
}

getServiceDeviation

Return a service deviation with a given id.

Authorizations:
bearerAuth
path Parameters
serviceDeviationId
required
string

Unique identifier of service deviation.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "deviation": {
    }
}

updateServiceDeviation

Update a service deviation with a given id.

Authorizations:
bearerAuth
path Parameters
serviceDeviationId
required
string

Unique identifier of service deviation.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Request Body schema: application/json
required

Service deviation update request

object (ServiceDeviationSpec)
action
string (PostRequestType)

Post Request Type

comment
string

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "action": [
    ],
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "deviation": {
    }
}

getServiceDeviationReasonCodes

Return a list of service deviation reason codes

Authorizations:
bearerAuth
query Parameters
serviceDeviationCode
string (ServiceDeviationCode)
Example: serviceDeviationCode=DELAY # Service will be delayed.&serviceDeviationCode=NO_SERVICE # Journey(s), line(s) or call(s) will not be serviced by operator.&serviceDeviationCode=NO_SIGN_ON # Planned journey(s), line(s) or call(s) will be serviced, but operator will not sign on.

Service deviation code, indicating type of service deviation.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "groups": [
    ],
  • "reasons": [
    ]
}

findServiceMitigations

Return a list of service mitigations matching a given set of criteria.

Authorizations:
bearerAuth
query Parameters
fromDateTime
string

Optional dateTime to filter out deviations before this point in time. ISO-8601 format, including time-zone offset (format: YYYY-MM-DD_T_hh:mm:ssZ)

toDateTime
string

Optional dateTime to filter out deviations after this point in time. ISO-8601 format, including time-zone offset (format: YYYY-MM-DD_T_hh:mm:ssZ)

limit
integer

Maximum number of items to return in response.

offset
integer

Item offset for returned response.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "items": [
    ],
  • "page": {
    }
}

postServiceMitigation

Post a service mitigation registration request

Authorizations:
bearerAuth
header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Request Body schema: application/json
required

Service mitigation registration request

object (ServiceMitigationSpec)
action
string (PostRequestType)

Post Request Type

draft
boolean
comment
string

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "action": [
    ],
  • "draft": true,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "mitigation": {
    }
}

getServiceMitigation

Return a service mitigation with a given id.

Authorizations:
bearerAuth
path Parameters
serviceMitigationId
required
string

Unique identifier of service mitigation.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "mitigation": {
    }
}

updateServiceMitigation

Update a service mitigation with a given id.

Authorizations:
bearerAuth
path Parameters
serviceMitigationId
required
string

Unique identifier of service mitigation.

header Parameters
X-ADT-Auth
string

Internal authentication metadata used by system implementation. Any value set here by a client will be ignored.

X-Trace-Id
string

Optional trace id for request. May be used to trace multiple requests as part of the same "operation" or "process". If set, should be different from X-Request-Id header.

X-Request-Id
string

Optional request id for request. Request id provided by client should be unique per request. For identifying multiple requests as belonging to the same group of requests when doing retries, parallel request processing or similar, see X-Trace-Id header.

X-Operator-Id
string

Optional operator id for request. Required by clients with access to more than one PTO. Operator id on the form 'CodeSpace:Operator:number' Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

X-Authority-Id
string

Optional authority id for request. Required by clients with access to more than one PTA. Ref: https://enturas.atlassian.net/wiki/spaces/PUBLIC/pages/637370434/List+of+current+Codespaces

Request Body schema: application/json
required

Service mitigation update request

object (ServiceMitigationSpec)
action
string (PostRequestType)

Post Request Type

draft
boolean
comment
string

Responses

Request samples

Content type
application/json
{
  • "spec": {
    },
  • "action": [
    ],
  • "draft": true,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "mitigation": {
    }
}