MyHome.ie Data Delivery Service

AnalyticsGroups

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/analytics/groups

**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

**AnalyticsGroupsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
GroupAnalytics	form	List<GroupAnalytics>	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

**GroupAnalytics** Parameters:
Name	Parameter	Data Type	Required
AgentID	form	int	No
AgentGUID	form	string	No
Name	form	string	No
Address	form	string	No
Latitude	form	string	No
Longitude	form	string	No
AccountManagerID	form	int	No
Accountmanager	form	string	No
Locality	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 /analytics/groups HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<AnalyticsGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic">
  <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>
  <GroupAnalytics xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic.Types">
    <d2p1:GroupAnalytics>
      <d2p1:AccountManagerID>0</d2p1:AccountManagerID>
      <d2p1:Accountmanager>String</d2p1:Accountmanager>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:AgentGUID>String</d2p1:AgentGUID>
      <d2p1:AgentID>0</d2p1:AgentID>
      <d2p1:Latitude>String</d2p1:Latitude>
      <d2p1:Locality>String</d2p1:Locality>
      <d2p1:Longitude>String</d2p1:Longitude>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:GroupAnalytics>
  </GroupAnalytics>
</AnalyticsGroupsResponse>