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

From IHRIS Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{WebServicePage|Edit a Provider
{{WebServicePage|Edit a Provider
  |number=PR-WS-5
  |number=PR-WS-6
  |description=Add Provider Details
  |description=Edit Provider Details
  |applications=Interoperability Layer, Point-Of-Care, iHRIS
  |applications=Interoperability Layer, Point-Of-Care, iHRIS
  |url=/ws/rest/v2/editProvider/epid
  |url=/ws/rest/v2/edit/provider
  |params=The following webservice should accept the following parameters:
  |params=The following webservice should accept the following parameters:
*${epid} The EPID of the provider. Required.  
*${epid} The EPID of the provider. Required.  
Line 20: Line 20:
   Example:
   Example:
{
{
     "epid": 211312,
     epid: 211312,
     actions: {
     actions: {
       "providerDetails": 'http://rhea-pr.ihris.org/webservices/providerDetails/byid?id_num=211312',
       providerDetails: 'http://rhea-pr.ihris.org/webservices/detials/provider/byid?id_num=211312',
       "editProvider": 'http://rhea-pr.ihris.org/webservices/editProvider/epid=211312',
       editProvider: 'http://rhea-pr.ihris.org/webservices/edit/provider?epid=211312',
       "addPost": 'http://rhea-pr.ihris.org/webservices/addPost/epid=211312',
       addPost: 'http://rhea-pr.ihris.org/webservices/add/post?epid=211312',
       "getPosts": 'http://rhea-pr.ihris.org/webservices/getPosts/epid=211312',
       queryPosts: 'http://rhea-pr.ihris.org/webservices/query/posts?epid=211312',
      "viewProvider": 'http://rhea-pr.ihris.org/providerregistry/view?id=person%7C23123'
      viewProvider: 'http://rhea-pr.ihris.org/providerregistry/view?id=person%7C23123'
     }  
     }  
}
}
Line 32: Line 32:
*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-6]]
}}
}}

Latest revision as of 06:50, 31 October 2012

Web Service: PR-WS-6 Edit a Provider

Edit Provider Details

URL /ws/rest/v2/edit/provider
GET Parameters The following webservice should accept the following parameters:
  • ${epid} The EPID of the provider. Required.
  • ${surname} The surname of the provider. Optional.
  • ${nationality} The nationality of the provider coded according to ISO-3166-1 alpha-3. Optional.
  • ${nid} The national id. Optional.
  • ${passport} The passport number. Optional.
  • ${mutuelle} The mutuelle number. Optional.
  • ${csr} The CSR number. 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 epid as plain text.
  • If ${respformat} is 'json' it will contain a JSON object with the single field 'epid.'

further web-service actions to perform on the provider 

 Example:

{ 

    epid: 211312,
    actions: {
     providerDetails: 'http://rhea-pr.ihris.org/webservices/detials/provider/byid?id_num=211312',
     editProvider: 'http://rhea-pr.ihris.org/webservices/edit/provider?epid=211312',
     addPost: 'http://rhea-pr.ihris.org/webservices/add/post?epid=211312',
     queryPosts: 'http://rhea-pr.ihris.org/webservices/query/posts?epid=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.
GET Example /ws/rest/v2/edit/provider/?provder=m&reg_body=2

Other Resources: Use Case:PR-WS-6

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