Jump to

• Request
• Response
• Examples

Get code details for a specific code name

get

/PASService/rest/services/codes

Gets a list of code details based on the specific code name

Request

Query Parameters

• codeName(optional): string
  Code Name
• codeValue(optional): string
• q(optional): string

Back to Top

Response

Supported Media Types

• application/json

Default Response

successful operation

Back to Top

Examples

This example describes how to get a list of code details based on the specific code name.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -X GET -H "Accept: application/json" -u username:password "server:port/PASService/rest/services/codes"

Example Response Body

The following shows an example of the response body in JSON format:

"{
    "count": 100,
    "offset": 0,
    "limit": 100,
    "codes": [
        {
            "codeName": "ASCODEENTITYTYPE",
            "codeValue": "CLIENT",
            "longDescription": "Client",
            "shortDescription": "Client"
        },
        {
            "codeName": "ASCODEENTITYTYPE",
            "codeValue": "GROUPCUST",
            "longDescription": "GroupCustomer",
            "shortDescription": "GroupCustomer"
        }
"

Back to Top