Fetches details of a provider by their EPID or other identification type.
| URL |
/ws/rest/v2/providerDetails/byid |
| GET Parameters |
This contains the followng parameters to identify the provider whose details we shall return:
${id-type} is one of the following:
- NID - for a national identification number
- APN - for an application number
- PPN - for passport number
- SSN - for social security number
- ${id_number} is the value of the associated id
- ${attributes[]} Is an array of provider attributes to return. Possible values include:
- firstname
- surname
- cadre
- email
- passport
- mutuelle
- csr
- nid
- ${format}The response format. One of:
- HL7
- JSON -- in this case we return an associative array whose keys are the valid values received in ${attributes[]}
|
| GET Response |
- HTTP 200 - OK
- The HTTP response body will contain the epid as plain text.
|
| GET Error |
- HTTP 500 - Server Error - If the server encountered an error.
- HTTP 400 - Bad Request - If the parameters are malformed.
|
Other Resources: Use Case:PR-WS-1
