ICAI

4 min

Introduction

The API allows you to search for member numbers associated with a particular patron ID, allowing for quick and efficient retrieval of information.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../icais \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"essentials":{"memberNumber":".member-number-to-search-for.."}}'

Parameter	Type	Description
essentials	Object	The required parameter that contains the member number to search for.
memberNumber	String	The specific member number to search for.

Sample API Response

{
    "essentials": {
       "memberNumber": "..member-number-to-search-for.."
    },
    "id": "...accessToken...",
    "patronId": "...patronId...",
    "result": {
      "status": "...status...",
      "name": "...name...",
      "address": "...address...",
      "splitAddress": {
        "state": [
          []
        ],
        "district": [],
        "city": [],
        "pincode": "...pincode...",
        "country": [
          "IN",
          "IND",
          "INDIA"
        ],
        "addressLine": "...addressLine..."
      }
    }
  }

Parameter	Type	Description
result	Object	The object containing the search results.
status	String	The status of the search result.
name	String	The name of the patron associated with the member number searched for.
address	String	The full address of the patron associated with the member number searched for.
splitAddress	Object	The object containing the split components of the patron's address.

//