|
User
The user object is used to represent either an internal or external user in BlueCamroo.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
ID |
integer |
Unique ID for a User object. When adding a new User object the value must be 0. |
|
DisplayName |
string (100) |
The name to display in BlueCamroo. |
|
Name |
string (100) |
The name of the user. |
|
Username |
string (100) |
The email of the user. The email is used to login. |
|
Password |
string (100) |
The password for the user. (This can be set via an ADD or UPDATE but any user object returned via the API will not include the password.) |
|
JobTitle |
string (100) |
The title of the user's job |
|
Department |
integer |
An ID for a Department lookup value. This is optional. |
|
Manager |
integer |
ID of the internal user who is this user's manager. This is optional. |
|
EmployeeNumber |
string (100) |
User's employee number |
|
LanguageLocaleKey |
string (100) |
What the display language should be used for this user. Values are: |
|
TimeZoneKey |
string (100) |
Which time zone should be used for this user. Values are: |
|
ContactId |
integer |
If this is an external user, the ID of the contact it represents. This value is optional. |
|
IsActive |
boolean |
A flag to indicate if the internal user is active (i.e., user can login, this user will count towards your user limit). |
|
IsExternal |
boolean |
A flag to indicate this is an external user. |
|
LastLoginDate |
DateTime |
Optional. The user's last login date. This value is optional. |
|
DefaultBillingGrade |
integer |
An ID representing a billingrade object. This value is optional. |
|
Person |
Person |
A Person object. |
|
PriceBookId |
integer |
An ID representing a pricebook object. This value is optional. |
|
ProfileImage |
string (100) |
File URL portion to profile image (portion if preceded with http://{company name}.bluecamroo.com/) |
|
EmailAddressList |
List<EmailAddress> |
A user object can be associated with multiple email addresses. The user's email addresses are stored as a list of EmailAddress objects. |
|
PhoneList |
List<Phone> |
A user object can be associated with multiple phone numbers. The user's phone numbers are stored as a list of Phone objects. |
|
UserLinkList |
List<UserLink> |
A list of UserLink objects, for example a list of address objects. |
List
Description
Returns a list of users, either internal or external. Specify IsExternal as true for a list of external user. Specify as false for a list of internal users.
URL
https://{company}.bluecamroo.com/api/user/list?IsExternal={IsExternal}&isActive={isActive}
HTTP Method
GET
Parameters
None
Data Return
Returns the list of user (internal or external as specified) 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 user specified by the passed id.
URL
https://{company}.bluecamroo.com/api/user/get/{id}
HTTP Method
GET
Parameters
None.
Data Return
Returns the user 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 user object to the list of users in BlueCamroo.
URL
https://{company}.bluecamroo.com/api/user/add
HTTP Method
POST
Parameters
A user object.
Data Return
Returns the user 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 user object to replace the specified user.
URL
https://{company}.bluecamroo.com/api/user/update
HTTP Method
PUT
Parameters
A user object.
Data Return
Returns the user 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. The user to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/user/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)
|