Group

A Group object represents a user group in BlueCamroo.

Supported API Calls: List | Get | Add | Update | Delete

Object Properties

Property

Type

Description

Id

integer

Unique Identity of a Group. When adding a new Group the value must be 0.

Name

string (100)

Name of the Group, maximum length is 100, cannot be blank.

Code

string (100)

Indicates if the group is a hard coded group: expense_approver, expense_payer, .

IsBuiltin

boolean

If true, indicates the group is a built in group and cannot be deleted.

DefaultBillingGrade

integer

The ID of the BillingGrade object the group is associated with. This is optional and can be 0.

IsTaskGroup

boolean

Indicates if the Group is a Task Group (the group can be assigned tasks).

List

Description

Returns a list of user groups.

URL

https://{company}.bluecamroo.com/api/group/list

HTTP Method

Data Return

Returns the group object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

401: Not authorized (you need to log in)

Get

Description

Returns the group's details based on the passed id.

URL

https://{company}.bluecamroo.com/api/group/detial/{id}

HTTP Method

GET

Parameters

None

Data Return

Returns the group object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Add

Description

Adds the group object to the list of user groups.

URL

https://{company}.bluecamroo.com/api/group/add

HTTP Method

POST

Parameters

A group object.

Data Return

Returns the group object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

201: Created

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Update

Description

Pass a group object to replace the specified user group.

URL

https://{company}.bluecamroo.com/api/group/update

HTTP Method

PUT

Parameters

A group object.

Data Return

Returns the group object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Delete

Description

Deletes the specified user group. The group to delete is specified by Id value.

URL

https://{company}.bluecamroo.com/api/group/delete/{id}

HTTP Method

DELETE

Parameters

None

Data Return

None

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)