Folder

An object representing a company documents folder.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

Id

integer

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

Name

string (100)

Name of the folder.

NumberOfDocument

integer

Number of documents in the folder.

DocumentList

List<Document>

A list of document objects associated with the folder.

Get

Description

Returns the specified Folder.

URL

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

HTTP Method

GET

Parameters

None

Data Return

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

HTTP Return Status Code

200: OK

401: Not authorized (you need to log in)

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

Add

Description

Adds an Folder. Adds an Folder by passing an Folder object.

URL

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

HTTP Method

POST

Parameters

An Folder object

Data Return

Returns the Folder 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 an Folder object to replace one or more Folder details with the matching value.

URL

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

HTTP Method

PUT

Parameters

An Folder object

Data Return

Returns the Folder 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 Folder based on the passed ID number.

URL

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