Check for Duplicate PIN Lists

Check whether the name of a PIN list already exists before adding or updating it.

Request URL

POST {base_url}/uc-cconfig/api/v1/pin-lists/validate

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.
Body parameters
Parameter Required Type Description
id No String The ID of an existing PIN list to exclude from the duplicate check.
Note: You can obtain the ID using the Search PIN Lists interface.
name No String The name of the PIN list to check for duplicates.

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<Duplicate_Check_Result> The duplicate check result.
Duplicate_Check_Result
Parameter Type Description
valid Boolean Whether the name passes the duplicate check.
  • true: The name does not conflict with existing records.
  • false: The name conflicts with an existing record.
errors Array<Error_Message> The error message describing the duplicate conflict.
Error_Message
Parameter Type Description
field String The name of the field that fails the duplicate check.
  • name
message String The status message of the request.

Example

Request example

POST /uc-cconfig/api/v1/pin-lists/validate 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
Content-Type: application/json
x-tenant-code: jint
{
  "id": "362831376296775680",
  "name": "test-pin-list-a-updated"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "cef563ba002da81ab9e2936b1aaa6019",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "valid": true,
    "errors": []
  }
}