Web Service:PR-WS-4

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

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

Fetches details of a provider's postings by their EPID.

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

${epid} The provider's EPID

  • ${format}The response format. One of 'hl7' or 'json'
GET Response
  • HTTP 200 - OK
  • If the format='hl7' .....
  • If the format='json' we return an array of associative arrays. The associative arrays have keys for the post attribtues. For example:

{ 

 0 : {
    facility: 'XXX District Hospital',
    foasid: '123213',   
    type:  'PPS',
    category: 'NURSE',
    actions: {
        'editPost': http://blahblah/,
         'disablePost': http://blahblah/
    }
 },
 1 : {
    facility: 'YYY District Hospital',
    code: '12345',   
    type:  'PPS',
    category: 'NURSE', 
    actions: {
        'editPost': http://blahblah/,
         'disablePost': http://blahblah/
    }
 },
}
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=46631"