Support

Create a support case

POST

https://api.entur.io/shared-mobility/v1

/support

Create a support case base on the given supportRequest. The operatorId is used to identify the correct receiving operator.

Create a support case › Headers

Entur-Distribution-Channel

string · required · style: simple

Operator-Id

string · required · style: simple

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

Create a support case › Request Body

SupportRequest

supportType

string · enum · required

Enum values:

BROKEN_DOWN

NOT_AT_LOCATION

MISSING_AFTER_PAUSE

NOT_CLEAN

NOT_AVAILABLE

UNABLE_TO_OPEN

UNABLE_TO_CLOSE

API_TECHNICAL

ContactInformation · required

bookingId

string | null · uuid

assetId

string | null

comment

string | null

stationId

string | null

Create a support case › Responses

SupportStatus

status

string | null

timeToResolution

integer | null · int32

POST/support

curl https://api.entur.io/shared-mobility/v1/support \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Distribution-Channel: <string>' \
  --header 'Operator-Id: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bookingId": "00000000-0000-0000-0000-000000000000",
  "assetId": "assetId",
  "supportType": "BROKEN_DOWN",
  "contactInformationEndUser": {
    "email": "email",
    "phone": "phone"
  },
  "comment": "comment",
  "place": {
    "coordinates": {
      "longitude": 0,
      "latitude": 0,
      "altitude": 0
    },
    "name": "name"
  },
  "stationId": "stationId"
}'

Example Request Body

{
  "bookingId": "00000000-0000-0000-0000-000000000000",
  "assetId": "assetId",
  "supportType": "BROKEN_DOWN",
  "contactInformationEndUser": {
    "email": "email",
    "phone": "phone"
  },
  "comment": "comment",
  "place": {
    "coordinates": {
      "longitude": 0,
      "latitude": 0,
      "altitude": 0
    },
    "name": "name"
  },
  "stationId": "stationId"
}

json

Example Responses

{
  "status": "status",
  "timeToResolution": 0
}

json

application/problem+json

QR Code SharedMobilityInternal

Did you find what you were looking for?

Create a support case

POST

https://api.entur.io/shared-mobility/v1

/support

Create a support case base on the given supportRequest. The operatorId is used to identify the correct receiving operator.

Create a support case › Headers

Entur-Distribution-Channel

string · required · style: simple

Operator-Id

string · required · style: simple

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accept-Language

string · style: simple

Create a support case › Request Body

SupportRequest

supportType

string · enum · required

Enum values:

BROKEN_DOWN

NOT_AT_LOCATION

MISSING_AFTER_PAUSE

NOT_CLEAN

NOT_AVAILABLE

UNABLE_TO_OPEN

UNABLE_TO_CLOSE

API_TECHNICAL

ContactInformation · required

bookingId

string | null · uuid

assetId

string | null

comment

string | null

stationId

string | null

Create a support case › Responses

SupportStatus

status

string | null

timeToResolution

integer | null · int32

Support

Create a support case

Create a support case › Headers

Create a support case › Request Body

Create a support case › Responses

Build with Entur

Contribute

Terms & Policies

Support

Create a support case

Create a support case › Headers

Create a support case › Request Body

Create a support case › Responses