Web Service:PR-WS-3

From IHRIS Wiki
Revision as of 19:17, 30 October 2012 by Litlfred (talk | contribs)

Web Service: PR-WS-3 Get Provider Detail

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

URL /ws/rest/v1/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',
   "postDetails": '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=46644"