|
ProjectContactRole
An object that represents a contact role for a project.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the ProjectContactRole object. When adding a new ProjectContactRole the value must be 0. |
|
ProjectId |
integer |
The ID for the parent project object. |
|
ContactId |
integer |
The ID for the contact ID that is given a role. |
|
Role |
string (100) |
ID to set the contact role's Role drop-down box. Value should be equal to a ContactRole object's ID field. |
|
IsPrimary |
boolean |
Flag that indicates the contact role is the primary contact. |
|
ReceiveInvoiceEmail |
boolean |
Flag that indicates the contact role is the contact that receives invoices. |
|
Contact |
Contact |
A contact object representing the contact assigned the role. |
|
RoleName |
string (100) |
Name of the contact assigned the role. |
List
Description
Returns a list of contract roles associated with the Project.
URL
https://{company}.bluecamroo.com/api/projectcontactrole/list?{projectid}
HTTP Method
GET
Parameters
None
Data Return
Returns the list of contact roles 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 details for the specified contact role.
URL
https://{company}.bluecamroo.com/api/Projectcontactrole/get/{id}?ProjectId={ProjectId}
HTTP Method
GET
Parameters
None
Data Return
Returns the Projectcontactrole 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 a Project's contact role.
URL
https://{company}.bluecamroo.com/api/projectcontactrole/add
HTTP Method
POST
Parameters
A projectcontactrole object
Data Return
Returns the projectcontactrole 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
Updates a projectcontactrole object.
URL
https://{company}.bluecamroo.com/api/projectcontactrole/update
HTTP Method
PUT
Parameters
A projectcontactrole object
Data Return
Returns the projectcontactrole 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 contract role associated with the Project.
URL
https://{company}.bluecamroo.com/api/projectcontactrole/delete/{id}?ProjectId={ProjectId}
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)
|