Get PIN List

Retrieve the details of PIN list for a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/pin-lists/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the PIN list to retrieve.
Note: You can obtain the ID using the Search PIN Lists interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<PIN_List> The PIN list data.
PIN_List
Parameter Type Description
id String The unique identifier of the PIN list.
name String The name of the PIN list.
pinNumbers Array<String> The PIN codes in the list.
version Integer The version number of the PIN list, incremented with each update to prevent outdated data from overwriting new data.

Example

Request example

GET /uc-cconfig/api/v1/pin-lists/362831376296775680 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDU5NzA5OCwiaWF0IjoxNzkwNTc1NDk4LCJqdGkiOiIyZGM5OTY4Ny1iZWUyLTRkMmItOWY5OS02MDNmYjZhODg5ZGMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.CFc6755Jof68inWIc00WeNgxy4nzekJHEScoYugk6ccb-lj3vPSbZYo0Wg9qBsftFcI7lfB_5duwoljpEV8P-rV_3mOpZBHU5yiKVT9yxAianoOjgdrf2zG8gIr_mxs_0Z7KEHnPJK7zW5w_GxldTeF1l3FktBfuODmj6rCNmkz_8f5jxUvLyhGK8awpcfTJWzk5fibJRJP-BThS3IINBlAb7kSMpqLcTcvZNgsdwYXo7IOzv7k_mpTckyg4KdRdnJWsv4jdSvn8y7I9WL2z8syxRl5GWSpbY3oex9tXYE7DF4j-R-qxHKW_A7wNsTCrn2sAltnJBFrwOl6xgscC4Q
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "f265fafb3c28c28e66318e94c5965925",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "362831376296775680",
    "name": "test-pin-list-a",
    "pinNumbers": [
      "1234",
      "5678"
    ],
    "version": 1
  }
}