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

From IHRIS Wiki
No edit summary
No edit summary
Line 3: Line 3:
  |description=Show details of a provider's post
  |description=Show details of a provider's post
  |applications=Interoperability Layer, Point-Of-Care?
  |applications=Interoperability Layer, Point-Of-Care?
  |url=/ws/rest/v1/professional/postDetails
  |url=/ws/rest/v2/professional/postDetails
  |params=The following query parameters are allowed:
  |params=The following query parameters are allowed:
*${id} The id of the post
*${id} The id of the post

Revision as of 19:43, 30 October 2012

Web Service: PR-WS-7 Get Post Details

Show details of a provider's post

URL /ws/rest/v2/professional/postDetails
GET Parameters The following query parameters are allowed:
  • ${id} The id of the post
  • {format}The response format. One of 'json', ?'hl7'?
GET Response HTTP 200 - OK

Example: { 

    type: 'PPS',  #One of PPS or CHW
    category: 'NURSE', 
    fosaid: '012321',
    orgunit: '197834',
    startdate: '1992-12-22'  #year, month, day
    actions: {
       postDetails: 'http://rhea-pr.ihris.org/webservices/postDetails?id=211312',
       editPost: 'http://rhea-pr.ihris.org/webservices/editPost?id=211312'
    }
}
GET Error
  • HTTP 500 - Server Error - If the server encountered an error.
  • HTTP 400 - Bad Request - If the parameters are malformed.
GET Example /ws/rest/v2/professional/postDetails/?id=12312321312
Notes Need to good way for limiting response length. See A collection: the list of bugs in the Launchpad API

Other Resources: Use Case:PR-WS-7

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