GET | /group/token/{ReportGuid} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReportGuid | path | string | No | |
DataSetGuid | query | string | No | |
GroupId | query | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SessionId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | form | string | No | |
CorrelationId | form | string | No | |
ActiveUserId | form | int? | No | |
Version | form | double | No | |
RequestTypeId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
User | form | User | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No | |
FamilyName | form | string | No | |
Sub | form | string | No | |
Role | form | string | No | |
form | string | No | ||
GroupId | form | int | No | |
HasMarketShareSubscription | form | bool | No | |
GroupGuid | form | string | No | |
TokenExpireIn | form | DateTime? | No | |
AccountManager | form | Contact | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Phone | form | string | No | |
form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: 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 } } }