Skip to content

NP6 API Reference (8.1.0)

This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.

If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.

Languages
Servers
Production server
https://api-cm.np6.com
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Retrieve all value listsDeprecated

Request

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X GET \
  https://api-cm.np6.com/valueLists \
  -H 'X-Key: string'

Responses

The value list

Bodyapplication/jsonArray [
idinteger(int32)

The value list's id

namestring

The value list's name

orderedboolean or null

If true, values will be shown in alphabetical order instead of order of creation

valuesArray of objects

The values of the value list

indexinteger(int32)

The value's id

valuestring

The value

]
Response
application/json
[ { "id": 23, "name": "Pastimes", "ordered": false, "values": [ { "index": 1, "value": "Football" }, { "index": 2, "value": "Tennis" }, { "index": 3, "value": "Golf" } ] }, { "id": 24, "name": "Civility", "ordered": false, "values": [ { "index": 1, "value": "Mr" }, { "index": 2, "value": "Ms" }, { "index": 3, "value": "Mrs" } ] } ]

Request

Note: values of the value list are not case sensitive

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

Data used to create the value list

idinteger(int32)

The value list's id

namestring

The value list's name

orderedboolean or null

If true, values will be shown in alphabetical order instead of order of creation

valuesArray of objects

The values of the value list

indexinteger(int32)

The value's id

valuestring

The value

curl -i -X POST \
  https://api-cm.np6.com/valueLists \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "name": "Level",
    "ordered": false,
    "values": [
      {
        "index": 1,
        "value": "Beginner"
      },
      {
        "index": 2,
        "value": "Intermediate"
      },
      {
        "index": 3,
        "value": "Advanced"
      }
    ]
  }'

Responses

The created value list

Bodyapplication/json
idinteger(int32)

The value list's id

namestring

The value list's name

orderedboolean or null

If true, values will be shown in alphabetical order instead of order of creation

valuesArray of objects

The values of the value list

indexinteger(int32)

The value's id

valuestring

The value

Response
application/json
{ "id": 25, "name": "Level", "ordered": false, "values": [ { "index": 1, "value": "Beginner" }, { "index": 2, "value": "Intermediate" }, { "index": 3, "value": "Experienced" } ] }

Request

Path
idinteger(int32)required

The value list's id

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X GET \
  'https://api-cm.np6.com/valueLists/{id}' \
  -H 'X-Key: string'

Responses

The value list

Bodyapplication/json
idinteger(int32)

The value list's id

namestring

The value list's name

orderedboolean or null

If true, values will be shown in alphabetical order instead of order of creation

valuesArray of objects

The values of the value list

indexinteger(int32)

The value's id

valuestring

The value

Response
application/json
{ "id": 23, "name": "Pastimes", "ordered": false, "values": [ { "index": 1, "value": "Football" }, { "index": 2, "value": "Tennis" }, { "index": 3, "value": "Golf" } ] }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations