IHTSDO MLDS REST API
IHTSDO-MLDS provides a limited number of APIs to support integration with other systems.
For further information on the REST APIs to get access to releases, please go to the MLDS Release Packages API page.
All access to the API is over HTTPS to the
mlds.ihtsdotools.org domain. All data is sent and received as JSON.
Client errors on API calls will typically result in a
400 Bad Request response.
Error responses can be detected by a status code of 4xx or 5xx. The message value is an optional human description of the problem.
The public APIs do not require authentication to be supplied.
Where possible the API supports appropriate HTTP Methods/Verbs for each resource.
|GET||Retrieve a representation of the resource.|
|POST||Create a new resource.|
|PUT||Replace a resource.|
|DELETE||Delete a resource.|
Check that an affiliate is in good standing with IHTSDO.
Where possible the
affilateId with confirming matching data from the application can be used, otherwise a single match from all affiliates of a member can be used.
|member||string||Mandatory||Identification of the member country that the affiliate has been accepted by. It is either a two-letter country code or |
|match||string||Mandatory||Search keyword within the affiliate record. This will match against a number of identifying fields of the affiliate: organization name, first name, last name, street address, email, alternative email, and third email.|
|affiliateId||string||Optional||Limit the search to a specific Affilate record.|
The check API requires a unique match to be found from the database of Affiliates. Affiliates are filtered by the member, optionally by affiliate id, and a keyword text match against the identifying fields of the affiliate.
Once a single affiliate has been identified the affiliate's application must have been approved for the specified member and for the affiliate's account to be considered in good standing.
If successful then the API will return with a
If there is no match then the API will return with
No additional information is provided to diagnose a failed match.
A successful match against a Swedish affiliate based on a match against the
firstname.lastname@example.org email address. The affiliate was uniquely identified and the account was in good standing.
An unsuccessful match against an IHTSDO affiliate based a match against the keyword hospital. No affiliate was uniquely identified as many affiliates contained
hospital in the searched fields.
A successful match that limited the search to a single specified affiliate. The 'hospital' keyword matched, unlike before, however, by limiting the search to a single affiliate the result was unique.
match value contains user supplied data and as result may need to be escaped using standard URL rules. For example, matching the email address
email@example.com would require escaping the
+ character as
%2B when using curl or else the match request would fail.
- No labels