MyHome.ie Data Delivery Service

AnalyticsLeads

**Requires Authentication**
Required role:	Admin

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

**AnalyticsLeads** Parameters:
Name	Parameter	Data Type	Required	Description
FromDate	body	string	No
ToDate	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

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

**Leads** Parameters:
Name	Parameter	Data Type	Required
LeadID	form	int	No
AgentID	form	int?	No
PropertyID	form	int?	No
CustomerEmail	form	string	No
CreatedOnDate	form	string	No
LeadType	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.

POST /analytics/leads HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AnalyticsLeads 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>
  <FromDate>String</FromDate>
  <ToDate>String</ToDate>
</AnalyticsLeads>

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

<AnalyticsLeadsResponse 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>
  <Leads xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.Analytic.Types">
    <d2p1:Leads>
      <d2p1:AgentID>0</d2p1:AgentID>
      <d2p1:CreatedOnDate>String</d2p1:CreatedOnDate>
      <d2p1:CustomerEmail>String</d2p1:CustomerEmail>
      <d2p1:LeadID>0</d2p1:LeadID>
      <d2p1:LeadType>0</d2p1:LeadType>
      <d2p1:PropertyID>0</d2p1:PropertyID>
    </d2p1:Leads>
  </Leads>
</AnalyticsLeadsResponse>