MyHome.ie Data Delivery Service

<back to all web services

GetGroupPowerBITokenRequest

Requires Authentication
The following routes are available for this service:
GET/group/token/{ReportGuid}
GetGroupPowerBITokenRequest Parameters:
NameParameterData TypeRequiredDescription
ReportGuidpathstringNo
DataSetGuidquerystringNo
GroupIdqueryint?No
BaseDeliveryRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
GetUserResponse Parameters:
NameParameterData TypeRequiredDescription
UserformUserNo
User Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
FamilyNameformstringNo
SubformstringNo
RoleformstringNo
EmailformstringNo
GroupIdformintNo
HasMarketShareSubscriptionformboolNo
GroupGuidformstringNo
TokenExpireInformDateTime?No
AccountManagerformContactNo
Contact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneformstringNo
EmailformstringNo

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

<GetUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.InternalDelivery">
  <User xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.InternalDelivery.Types">
    <d2p1:AccountManager>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Phone>String</d2p1:Phone>
    </d2p1:AccountManager>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FamilyName>String</d2p1:FamilyName>
    <d2p1:GroupGuid>String</d2p1:GroupGuid>
    <d2p1:GroupId>0</d2p1:GroupId>
    <d2p1:HasMarketShareSubscription>false</d2p1:HasMarketShareSubscription>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Role>String</d2p1:Role>
    <d2p1:Sub>String</d2p1:Sub>
    <d2p1:TokenExpireIn>0001-01-01T00:00:00</d2p1:TokenExpireIn>
  </User>
</GetUserResponse>