production
development
https://emea.sit.api.citi.com/gcb
Custom Gateway API Endpoint
Paths
/v1/emea/utilities/referenceData/{referenceCode}
get /v1/emea/utilities/referenceData/{referenceCode}
AnalyticsAndInformationManagement
Retrieve all the possible values for CVT
This API provides all possible values for list of values/set of permissible values to be used by other data fields. Developer can use same to map screen LOV fields to all fields defined in API's. In field description Indexes are defined for same.
To use this operation you must use one of the following sets of security requirements.
API Key
X-IBM-Client-Id
(apiKey located in header)
pv52735
API Key(Query)
client_id
(apiKey located in query)
referenceCode
Required in path
string
Reference Code
Authorization
Required in header
string
Access token to authenticate your request.
countryCode
Required in header
string
Country code in 2 character ISO 3166 format.
uuid
Required in header
string
128 bit random UUID generated uniquely for every request.
Accept
Required in header
string
Content-Type that are acceptable for the response.
client_id
Required in header
string
Client ID generated during application registration.
clientDetails
Optional in header
string
Device and browser information. Refer the developer portal for more information. Please ensure the header is base64 encoded
200
Successful operation.
400
| Type | Code | Details |
| invalid | invalidRequest | Missing or invalid parameters |
401
| error | unAuthorized | Authorization credentials are missing or invalid |
403
| error | accessNotConfigured | The requested operation is not configured to access this resource. | Channel/Country/Business provided in the request is not supported currently |
404
| error | resourceNotFound | Empty resource/resource not found |
500
| fatal | serverUnavailable | The request failed due to an internal error |
Example Request
Example Response
GET https://emea.sit.api.citi.com/gcb/api/v1/emea/utilities/referenceData/{referenceCode}
Definitions
{
"properties": {
"referenceDataCode": {
"description": "Reference data code associated with CVT",
"type": "string",
"example": "title"
},
"referenceDataValue": {
"description": "Reference data Value associated with CVT",
"type": "string",
"example": "MR"
},
"referenceDataShortDescription": {
"description": "Reference data Short description associated with CVT",
"type": "string",
"example": "MR"
},
"referenceDataLongDescription": {
"description": "Reference data long description associated with CVT",
"type": "string",
"example": "MISTER"
},
"status": {
"description": "Reference data status",
"type": "string",
"example": "active"
}
}
}
{
"properties": {
"referenceDataDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/ReferenceData"
}
}
}
}
{
"properties": {
"type": {
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
],
"type": "string"
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "object"
}
},
"required": [
"type",
"code"
]
}