Hand a case to a kiosk for a participant

POST

/cases/{caseId}/participants/{participantId}/open

curl --request POST \
  --url https://api-sandbox.trustink.io/cases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/participants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/open \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deviceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• Sandbox
• Production

Publishes device.open_case with the participant’s signing link to the device’s real-time channel (Real-time events).

Authorizations

• tenantIdToken

Parameters

Path Parameters

caseId

required

The case id POST /cases answered.

string format: uuid

participantId

required

The participant id: the path of the signing link, or participants[].id of the case.

string format: uuid

Request Body^required

Media typeapplication/json

object

deviceId

required

string format: uuid

Example^generated

{
  "deviceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

202

The event is published.

Media typeapplication/json

object

caseId

required

string

participantId

required

string

deviceId

required

string

Example^generated

{
  "caseId": "example",
  "participantId": "example",
  "deviceId": "example"
}

400

The request failed validation, or the device is not the tenant’s (code UNKNOWN_DEVICE).

Media typeapplication/json

Any of:

object

object

message

required

string

validationErrors

required

Array<object>

object

instancePath

required

string

keyword

required

string

params

required

object

key

additional properties

message

required

string

object

object

code

string

message

required

string

Example^generated

{
  "message": "example",
  "validationErrors": [
    {
      "instancePath": "example",
      "keyword": "example",
      "params": {
        "additionalProperty": "example"
      },
      "message": "example"
    }
  ]
}

401

No or an invalid Cognito ID token (API Gateway answers {message} only).

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

The tenant has no such case, or the case no such participant.

Media typetext/plain

string

Example

Case not found

409

The participant cannot sign on a device now. code: ALREADY_SIGNED, NOT_QUICK_SIGN, PARTICIPANT_NOT_READY.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

410

Nobody can sign the case any more. code: CASE_NOT_ACTIVE.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

503

The event could not be published; try again. code: EVENTS_UNAVAILABLE.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

default

Something failed on the platform, or the request timed out (code TIMEOUT, 503); try again.

Media typeapplication/json

object

code

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}