GET api/PatientPreferredLocation?patientId={patientId}

Returns the preferred location of the patient

Request Information

URI Parameters

Name	Description	Type	Additional information
patientId	Unique ID of patient	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

PatientPreferredLocationModel

Name	Description	Type	Additional 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": "e88bd9ae-62fd-446b-9846-d3332d402413",
  "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": "4002a19d-a97a-46d5-b788-a9191e2e8ca3"
}

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>4002a19d-a97a-46d5-b788-a9191e2e8ca3</CountryId>
  <CountryName>sample string 8</CountryName>
  <HasValidPreferredLocation>true</HasValidPreferredLocation>
  <LocationId>e88bd9ae-62fd-446b-9846-d3332d402413</LocationId>
  <LocationName>sample string 2</LocationName>
  <State>sample string 3</State>
  <Zip>sample string 7</Zip>
</PatientPreferredLocationModel>