Jump to

• Request
• Response

Retrieve an Element's Code List

get

/ic/api/b2b/v1/schemas/{schemaId}/{elementId}/codes

Retrieves the code list of an element using the element ID.

Request

Path Parameters

• elementId(required): string

  Element ID.

  Example:

  /b2b/v1/schemas/SCH2/92/codes

• schemaId(required): string
  B2B schema ID.

Query Parameters

• standardId(required): string
  Document standard ID.
• transactionId(required): string
  Document transaction ID.
• versionId(required): string
  Document version ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : CodeUI

Type: object

Show Source

• c: string
• d: string
• n: string
• r: boolean

{
    "type":"object",
    "properties":{
        "c":{
            "type":"string"
        },
        "d":{
            "type":"string"
        },
        "n":{
            "type":"string"
        },
        "r":{
            "type":"boolean"
        }
    }
}

400 Response

Bad request

500 Response

Server error

Back to Top