Web Service:PR-WS-3: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 3: Line 3:
  |description=Fetches details of a provider by their EPID or other identification type.
  |description=Fetches details of a provider by their EPID or other identification type.
  |applications=Interoperability Layer, Point-Of-Care? Facility Registry?
  |applications=Interoperability Layer, Point-Of-Care? Facility Registry?
  |url=/ws/rest/v1/providerDetails
  |url=/ws/rest/v2/providerDetails
  |params=This contains the followng parameters to identify the provider whose details we shall return:
  |params=This contains the followng parameters to identify the provider whose details we shall return:
$epid.  The providers EPID.  Required.
$epid.  The providers EPID.  Required.

Revision as of 19:43, 30 October 2012

Web Service: PR-WS-3 Get Provider Detail

Fetches details of a provider by their EPID or other identification type.

URL /ws/rest/v2/providerDetails
GET Parameters This contains the followng parameters to identify the provider whose details we shall return:

$epid. The providers EPID. Required.

  • ${format}The response format. One of 'json' or 'hl7'. Defaults to 'json',
GET Response
  • HTTP 200 - OK
  • For HL7 See QueryProfessionalRSS.xml
  • For JSON we return an associative array containing the provider's details as well as URLs related to various actions to perform on the provider:

{ 

 firstname: "Bill",
 surname:  "Smith",
 cadre: "Nurse",
 email: "bsmith@example.org",
 passport: "12312312",
 mutuelle: "123123444",
 csr:  "123123",
 nid:  "333",
 actions: {
   providerDetails: 'http://rhea-pr.ihris.org/webservices/providerDetails?epid=211312',
   editProvider: 'http://rhea-pr.ihris.org/webservices/editProvider?epid=211312',
   addPost: 'http://rhea-pr.ihris.org/webservices/addPost?epid=211312',
   queryPosts: 'http://rhea-pr.ihris.org/webservices/postDetails?id=211312',
   viewProvider: 'http://rhea-pr.ihris.org/providerregistry/view?id=person%7C23123'
 }
}
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-3

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Web_Service:PR-WS-3&oldid=46664"