GET v1/organization/serviceproviders?forOrdersOnly={forOrdersOnly}
Get Service Providers: Get list of services providers (labs and imaging providers) defined in the organization.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
forOrdersOnly |
If true, only service providers enabled for Orders will be returned. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ServiceProviderListResponseName | Description | Type | Additional information |
---|---|---|---|
ServiceProviders |
Collection of service provider names |
Collection of string |
None. |
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
Sample:
{ "ServiceProviders": [ "sample string 1", "sample string 2" ], "Error": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ServiceProviderListResponse 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> <ServiceProviders> <string>sample string 1</string> <string>sample string 2</string> </ServiceProviders> </ServiceProviderListResponse>