MyHome.ie Data Delivery Service

<back to all web services

GetPropertyWidgetHistory

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/propertywidget
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo

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 /propertywidget HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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