GroupAPI

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List of active groups { AllActiveGroup }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List of active groups

{ AllActiveGroup }

Failure

Unexpected error

Schema : Result

/group.do?cmd=ListActiveGroup

GET /group.do?cmd=ListActiveGroup

Group

Summary

List Active Group

Description

Get list of active groups

Access

Project Member +

Parameters

Name

Located in

Description

Required

Schema

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

clientIds

query

Provide comma separatd list of client id's. Required if client segmentation is enabled.

No

integer

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 ie first record.

No

integer

limit

query

Provide total records for a page. If not provided default 5 records will be returned.

No

integer

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List of user groups { UserGroup }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List of user groups

{ UserGroup }

Failure

Unexpected error

Schema : Result

/group.do?cmd=GetActiveGroupUsers

GET /group.do?cmd=GetActiveGroupUsers
Group

Summary

Get Active Group Users
Description
Get Active Group Users

Access
- Project Manager +
Parameters

Name Located in Description Required Schema

groupId query
Provide group Id
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Retrieval successful.

Schema : List of users

{ User }

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Retrieval successful. `Schema` : List of users { User }
Failure	Unexpected error `Schema` : Result

/group.do?cmd=AddGroup

GET /group.do?cmd=AddGroup

Group

Summary

Add Group

Description

Add Group

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

userIds

query

Provide comma separated user Ids to add group

Yes

string

name

query

Provide group name

Yes

string

clientId

query

Provide client id.Required if client segmentation is enabled.

Yes

integer

Responses

Response Type Description

Response Type	Description
Success	`Schema` : Result Response contain customParams, It provide group Id. Sample JSON `Response Sample : { "returnCode": 0, "messageKey": "msg_group_success_addGroup", "detailedMessage": "Group added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "5BB77A623A00EE6592614C2E6CCEAF", "customParams": { "groupId": 8238 }, "errorMessages": null, "success": true }`
Failure	Unexpected error `Schema` : Result

Success

Schema : Result

Response contain customParams, It provide group Id.

Sample JSON


Response Sample :
{
  "returnCode": 0,
  "messageKey": "msg_group_success_addGroup",
  "detailedMessage": "Group added successfully.",
  "exception": null,
  "browser": "Mozilla 5.0 (Windows)",
  "sessionId": "5BB77A623A00EE6592614C2E6CCEAF",
  "customParams": {
    "groupId": 8238
  },
  "errorMessages": null,
  "success": true
}

Failure

Unexpected error

Schema : Result

/group.do?cmd=UpdateGroup

GET /group.do?cmd=UpdateGroup

Group

Summary

Update Group

Description

Update Group - Add or remove users. If user Ids not specified in userIds then they will be removed.

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

groupId

query

Provide group Id

Yes

integer

name

query

Provide group name

Yes

string

userIds

query

Provide comma separated user Ids to update group

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Group updated successfully. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Group updated successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/group.do?cmd=DeleteGroup

GET /group.do?cmd=DeleteGroup
Group

Summary

Delete Group
Description
Delete Group

Access
- Project Manager +
Parameters

Name Located in Description Required Schema

groupId query
Provide group Id to delete group
Yes

Object
type:"integer"

integer

Responses

Response Type Description

Success
Group deleted successfully.

Schema : Result

Failure
Unexpected error

Schema : Result

Response Type	Description
Success	Group deleted successfully. `Schema` : Result
Failure	Unexpected error `Schema` : Result

/group.do?cmd=AddGroupUsers

GET /group.do?cmd=AddGroupUsers

Group

Summary

Add Group Users

Description

Add Group Users

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

userIds

query

Provide comma separated user Ids to add to group.

Yes

string

groupIds

query

Provide comma separated group Ids to whome users should be added.

Yes

string

Responses

Response Type Description

Response Type	Description
Success	Group user(s) added successfully. `Schema` : Result
Failure	Unexpected error `Schema` : Result

Success

Group user(s) added successfully.

Schema : Result

Failure

Unexpected error

Schema : Result

/group.do?cmd=AvailableGroupMembers

GET /group.do?cmd=AvailableGroupMembers

Group

Summary

Get available group members

Description

Get user list available to add to group.

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

groupId

query

Provide group Id

Yes

integer

clientId

query

Provide client Id. Required if client segmentation is enabled.

Yes

integer

sortColumn

query

Provide sort column from your output columns.

No

string

sortDirection

query

Provide sort direction => (ASC or DESC)

No

string

Responses

Response Type Description

Response Type	Description
Success	Retrieval successful. `Schema` : List of users { User }
Failure	Unexpected error `Schema` : Result

Success

Retrieval successful.

Schema : List of users

{ User }

Failure

Unexpected error

Schema : Result

/group.do?cmd=ListGroupsForUsers

GET /group.do?cmd=ListGroupsForUsers

Group

Summary

List Groups For Users

Description

Get list of groups for users.

Access

Project Manager +

Parameters

Name

Located in

Description

Required

Schema

userIds

query

Provide comma separated user Id's to list groups for users

Yes

string

clientIds

query

Provide comma separated client Id's to list groups for users. Required if client segmentation is enabled.

Yes

string

page

query

Page parameter is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.

No

integer

start

query

Provide start for your page. If not provided default will be 0 i.e. first record.

No

integer

limit

query

Provide total records for a page.

No