Error Status Codes

The Convergent Provider Search API uses conventional HTTP response codes to indicate the success or failure of an API request.

Endpoint

Return Code

Comment

ALL

200 Ok

All endpoints return 200 for a successful response

ALL

500 Internal Server Error

All endpoints can return 500 if an expected error occurs

/api/searchSingleBest

400 Bad Request

400 is returned if the provided search parameters result in more than one match. 400 can also be returned if there are issues with the tenantId or searchConfigurationId, as with /api/search.

/api/searchSingleBest

404 Not Found

404 is returned if the provided search parameters result in no matches.

/api/sourceRecords

404 Not Found

404 is returned if the curatedId does not exist

/api/curated

404 Not Found

404 is returned if the curatedId does not exist