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

From IHRIS Wiki
(Created page with "{{WebServicePage|Get Provider Posting Detail |number=PR-WS-4 |description=Fetches details of a provider's postings by their EPID or other identification type. |applications=In...")
 
No edit summary
Line 33: Line 33:
  |error=*HTTP 500 - Server Error - If the server encountered an error.
  |error=*HTTP 500 - Server Error - If the server encountered an error.
*HTTP 400 - Bad Request - If the parameters are malformed.
*HTTP 400 - Bad Request - If the parameters are malformed.
  |resources=[[Use Case:PR-WS-1]]
  |resources=[[Use Case:PR-WS-4]]
}}
}}

Revision as of 07:37, 17 October 2012

Web Service: PR-WS-4 Get Provider Posting Detail

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

URL /ws/rest/v2/providerPosts/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
  • ${format}The response format. One of:
    • HL7
    • JSON -- in this case we return an array of associative arrays. The associative arrays have keys for the post attribtues. For example:

{ 

 0 : {
    facility: 'XXX District Hospital',
    facility_code: '123213',   
    post_type:  'PPS',
    post_category: 'NURSE'
 },
 1 : {
    facility: 'YYY District Hospital',
    facility_code: '12345',   
    post_type:  'PPS',
    post_category: 'NURSE'
 },
}
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-4

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