MyHome.ie Data Delivery Service

GetFeaturedSpotMessagesList

The following routes are available for this service:
POST,GET	/message/featuredspotmessageslist

**GetFeaturedSpotMessagesList** Parameters:
Name	Parameter	Data Type	Required	Description
FeatureSpotId	body	int?	No
UserId	body	int?	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

**FeaturedSpotMessagesListResponse** Parameters:
Name	Parameter	Data Type	Required	Description
FeaturedSpotMessage	form	List<FeaturedSpotMessages>	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

**FeaturedSpotMessages** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
FeatureSpotId	form	int	No
MessageText	form	string	No
UserId	form	int	No
Name	form	string	No
Email	form	string	No
UserName	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 /message/featuredspotmessageslist HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetFeaturedSpotMessagesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Message">
  <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>
  <FeatureSpotId>0</FeatureSpotId>
  <UserId>0</UserId>
</GetFeaturedSpotMessagesList>

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

<FeaturedSpotMessagesListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Message">
  <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>
  <FeaturedSpotMessage xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Message.Types">
    <d2p1:FeaturedSpotMessages>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FeatureSpotId>0</d2p1:FeatureSpotId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MessageText>String</d2p1:MessageText>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:FeaturedSpotMessages>
  </FeaturedSpotMessage>
</FeaturedSpotMessagesListResponse>