Web Service:PR-WS-1

From IHRIS Wiki
Revision as of 10:14, 10 May 2012 by Litlfred (talk | contribs) (Created page with "{{WebServicePage|Get Enterprise Professional ID |number=PR-WS-1 |description=Fetches a HC Professional Enterprise ID for the professional specified by the professional ID param...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Web Service: PR-WS-1 Get Enterprise Professional ID

Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter.

URL /ws/rest/v1/professional/${pro-id}/epid
GET Parameters This contains only 1 parameter to identify the professional to return ${pro-ID}

The unique professional ID for the professional requested with the following format:

<ID-type>-<ID-number>

Where <ID-type> is one of the following: 

           NID - for a national identification number
           APN - for an application number
           PPN - for passport number
           SSN - for social security number
Eg. GET /ws/rest/v1/professional/NID-1234567890/epid
GET Response
  • HTTP 200 - OK
  • The HTTP response body will contain the epid as plain text.
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-1

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