Retrieve an operator case

curl --request GET \
  --url https://api.example.com/v1/src/operator/cases/{leg}/{caseId} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/src/operator/cases/{leg}/{caseId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/src/operator/cases/{leg}/{caseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/src/operator/cases/{leg}/{caseId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "caseId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "closable": true,
  "consultationId": "<string>",
  "leg": "orphan_response",
  "openedAt": "2023-11-07T05:31:56Z",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "resolvedBy": "<string>",
  "status": "closed",
  "summary": {
    "attempts": 5,
    "budgetExhaustedAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "kind": "rotation",
    "mqMessageId": "414d5120514d31202020202020202020a1b2c3d4e5f60718",
    "mqPutAt": "2023-11-07T05:31:56Z",
    "nuopClaimed": "<string>",
    "receivedAt": "2023-11-07T05:31:56Z",
    "requestedBy": "<string>"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

GET

src

operator

cases

{leg}

{caseId}

Retrieve an operator case

curl --request GET \
  --url https://api.example.com/v1/src/operator/cases/{leg}/{caseId} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/src/operator/cases/{leg}/{caseId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/src/operator/cases/{leg}/{caseId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/src/operator/cases/{leg}/{caseId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "caseId": "8f14e45f-ceea-467a-9a36-dedd4bea2543",
  "closable": true,
  "consultationId": "<string>",
  "leg": "orphan_response",
  "openedAt": "2023-11-07T05:31:56Z",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "resolvedBy": "<string>",
  "status": "closed",
  "summary": {
    "attempts": 5,
    "budgetExhaustedAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "kind": "rotation",
    "mqMessageId": "414d5120514d31202020202020202020a1b2c3d4e5f60718",
    "mqPutAt": "2023-11-07T05:31:56Z",
    "nuopClaimed": "<string>",
    "receivedAt": "2023-11-07T05:31:56Z",
    "requestedBy": "<string>"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

{
  "correlationId": "req-7a3f9c2e",
  "detail": "check digits are invalid for the declared documentType",
  "instance": "/v1/src/consultations",
  "status": 400,
  "title": "Bad Request",
  "traceId": "a1b2c3d4",
  "type": "<string>",
  "violations": [
    {
      "field": "document",
      "reason": "check digits are invalid for the declared documentType",
      "code": "<string>"
    }
  ],
  "code": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Request-ID

string

Optional correlation id (UUID) propagated through logs/traces.

Path Parameters

leg

string

required

Which backlog the case belongs to: budget_exhausted | orphan_response | invalid_outbound | credential_operation. An unknown value returns 422 SRC-0002.

Example:

"orphan_response"

caseId

string

required

The case identifier. An identifier that is unknown or malformed returns 404 SRC-0301.

Example:

"8f14e45f-ceea-467a-9a36-dedd4bea2543"

Response

caseId

string

required

The case identifier. It is unique only together with leg, so each closure route names its leg in the path.

Example:

"8f14e45f-ceea-467a-9a36-dedd4bea2543"

closable

boolean

required

Whether an operator can close this case. It is false for budget_exhausted.

consultationId

string | null

required

The consultation this case belongs to; null when the case belongs to none — which is what an orphan_response and a credential_operation each are. Follow it with GET /v1/src/consultations/{id}.

leg

string

required

Which leg of the backlog this case is: budget_exhausted | orphan_response | invalid_outbound | credential_operation. Closure route per leg: orphan_response -> POST /v1/src/operator/orphan-responses/{caseId}/closure; invalid_outbound -> POST /v1/src/operator/invalid-dispatches/{caseId}/closure; credential_operation -> POST /v1/src/operator/credential-operations/{caseId}/closure; budget_exhausted -> none, see closable.

Example:

"orphan_response"

openedAt

string<date-time>

required

When the case opened (UTC). The listing is ordered and paged on this value, newest first.

resolvedAt

string<date-time> | null

required

When the case left the queue (UTC); null while it is open.

resolvedBy

string | null

required

The operator who closed the case; null when no person did — an unclaimed inbound resolved as matched was closed by the correlation, and an open case has nobody to name.

status

string

required

Whether this case is still in the queue: open | closed. It is not the same as closable, which says whether the leg accepts a closure.

Example:

"closed"

summary

object

required

The detail this leg publishes. It is a UNION: each leg fills its own members and omits the rest.

Show child attributes

Consultations

Institution records

Evidence

Dashboard

Credentials

Operator cases

Error handling

Retrieve an operator case

Authorizations

Headers

Path Parameters

Response