MyHome.ie Data Delivery Service

GetLocality

The following routes are available for this service:
GET	/locality/{LocalityId}

**GetLocality** Parameters:
Name	Parameter	Data Type	Required	Description
LocalityId	path	int	No

**BaseDeliveryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SessionId	form	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
CorrelationId	form	string	No
ActiveUserId	form	int?	No
Version	form	double	No
RequestTypeId	form	int	No

**LocalityResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Locality	form	Locality	No
LocalityParents	form	List<Locality>	No

**Locality** Parameters:
Name	Parameter	Data Type	Required
LocalityId	form	int	No
Name	form	string	No
DisplayNameOverride	form	string	No
UrlSlug	form	string	No
Code	form	string	No
Latitude	form	double	No
Longitude	form	double	No
Description	form	string	No
NoIndex	form	bool	No
MapZoom	form	int	No
TopSpotAvailable	form	bool	No
ParentIds	form	List<int>	No
ChildIds	form	List<int>	No
CreatedOn	form	DateTime	No
UseParentStats	form	bool	No
Radius	form	int?	No
LocalityImages	form	List<LocalityImage>	No
LocalitySeo	form	List<LocalitySeo>	No

**LocalityImage** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
LocalityId	form	int	No
ImagePath	form	string	No
Filename	form	string	No
PathToOriginal	form	string	No
PathToGalleria	form	string	No
Caption	form	string	No
Source	form	string	No

**LocalitySeo** Parameters:
Name	Parameter	Data Type	Required
LocalityId	form	int	No
PropertyClassId	form	int	No
MetaDescription	form	string	No
MetaTitle	form	string	No
PageName	form	string	No
CustomDescription	form	string	No
PropertyTypeId	form	int	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /locality/{LocalityId} HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LocalityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.InternalDelivery">
  <Locality xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Locality.Types">
    <d2p1:ChildIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:ChildIds>
    <d2p1:Code>String</d2p1:Code>
    <d2p1:CreatedOn>0001-01-01T00:00:00</d2p1:CreatedOn>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:DisplayNameOverride>String</d2p1:DisplayNameOverride>
    <d2p1:Latitude>0</d2p1:Latitude>
    <d2p1:LocalityId>0</d2p1:LocalityId>
    <d2p1:LocalityImages>
      <d2p1:LocalityImage>
        <d2p1:Caption>String</d2p1:Caption>
        <d2p1:Filename>String</d2p1:Filename>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:ImagePath>String</d2p1:ImagePath>
        <d2p1:LocalityId>0</d2p1:LocalityId>
        <d2p1:PathToGalleria>String</d2p1:PathToGalleria>
        <d2p1:PathToOriginal>String</d2p1:PathToOriginal>
        <d2p1:Source>String</d2p1:Source>
      </d2p1:LocalityImage>
    </d2p1:LocalityImages>
    <d2p1:LocalitySeo>
      <d2p1:LocalitySeo>
        <d2p1:CustomDescription>String</d2p1:CustomDescription>
        <d2p1:LocalityId>0</d2p1:LocalityId>
        <d2p1:MetaDescription>String</d2p1:MetaDescription>
        <d2p1:MetaTitle>String</d2p1:MetaTitle>
        <d2p1:PageName>String</d2p1:PageName>
        <d2p1:PropertyClassId>0</d2p1:PropertyClassId>
        <d2p1:PropertyTypeId>0</d2p1:PropertyTypeId>
      </d2p1:LocalitySeo>
    </d2p1:LocalitySeo>
    <d2p1:Longitude>0</d2p1:Longitude>
    <d2p1:MapZoom>0</d2p1:MapZoom>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:NoIndex>false</d2p1:NoIndex>
    <d2p1:ParentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:ParentIds>
    <d2p1:Radius>0</d2p1:Radius>
    <d2p1:TopSpotAvailable>false</d2p1:TopSpotAvailable>
    <d2p1:UrlSlug>String</d2p1:UrlSlug>
    <d2p1:UseParentStats>false</d2p1:UseParentStats>
  </Locality>
  <LocalityParents xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Locality.Types">
    <d2p1:Locality>
      <d2p1:ChildIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:ChildIds>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:CreatedOn>0001-01-01T00:00:00</d2p1:CreatedOn>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DisplayNameOverride>String</d2p1:DisplayNameOverride>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:LocalityId>0</d2p1:LocalityId>
      <d2p1:LocalityImages>
        <d2p1:LocalityImage>
          <d2p1:Caption>String</d2p1:Caption>
          <d2p1:Filename>String</d2p1:Filename>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:ImagePath>String</d2p1:ImagePath>
          <d2p1:LocalityId>0</d2p1:LocalityId>
          <d2p1:PathToGalleria>String</d2p1:PathToGalleria>
          <d2p1:PathToOriginal>String</d2p1:PathToOriginal>
          <d2p1:Source>String</d2p1:Source>
        </d2p1:LocalityImage>
      </d2p1:LocalityImages>
      <d2p1:LocalitySeo>
        <d2p1:LocalitySeo>
          <d2p1:CustomDescription>String</d2p1:CustomDescription>
          <d2p1:LocalityId>0</d2p1:LocalityId>
          <d2p1:MetaDescription>String</d2p1:MetaDescription>
          <d2p1:MetaTitle>String</d2p1:MetaTitle>
          <d2p1:PageName>String</d2p1:PageName>
          <d2p1:PropertyClassId>0</d2p1:PropertyClassId>
          <d2p1:PropertyTypeId>0</d2p1:PropertyTypeId>
        </d2p1:LocalitySeo>
      </d2p1:LocalitySeo>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:MapZoom>0</d2p1:MapZoom>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NoIndex>false</d2p1:NoIndex>
      <d2p1:ParentIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </d2p1:ParentIds>
      <d2p1:Radius>0</d2p1:Radius>
      <d2p1:TopSpotAvailable>false</d2p1:TopSpotAvailable>
      <d2p1:UrlSlug>String</d2p1:UrlSlug>
      <d2p1:UseParentStats>false</d2p1:UseParentStats>
    </d2p1:Locality>
  </LocalityParents>
</LocalityResponse>