You are here:
InsGroupClassService:getGroupClassesByAccount
Fetch the GroupClasses associated with the given AccountId.
Class: InsGroupClassService
Method: getGroupClassesByAccount
How It Works
-
The service fetches all the group classes associated with the given accountId which have an Effective Start Date less than or equal to effectiveDate and Effective End Date greater than or equal to effectiveDate.
-
If effectiveDate isn't passed to the service, the service uses today's date as the effectiveDate.
Inputs
| Input | Description |
|---|---|
accountId
|
Required. The ID of the account associated with the GroupClasses being retrieved. |
effectiveDate
|
Optional. Date used to determine which GroupClasses to retrieve. |
Remote Options
| Option | Description |
|---|---|
accountId
|
Required. The ID of the account associated with the GroupClasses being retrieved. |
effectiveDate
|
Optional. Date used to determine which GroupClasses to retrieve. |
Input JSON
Here's the sample input JSON:
{
"accountId":"001B000001UGEaRIAX",
"effectiveDate":"dd/mm/yyyy"
}Output JSON
Here's the sample output JSON:
{
"accountId": "001B000001UGEaRIAX",
"groupClasses":[
{
"Id":"0rEB00000004CSGMA2",
"Name":"Manager",
"Code":"code01"
},
{
"Id":"0rEB00000004CO5MAM",
"Name":"Executive",
"Code": "code02"
}
]
}