Web Service:PR-WS-3: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
**HL7 | **HL7 | ||
**JSON -- in this case we return an associative array as follows: | **JSON -- in this case we return an associative array as follows: | ||
{ | {{ | ||
{ | { | ||
firstname: "Bill" | firstname: "Bill" | ||
| Line 26: | Line 26: | ||
} | } | ||
} | } | ||
} | |||
| | | | ||
|response=*HTTP 200 - OK | |response=*HTTP 200 - OK | ||
Revision as of 07:07, 17 October 2012
{{WebServicePage|Get Provider Detail
|number=PR-WS-3 |description=Fetches details of a provider by their EPID or other identification type. |applications=Interoperability Layer, Point-Of-Care? Facility Registry? |url=/ws/rest/v2/providerDetails/byid |params=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
- ${format}The response format. One of:
- HL7
- JSON -- in this case we return an associative array as follows:
{{
{
firstname: "Bill"
surname: "Smith"
cadre: "Nurse"
email: "litlfred@ibibilio.org"
passport: "12312312"
mutuelle: "123123444"
csr: "123123"
nid: "333"
}
} }
| |response=*HTTP 200 - OK
- The HTTP response body will contain the epid as plain text.
|error=*HTTP 500 - Server Error - If the server encountered an error.
- HTTP 400 - Bad Request - If the parameters are malformed.
|resources=Use Case:PR-WS-1
}}
