GET v1/organization/serviceprovideraccounts?serviceprovidername={serviceprovidername}

Get Service Provider Accounts: Get list of service provider (lab and imaging) accounts defined in the organization. An optional serviceprovidername parameter can be passed to specify a particular service provider. If not supplied, the accounts for all service providers in the organization are returned. The service provider name must match the lab connection name in the organization's lab list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceprovidername

Optional. If supplied, must match a lab connection name in the organization's lab list.

string

Default value is

Body Parameters

None.

Response Information

Resource Description

ServiceProviderAccountListResponse
NameDescriptionTypeAdditional information
AccountList

Collection of Service Provider Account entries

Collection of ServiceProviderAccount

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:
{
  "AccountList": [
    {
      "AccountName": "sample string 1",
      "AccountNumber": "sample string 2",
      "ServiceProviderName": "sample string 3",
      "ServiceProviderRegion": "sample string 4",
      "LocationName": "sample string 5",
      "LocationAbbreviation": "sample string 6"
    },
    {
      "AccountName": "sample string 1",
      "AccountNumber": "sample string 2",
      "ServiceProviderName": "sample string 3",
      "ServiceProviderRegion": "sample string 4",
      "LocationName": "sample string 5",
      "LocationAbbreviation": "sample string 6"
    }
  ],
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ServiceProviderAccountListResponse 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>
  <AccountList>
    <ServiceProviderAccount>
      <AccountName>sample string 1</AccountName>
      <AccountNumber>sample string 2</AccountNumber>
      <ServiceProviderName>sample string 3</ServiceProviderName>
      <ServiceProviderRegion>sample string 4</ServiceProviderRegion>
      <LocationName>sample string 5</LocationName>
      <LocationAbbreviation>sample string 6</LocationAbbreviation>
    </ServiceProviderAccount>
    <ServiceProviderAccount>
      <AccountName>sample string 1</AccountName>
      <AccountNumber>sample string 2</AccountNumber>
      <ServiceProviderName>sample string 3</ServiceProviderName>
      <ServiceProviderRegion>sample string 4</ServiceProviderRegion>
      <LocationName>sample string 5</LocationName>
      <LocationAbbreviation>sample string 6</LocationAbbreviation>
    </ServiceProviderAccount>
  </AccountList>
</ServiceProviderAccountListResponse>