ProjectShare

An object that represents a sharing condition for a project.

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

Object Properties

Property

Type

Description

ProjectAccessLevel

string (100)

Sets the user's access to the Project. Can be None, View Only, or Full Access.

LineItemAccessLevel

string (100)

Sets the user's access to the list of products associated with this Project. Can be None, View Only, or Full Access.

ContactRoleAccessLevel

string (100)

Sets the user's access to the Project's contact role page. Can be None, View Only, or Full Access.

MilestoneAccessLevel

string (100)

Sets the user's access to the Project's stages page. Can be None, View Only, or Full Access.

ShareFileAccessLevel

string (100)

Sets the user's access to the Project's attachments page. Can be None, View Only, or Full Access.

List

Description

Returns a list of shares associated with the specified Project

URL

https://{company}.bluecamroo.com/api/ProjectShare/list?Projectid={Projectid}

HTTP Method

GET

Parameters

None

Data Return

Returns a list of ProjectShare objects specified by Projectid in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

401: Not authorized (you need to log in)

Get

Returns details for the specified share.

URL

https://{company}.bluecamroo.com/api/ProjectShare/get/{id}?ProjectId={ProjectId}

HTTP Method

GET

Parameters

None

Data Return

Returns the ProjectShare 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 sharing condintion.

URL

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

HTTP Method

POST

Parameters

An ProjectShare object

Data Return

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

URL

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

HTTP Method

PUT

Parameters

A ProjectShare object

Data Return

Returns the ProjectShare 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 share.

URL

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