In the World-Check One API - What is the difference between a case-id and case-system-id ?

John Williams
John Williams Explorer
in World-Check One
In the World-Check One API - What is the difference between a case-id and case-system-id ?
Tagged:

Best Answer

  • John Williams
    John Williams Explorer
    Answer ✓

    Hi @John Williams

    case-id is a free form text string that can be used by the API developer when the client already has unique identifiers for every case (name they want to screen). If the user or API request does not provide a case-id, the WC1 system creates a unique identifier. The case-id can be used to check if a case-id already exists.

    For example:

    {{protocol}}{{gateway-host}}{{gateway-url}}caseIdentifiers?caseId={{case-id}}

    will return 404: Not Found if the case-id does not exist and 200: OK if the case-id already exists. This can be used in the API to ensure the client provided case-id is unique.

    The case-system-id is a unique internal identifier (mapped to a case-id) used in most all the API requests that refer to a case.

    NOTE: Only the case-id is displayed in the World-Check One application (see WC1 QuickReferenceGuide)

    Let me know if you have any more questions about the World-Check One API.

    Brian

Categories