GET api/doctors/search?fullName={fullName}&active={active}&page={page}&itemsPerPage={itemsPerPage}

Returns a list of doctors.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fullName

Return doctors with names containing this parameter's value.

 string

Default value is empty string ("")
active

Filter doctors on whether they are active or not.

 boolean

Default value is True
page

Page number requested (search results are paginated).

 integer

Default value is 1
itemsPerPage

Items to return on each page. See page parameter above.

 integer

Default value is 10

Body Parameters

None.

Response Information

Resource Description

ListModelOfDoctorModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.
ItemsPerPage

integer

None.
CurrentPage

integer

None.
TotalPages

integer

None.
FirstRowOnPage

integer

None.
LastRowOnPage

integer

None.
Rows

Collection of DoctorModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "alias": "sample string 3",
      "active": true,
      "inHouse": true,
      "locationExternalId": "sample string 6",
      "secureRecipientExternalId": "sample string 7",
      "emailAddress": "sample string 8",
      "locations": [
        "sample string 1",
        "sample string 2"
      ],
      "id": "3805a54a-7c27-47e3-bc41-e32692f6a56c",
      "externalId": "sample string 10"
    },
    {
      "lastName": "sample string 1",
      "firstName": "sample string 2",
      "alias": "sample string 3",
      "active": true,
      "inHouse": true,
      "locationExternalId": "sample string 6",
      "secureRecipientExternalId": "sample string 7",
      "emailAddress": "sample string 8",
      "locations": [
        "sample string 1",
        "sample string 2"
      ],
      "id": "3805a54a-7c27-47e3-bc41-e32692f6a56c",
      "externalId": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample: 
<ListModelOfDoctorModel_PX30F3P0 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Doctors">
    <d2p1:DoctorModel>
      <ExternalId>sample string 10</ExternalId>
      <Id>3805a54a-7c27-47e3-bc41-e32692f6a56c</Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Alias>sample string 3</d2p1:Alias>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:InHouse>true</d2p1:InHouse>
      <d2p1:LastName>sample string 1</d2p1:LastName>
      <d2p1:LocationExternalId>sample string 6</d2p1:LocationExternalId>
      <d2p1:Locations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Locations>
      <d2p1:SecureRecipientExternalId>sample string 7</d2p1:SecureRecipientExternalId>
    </d2p1:DoctorModel>
    <d2p1:DoctorModel>
      <ExternalId>sample string 10</ExternalId>
      <Id>3805a54a-7c27-47e3-bc41-e32692f6a56c</Id>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Alias>sample string 3</d2p1:Alias>
      <d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:InHouse>true</d2p1:InHouse>
      <d2p1:LastName>sample string 1</d2p1:LastName>
      <d2p1:LocationExternalId>sample string 6</d2p1:LocationExternalId>
      <d2p1:Locations xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Locations>
      <d2p1:SecureRecipientExternalId>sample string 7</d2p1:SecureRecipientExternalId>
    </d2p1:DoctorModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfDoctorModel_PX30F3P0>