REST API Documentation - Review Group Module
EP : Extended Permissions
+ : Consider the permission and all permissions above it.
Permission sequence is : Account Admin > Project Manager > Project Member > Contact
Paths List all operations
/reviewGroup.do?cmd=ListActiveReviewGroup
- GET /reviewGroup.do?cmd=ListActiveReviewGroup
Summary
List Active Review Group
Description
Get list of active review groups.
Access
- Project Member +
Parameters
Name Located in Description Required Schema reviewUserId query Review User Id to list active review groups of the user. Optional parameter. If not specified will get list of all groups.
No integerclientIds query Provide comma separated string of client id's.
No stringprojectId query Provide project id.
No stringpage query Page param is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.
No integerstart query Provide start for your page. If not provided default will be 0 ie first record.
No integerlimit query Provide total records for a page. If not provided default is 5.
No integersortColumn query Provide sort column from sorting.
No stringsortDirection query Provide sort direction => (ASC or DESC)
No stringResponses
Response Type Description Success Retrieval successful.
Schema: List of ReviewUsergroups{ ReviewUsergroup }
Failure Unexpected error
Schema: Result
-
/reviewGroup.do?cmd=GetActiveReviewGroupUsers
- GET /reviewGroup.do?cmd=GetActiveReviewGroupUsers
Summary
Get Active Review Group Users
Description
Get list of active review group users
Access
- Project Member +
Parameters
Name Located in Description Required Schema groupId query Provide group Id to get active review users
Yes integerpage query Page param is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.
No integerstart query Provide start for your page. If not provided default will be 0 ie first record.
No integerlimit query Provide total records for a page. If not provided default is 5.
No integerResponses
-
/reviewGroup.do?cmd=AvailableReviewGroupMembers
- GET /reviewGroup.do?cmd=AvailableReviewGroupMembers
Summary
Available Review Group Members
Description
Get list of users available to add to review group
Access
- Project Member +
Parameters
Name Located in Description Required Schema groupId query Provide review group Id if old group is to be updated. If new group is to be created ignore this parameter.
Yes integerclientId query Provide client id.
No integerpage query Page param is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.
No integerstart query Provide start for your page. If not provided default will be 0 ie first record.
No integerlimit query Provide total records for a page. If not provided default is 5.
No integerResponses
-
/reviewGroup.do?cmd=AddReviewGroup
- GET /reviewGroup.do?cmd=AddReviewGroup
Summary
Add Review Group
Description
Add new review group
Access
- Project Manager +
Parameters
Name Located in Description Required Schema userIds query Provide comma separated user ids to add to review group.
Yes stringreviewUsergroupName query Provide review usergroup name
Yes stringclientId query Provide client id. Required if client segmentation is enabled.
No integerResponses
Response Type Description Success Schema: ResultResponse contain customParams, It provide review group Id.
Response Sample : { "returnCode": 0, "messageKey": "msg_group_success_addGroup", "detailedMessage": "Group added successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "CADE3D2F427AE5FA4DC48016F", "customParams": { "groupId": 1017 }, "errorMessages": null, "success": true }
Failure Unexpected error
Schema: Result
-
/reviewGroup.do?cmd=UpdateReviewGroup
- GET /reviewGroup.do?cmd=UpdateReviewGroup
Summary
Update Review Group
Description
Update Review Group. Users can be added or removed from the group and group name can be changed if required.
Access
- Project Manager +
Parameters
Name Located in Description Required Schema groupId query Provide review group Id to update.
Yes integeruserIds query Provide comma separated user ids to add to review group. Specify the old users also with new once. If old users not specified they will be removed from the group. If some user is to be removed from the group, do not specify his Id in this list, the user will be removed on update then.
Yes stringreviewUsergroupName query Provide review usergroup name
Yes stringResponses
-
/reviewGroup.do?cmd=DeleteReviewGroup
- GET /reviewGroup.do?cmd=DeleteReviewGroup
Summary
Delete Review Group
Description
Delete review group
Access
- Project Manager +
Parameters
Name Located in Description Required Schema groupId query Provide review group Id to delete.
Yes integerResponses
-
/reviewGroup.do?cmd=AvailableReviewGroupMembers
- GET /reviewGroup.do?cmd=AvailableReviewGroupMembers
Summary
List Available ReviewGroup members.
Description
List Available ReviewGroup members.
Access
- Project Member +
Parameters
Name Located in Description Required Schema groupId query Provide review group Id to list review group.
Yes integerclientId query Provide client Id to list review group.
Yes integerpage query Page param is required for applying paging. For paging start and limit params are required. If page not provided will return all the records.
No integerstart query Provide start for your page. If not provided default will be 0 ie first record.
No integerlimit query Provide total records for a page. If not provided default is 5.
No integerResponses
Response Type Description Success Retrieval successful.
Schema: List of ReviewGroup{ ReviewGroup }
Failure Unexpected error
Schema: Result
-