GET v1/serviceprovider/ConfirmGetOrders?mode={mode}&serviceProviderConnectionAuthCode={serviceProviderConnectionAuthCode}&ackResponse={ackResponse}
Confirm Service Provider Orders Retrieval: Confirm the successful retrieval of orders. This must be used by a lab or imaging provider to confirm the retrieval of orders after calling the GetOrders API method. If this request is not made after a successful call to GetOrders, the orders will not be marked as downloaded and will be retrieved again in the next call to GetOrders resulting in duplicate orders.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
mode |
Determines whether the orders confirmed are test mode or live (aka production) mode orders. Specify 'live' to confirm live orders. If empty or any other value, only test mode orders are confirmed. |
string |
Default value is |
serviceProviderConnectionAuthCode |
This parameter must be used to identify the specific lab/imaging connection if the service provider "owns" more than one connection in EMR-Link. If left empty, and the service provider owns more than one lab/imaging connection, an error will be returned. If the service provider owns only one service provider connection, this parameter can be ignored. |
string |
Default value is |
ackResponse |
This parameter is used to send back acknowledgement of a successful retrieval and storage of the orders by the caller. The value supplied should be the value of the AckResponse field in the response to the prior GetOrders API call. |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
BaseResponseName | Description | Type | Additional information |
---|---|---|---|
Error |
Will be set to True if any errors occur during the processing of the API method. |
boolean |
None. |
ErrorMessage |
Will contain an error message string if Error is True. |
string |
None. |
Response Formats
application/json, text/json
{ "Error": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
<BaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error>true</Error> <ErrorMessage>sample string 2</ErrorMessage> </BaseResponse>