MyHome.ie Data Delivery Service

<back to all web services

GetGroupGuidRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/group/guid/{GroupId}
GetGroupGuidRequest Parameters:
NameParameterData TypeRequiredDescription
GroupIdpathintNo
BaseDeliveryRequest Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
CorrelationIdformstringNo
ActiveUserIdformint?No
VersionformdoubleNo
RequestTypeIdformintNo
GetGroupGuidResponse Parameters:
NameParameterData TypeRequiredDescription
GroupGuidformstringNo

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

<GetGroupGuidResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyHome.v4.Api.Common.ServiceModel.InternalDelivery">
  <GroupGuid>String</GroupGuid>
</GetGroupGuidResponse>