MyHome.ie Data Delivery Service

GetPropertyWidget

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
GET,POST	/propertywidget/{RegionId}

**GetPropertyWidget** Parameters:
Name	Parameter	Data Type	Required
PropertyId	body	int	No
RegionId	path	int	No
UserId	body	int	No
CreatedOn	body	DateTime	No
ModifiedOn	body	DateTime	No
ModifiedByUserName	body	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

**GetPropertyWidgetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
PropertyWidget	form	PropertyWidget	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**BaseType** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	double	No

**PropertyWidget** Parameters:
Name	Parameter	Data Type	Required
PropertyWidgetId	form	int	No
PropertyId	form	int	No
RegionId	form	int	No
UserId	form	int	No
CreatedOn	form	DateTime	No
IsActive	form	bool	No
ModifiedOn	form	DateTime	No
ModifiedBy	form	int	No
ModifiedByUserName	form	string	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.

POST /propertywidget/{RegionId} HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPropertyWidget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.PropertyWidget">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</ApiKey>
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">String</CorrelationId>
  <ActiveUserId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</ActiveUserId>
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <RequestTypeId xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</RequestTypeId>
  <CreatedOn>0001-01-01T00:00:00</CreatedOn>
  <ModifiedByUserName>String</ModifiedByUserName>
  <ModifiedOn>0001-01-01T00:00:00</ModifiedOn>
  <PropertyId>0</PropertyId>
  <RegionId>0</RegionId>
  <UserId>0</UserId>
</GetPropertyWidget>

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

<GetPropertyWidgetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.PropertyWidget">
  <Version xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">0</Version>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <PropertyWidget xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.PropertyWidget.Types">
    <d2p1:CreatedOn>0001-01-01T00:00:00</d2p1:CreatedOn>
    <d2p1:IsActive>false</d2p1:IsActive>
    <d2p1:ModifiedBy>0</d2p1:ModifiedBy>
    <d2p1:ModifiedByUserName>String</d2p1:ModifiedByUserName>
    <d2p1:ModifiedOn>0001-01-01T00:00:00</d2p1:ModifiedOn>
    <d2p1:PropertyId>0</d2p1:PropertyId>
    <d2p1:PropertyWidgetId>0</d2p1:PropertyWidgetId>
    <d2p1:RegionId>0</d2p1:RegionId>
    <d2p1:UserId>0</d2p1:UserId>
  </PropertyWidget>
</GetPropertyWidgetResponse>