GET api/PatientPreferredLocation?patientId={patientId}

Returns the preferred location of the patient

Request Information

URI Parameters

NameDescriptionTypeAdditional information
patientId

Unique ID of patient

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

PatientPreferredLocationModel
NameDescriptionTypeAdditional information
HasValidPreferredLocation

Indicates if patient has preferred location or not

boolean

None.

LocationId

Unique ID of location

globally unique identifier

None.

LocationName

Name of the location

string

None.

State

State of location

string

None.

Address1

Address line 1

string

None.

Address2

Address line 2

string

None.

City

City

string

None.

Zip

Zip

string

None.

CountryName

Name of the country

string

None.

CountryId

Unique ID of country

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "HasValidPreferredLocation": true,
  "LocationId": "6794e9e7-55d1-42fe-8126-42744f98ef42",
  "LocationName": "sample string 2",
  "State": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "Zip": "sample string 7",
  "CountryName": "sample string 8",
  "CountryId": "f7100d7f-1ab9-4b23-a48c-1d068789f6fa"
}

application/xml, text/xml

Sample:
<PatientPreferredLocationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.AppointmentRequests">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <City>sample string 6</City>
  <CountryId>f7100d7f-1ab9-4b23-a48c-1d068789f6fa</CountryId>
  <CountryName>sample string 8</CountryName>
  <HasValidPreferredLocation>true</HasValidPreferredLocation>
  <LocationId>6794e9e7-55d1-42fe-8126-42744f98ef42</LocationId>
  <LocationName>sample string 2</LocationName>
  <State>sample string 3</State>
  <Zip>sample string 7</Zip>
</PatientPreferredLocationModel>