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

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
  |number=PR-WS-5
  |number=PR-WS-5
  |description=Add Provider Details
  |description=Add Provider Details
  |applications=Interoperability Layer, Point-Of-Care?
  |applications=Interoperability Layer, Point-Of-Care, iHRIS
  |url=/ws/rest/v2/addProvider  
  |url=/ws/rest/v2/addProvider  
  |params=The following webservice should accept the following parameters:
  |params=The following webservice should accept the following parameters:

Revision as of 12:25, 30 October 2012

Web Service: PR-WS-5 Add a Provider

Add Provider Details

URL /ws/rest/v2/addProvider
GET Parameters The following webservice should accept the following parameters:
  • ${firstname} The first name of the provider. Required.
  • ${surname} The surname of the provider. Required.
  • ${nationality} The nationality of the provider coded according to ISO-3166-1 alpha-3. Required.
  • ${nid} The national id. Required.
  • ${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.' Example:

{ 

    "epid": 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/addProvider/?provder=m&reg_body=2

Other Resources: Use Case:PR-WS-5

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