GET api/Locations/{id}

Returns the details of a location.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique ID of the location.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

LocationDetailModel
NameDescriptionTypeAdditional information
Id

Unique ID of the location

globally unique identifier

None.

Name

Name of the location

string

None.

Active

Indicates if location is active or not.

boolean

None.

Notes

Notes for the location.

string

None.

SundayClosed

Indicates if closed on Sundays.

boolean

None.

SundayFrom

Sunday start time.

string

None.

SundayTo

Sunday end time.

string

None.

MondayClosed

Indicates if closed on Mondays.

boolean

None.

MondayFrom

Monday start time.

string

None.

MondayTo

Monday end time.

string

None.

TuesdayClosed

Indicates if closed on Tuesday.

boolean

None.

TuesdayFrom

Tuesday start time.

string

None.

TuesdayTo

Tuesday end time.

string

None.

WednesdayClosed

Indicates if closed on Wednesday.

boolean

None.

WednesdayFrom

Wednesday start time.

string

None.

WednesdayTo

Wednesday end time.

string

None.

ThursdayClosed

Indicates if closed on Thursday.

boolean

None.

ThursdayFrom

Thursday start time.

string

None.

ThursdayTo

Thursday end time.

string

None.

FridayClosed

Indicates if closed on Friday.

boolean

None.

FridayFrom

Friday start time.

string

None.

FridayTo

Friday end time.

string

None.

SaturdayClosed

Indicates if closed on Saturday.

boolean

None.

SaturdayFrom

Saturday start time.

string

None.

SaturdayTo

Saturday end time.

string

None.

LogoPath

Path of logo for the location.

string

None.

LogoText

Text for logo of location to shown on map.

string

None.

BackgroundColor

Background color of the location on map.

string

None.

HeaderColor

Header color for location.

string

None.

FooterColor

Footer color for location.

string

None.

BackgroundImagePath

Background image path for the location.

string

None.

UseBackgroundColor

Indicates if background color can be used on map.

boolean

None.

UseLogoImage

Indicates if logo can be used on map.

boolean

None.

Contact

Contact details of the location.

ContactModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "3c265aba-3f2a-4339-8937-312bb819a0cc",
  "Name": "sample string 2",
  "Active": true,
  "Notes": "sample string 4",
  "SundayClosed": true,
  "SundayFrom": "sample string 6",
  "SundayTo": "sample string 7",
  "MondayClosed": true,
  "MondayFrom": "sample string 9",
  "MondayTo": "sample string 10",
  "TuesdayClosed": true,
  "TuesdayFrom": "sample string 12",
  "TuesdayTo": "sample string 13",
  "WednesdayClosed": true,
  "WednesdayFrom": "sample string 15",
  "WednesdayTo": "sample string 16",
  "ThursdayClosed": true,
  "ThursdayFrom": "sample string 18",
  "ThursdayTo": "sample string 19",
  "FridayClosed": true,
  "FridayFrom": "sample string 21",
  "FridayTo": "sample string 22",
  "SaturdayClosed": true,
  "SaturdayFrom": "sample string 24",
  "SaturdayTo": "sample string 25",
  "LogoPath": "sample string 26",
  "LogoText": "sample string 27",
  "BackgroundColor": "sample string 28",
  "HeaderColor": "sample string 29",
  "FooterColor": "sample string 30",
  "BackgroundImagePath": "sample string 31",
  "UseBackgroundColor": true,
  "UseLogoImage": true,
  "Contact": {
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "SuffixId": 4,
    "PrefixId": 5,
    "CompanyName": "sample string 6",
    "JobTitle": "sample string 7",
    "EmailAddresses": [
      {
        "Id": "6aac1221-9753-415e-9674-48568f683316",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      },
      {
        "Id": "6aac1221-9753-415e-9674-48568f683316",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      }
    ],
    "PhoneNumbers": [
      {
        "Id": "b050efad-f7cf-4a10-bb80-b9c67a61bd89",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      },
      {
        "Id": "b050efad-f7cf-4a10-bb80-b9c67a61bd89",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      }
    ],
    "PostalAddresses": [
      {
        "Id": "b845bda5-6b19-48e0-bc5b-c52a951d5ca9",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "159599c3-77aa-4f2e-9ca4-287fe7d687ff",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      },
      {
        "Id": "b845bda5-6b19-48e0-bc5b-c52a951d5ca9",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "159599c3-77aa-4f2e-9ca4-287fe7d687ff",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      }
    ],
    "Notes": "sample string 8"
  }
}

application/xml, text/xml

Sample:
<LocationDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Locations">
  <Active>true</Active>
  <BackgroundColor>sample string 28</BackgroundColor>
  <BackgroundImagePath>sample string 31</BackgroundImagePath>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 6</d2p1:CompanyName>
    <d2p1:EmailAddresses>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>6aac1221-9753-415e-9674-48568f683316</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>6aac1221-9753-415e-9674-48568f683316</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:JobTitle>sample string 7</d2p1:JobTitle>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:MiddleName>sample string 2</d2p1:MiddleName>
    <d2p1:Notes>sample string 8</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>b050efad-f7cf-4a10-bb80-b9c67a61bd89</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>b050efad-f7cf-4a10-bb80-b9c67a61bd89</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </d2p1:PhoneNumberModel>
    </d2p1:PhoneNumbers>
    <d2p1:PostalAddresses>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>159599c3-77aa-4f2e-9ca4-287fe7d687ff</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>b845bda5-6b19-48e0-bc5b-c52a951d5ca9</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>159599c3-77aa-4f2e-9ca4-287fe7d687ff</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>b845bda5-6b19-48e0-bc5b-c52a951d5ca9</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:PrefixId>5</d2p1:PrefixId>
    <d2p1:SuffixId>4</d2p1:SuffixId>
  </Contact>
  <FooterColor>sample string 30</FooterColor>
  <FridayClosed>true</FridayClosed>
  <FridayFrom>sample string 21</FridayFrom>
  <FridayTo>sample string 22</FridayTo>
  <HeaderColor>sample string 29</HeaderColor>
  <Id>3c265aba-3f2a-4339-8937-312bb819a0cc</Id>
  <LogoPath>sample string 26</LogoPath>
  <LogoText>sample string 27</LogoText>
  <MondayClosed>true</MondayClosed>
  <MondayFrom>sample string 9</MondayFrom>
  <MondayTo>sample string 10</MondayTo>
  <Name>sample string 2</Name>
  <Notes>sample string 4</Notes>
  <SaturdayClosed>true</SaturdayClosed>
  <SaturdayFrom>sample string 24</SaturdayFrom>
  <SaturdayTo>sample string 25</SaturdayTo>
  <SundayClosed>true</SundayClosed>
  <SundayFrom>sample string 6</SundayFrom>
  <SundayTo>sample string 7</SundayTo>
  <ThursdayClosed>true</ThursdayClosed>
  <ThursdayFrom>sample string 18</ThursdayFrom>
  <ThursdayTo>sample string 19</ThursdayTo>
  <TuesdayClosed>true</TuesdayClosed>
  <TuesdayFrom>sample string 12</TuesdayFrom>
  <TuesdayTo>sample string 13</TuesdayTo>
  <UseBackgroundColor>true</UseBackgroundColor>
  <UseLogoImage>true</UseLogoImage>
  <WednesdayClosed>true</WednesdayClosed>
  <WednesdayFrom>sample string 15</WednesdayFrom>
  <WednesdayTo>sample string 16</WednesdayTo>
</LocationDetailModel>