MyHome.ie Data Delivery Service

<back to all web services

GetUserRequest

Requires Authentication
The following routes are available for this service:
GET/user
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 .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /user HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	User: 
	{
		Id: 0,
		Name: String,
		FamilyName: String,
		Sub: String,
		Role: String,
		Email: String,
		GroupId: 0,
		HasMarketShareSubscription: False,
		GroupGuid: String,
		TokenExpireIn: 0001-01-01,
		AccountManager: 
		{
			Name: String,
			Phone: String,
			Email: String
		}
	}
}