View Code

Retrieves information about an individual Code within a Code Set or Code bank.

This method can be used for Code Validation by websites, such as to see if the Code has Expired, already been Redeemed etc.

Path Params
string
required

The name of the space (database) assigned to you.

string
required

Can be the id, bizId or name of either the codeset or the codebank

string
required

The unique code

Query Params
boolean
Defaults to false

If trues, will include information about every redepmtion

string

The Dimensions under which the calling application operates.
Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

boolean

If true, returns resources even if the Entity's Dimension filter doesn't match the passed in Dimensions.
Default is false.

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json