Project

An object representing a project. A project is a child of an organization object or a person object. In either case these objects must be flagged as customers.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

Id

integer

A unique ID for the project object. When adding a new project the value must be 0.

Name

string (100)

Name of the project.

ParentId

integer

ID of the parent organization.

ParentObject

string (100)

ParentObject identifies what kind of object the Project object is a child of. Value is account (if it's an organization).

ProjectTemplateId

integer

ID of the template used for the project. Optional. This value can be null.

Description

string (100)

Text for the project's description field.

Amount

double

Text for the project's amount field. Optional. This value can be null.

Subtotal

double

Text for the project's subtotal field. This value is optional.

TaxTotal

double

Text for the project's invoice amount field. Optional. This value can be null.

CurrencyIsoCode

string (100)

Three letter currency code for display on the project details page.

PriceBookId

integer

ID of the price book used by this project. Optional. This value can be null.

Status

integer

ID to set the project's Status drop-down box. Value should be equal to a ProjectStatus object's ID field.

CategoryId

integer

ID to set the project's Project Category drop-down box. Value should be equal to a ProjectCategory object's ID field. Optional. This value can be null.

OwnerId

integer

The ID of the user who owns this object.

CreatedBy

integer

ID of the user who created this project.

LastModifiedBy

integer

ID of the user who last modified this project.

IsLocked

boolean

Flag to indicate the project cannot be edited.

IsClosed

boolean

Flag to indicate the project has been completed and closed.

Owner

string (100)

Name of the user who owns this case.

CreationDate

DateTime

Indicates when this object was created.

LastModifiedBy

integer

ID of the user who last modified the object.

LastModifiedDate

DateTime

Date the last time the object was modified.

Permission

string (100)

The permissions (write, read, none) the user has to this record.

IsWatched

boolean

Flag to indicate this record's update stream is watched.

ReviewDate

DateTime

Date and time this record needs to be reviewed.

RelatedParentId

integer

ID of the object this project is related to (a person or organization).

RelatedParentObject

string (100)

Indicate if the parent is an account (if it's an organization) or person object.

EstimatedStartDate

DateTime

Date and time this project should be started.

EstimatedCompletionDate

DateTime

Date and time this project should be completed.

ActualStartDate

DateTime

Date and time this project was started.

ActualCompletionDate

DateTime

Date and time this project was completed.

Permission

string (100)

The permissions (write, read, none) the user has to this record.

Get

Description

Returns details of a specified project.

URL

https://{company}.bluecamroo.com/api/project/get/{id}

HTTP Method

GET

Data Return

Returns the project 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 object.

URL

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

HTTP Method

POST

Parameters

A project object

Data Return

Returns the project 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 updates a project object.

URL

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

HTTP Method

PUT

Parameters

A project object

Data Return

Returns the project 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 project.

URL

https://{company}.bluecamroo.com/api/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)