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

From IHRIS Wiki
(Created page with "{{WebServicePage|Add a Post |number=PR-WS-8 |description=Add Post Details |applications=Interoperability Layer, Point-Of-Care, iHRIS |url=/ws/rest/v2/addPost |params=The fo...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
  |description=Add Post Details
  |description=Add Post Details
  |applications=Interoperability Layer, Point-Of-Care, iHRIS  
  |applications=Interoperability Layer, Point-Of-Care, iHRIS  
  |url=/ws/rest/v2/addPost
  |url=/ws/rest/v2/add/post
  |params=The following webservice should accept the following parameters:
  |params=The following webservice should accept the following parameters:
*${type} The type of the post.  One of 'PPS' for Paid-Public Sector or 'CHW' for Community Health Worker. Required.  
*${type} The type of the post.  One of 'PPS' for Paid-Public Sector or 'CHW' for Community Health Worker. Required.  
Line 15: Line 15:
  |response=HTTP 200 - OK
  |response=HTTP 200 - OK
*If ${repsformat} is 'http' the HTTP response body will contain the id as plain text of the newly created posting  
*If ${repsformat} is 'http' the HTTP response body will contain the id as plain text of the newly created posting  
*If ${respformat} is 'json' it will contain a JSON object with the field 'epid' of the newly created provider as well as the URLs to access for further web-service actions to perform on the provider.   
*If ${respformat} is 'json' it will contain a JSON object with the field 'id' of the newly created post as well as the URLs to access for further web-service actions to perform on the post.   
{
{
     id: 211312,
     id: 211312,
     actions: {
     actions: {
       editPost: 'http://rhea-pr.ihris.org/webservices/editPost?id=992312',
       editPost: 'http://rhea-pr.ihris.org/webservices/edit/post?id=992312',
       postDetails: 'http://rhea-pr.ihris.org/webservices/viewPost?id=992312',
       postDetails: 'http://rhea-pr.ihris.org/webservices/details/post?id=992312',
       viewPost: 'http://rhea-pr.ihris.org/providerregistry/post?id=post%7C992312',       
       viewPost: 'http://rhea-pr.ihris.org/providerregistry/post?id=post%7C992312',       
     }  
     }  
Line 27: Line 27:
*HTTP 400 - Bad Request - If the parameters are malformed.
*HTTP 400 - Bad Request - If the parameters are malformed.
  |notes=  
  |notes=  
|resources=[[Use Case:PR-WS-5]]
|resources=[[Use Case:PR-WS-8]]
}}
}}

Latest revision as of 06:51, 31 October 2012

Web Service: PR-WS-8 Add a Post

Add Post Details

URL /ws/rest/v2/add/post
GET Parameters The following webservice should accept the following parameters:
  • ${type} The type of the post. One of 'PPS' for Paid-Public Sector or 'CHW' for Community Health Worker. Required.
  • ${category} The category/cadre of the providerm e.g. Nurse, Doctor. Required.
  • ${foasid} The facility code for this posting. Required.
  • ${orgunit} The organizational unit for this posting. Required.
  • ${startdate} The date the post is in effect. Format is 'YYYY-mm-dd'. Optional.
  • ${enddate} The date the post is no longer in effect. Format is 'YYYY-mm-dd'. Optional.
  • ${respformat} Describes response format. Optional. Default is 'http', can also be 'json.'
GET Response HTTP 200 - OK
  • If ${repsformat} is 'http' the HTTP response body will contain the id as plain text of the newly created posting
  • If ${respformat} is 'json' it will contain a JSON object with the field 'id' of the newly created post as well as the URLs to access for further web-service actions to perform on the post.

{ 

    id: 211312,
    actions: {
      editPost: 'http://rhea-pr.ihris.org/webservices/edit/post?id=992312',
      postDetails: 'http://rhea-pr.ihris.org/webservices/details/post?id=992312',
      viewPost: 'http://rhea-pr.ihris.org/providerregistry/post?id=post%7C992312',       
    }
}
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/add/post/?category=NURSE&type=PPS&fosaid=12312&orgunit=2133

Other Resources: Use Case:PR-WS-8

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