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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"GroupGuid":"String"}