GET v1/organization/providers

Get Providers: Get list of providers (physicians) defined in the organization.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ProviderListResponse
NameDescriptionTypeAdditional information
Providers

Collection of Provider objects.

Collection of Provider

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:
{
  "Providers": [
    {
      "LastName": "sample string 1",
      "FirstName": "sample string 2",
      "Suffix": "sample string 3",
      "UserName": "sample string 4",
      "NPI": "sample string 5",
      "UPIN": "sample string 6",
      "OtherID": "sample string 7",
      "ID": "sample string 8"
    },
    {
      "LastName": "sample string 1",
      "FirstName": "sample string 2",
      "Suffix": "sample string 3",
      "UserName": "sample string 4",
      "NPI": "sample string 5",
      "UPIN": "sample string 6",
      "OtherID": "sample string 7",
      "ID": "sample string 8"
    }
  ],
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ProviderListResponse 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>
  <Providers>
    <Provider>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
      <Suffix>sample string 3</Suffix>
      <UserName>sample string 4</UserName>
      <NPI>sample string 5</NPI>
      <UPIN>sample string 6</UPIN>
      <OtherID>sample string 7</OtherID>
      <ID>sample string 8</ID>
    </Provider>
    <Provider>
      <LastName>sample string 1</LastName>
      <FirstName>sample string 2</FirstName>
      <Suffix>sample string 3</Suffix>
      <UserName>sample string 4</UserName>
      <NPI>sample string 5</NPI>
      <UPIN>sample string 6</UPIN>
      <OtherID>sample string 7</OtherID>
      <ID>sample string 8</ID>
    </Provider>
  </Providers>
</ProviderListResponse>