Web Service:PR-WS-7: 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| | {{WebServicePage|Get Post Details | ||
|number=PR-WS-7 | |number=PR-WS-7 | ||
|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/ | |url=/ws/rest/v2/details/post | ||
|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 | ||
| Line 16: | Line 16: | ||
orgunit: '197834', | orgunit: '197834', | ||
startdate: '1992-12-22' #year, month, day | startdate: '1992-12-22' #year, month, day | ||
actions: { | |||
postDetails: 'http://rhea-pr.ihris.org/webservices/details/post?id=211312', | |||
editPost: 'http://rhea-pr.ihris.org/webservices/edit/post?id=211312' | |||
} | |||
} | } | ||
|error=*HTTP 500 - Server Error - If the server encountered an error. | |error=*HTTP 500 - Server Error - If the server encountered an error. | ||
Latest revision as of 07:50, 31 October 2012
Web Service: PR-WS-7 Get Post Details
Show details of a provider's post
| URL | /ws/rest/v2/details/post |
| GET Parameters | The following query parameters are allowed:
|
| 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/details/post?id=211312',
editPost: 'http://rhea-pr.ihris.org/webservices/edit/post?id=211312'
}
} |
| GET Error |
|
| GET Example | /ws/rest/v2/details/post/?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
