|
Document
An object representing a document in a folder in company documents.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
ID |
integer |
ID of the Document. |
|
Name |
string (100) |
Name of the Document. |
|
Description |
string (100) |
Document description. |
|
OwnerId |
integer |
The ID of the user who owns this object. |
|
URL |
string (100) |
URL to the document. |
|
LastModifiedDate |
DateTime |
Date the last time the object was modified. |
|
ContentLength |
integer |
Document length in bytes. |
|
ContentType |
string (100) |
Stores the documents' content type (application/pdf, image/gif, etc.) |
|
Extension |
string (100) |
Stores the document's 3 or 4 letter extension: jpg, doc, txt, etc. |
Get
Description
Returns the specified Document.
URL
https://{company}.bluecamroo.com/api/Document/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the Document object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an Document. Adds an Document by passing an Document object.
URL
https://{company}.bluecamroo.com/api/Document/add/AddDocument
HTTP Method
POST
Parameters
An Document object
Data Return
Returns the Document 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)
Example
A document s submitted using multipart/form-data:
Update
Description
Pass an Document object to replace one or more Document details with the matching value.
URL
https://{company}.bluecamroo.com/api/Document/update
HTTP Method
PUT
Parameters
An Document object
Data Return
Returns the Document 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 Document based on the passed ID number.
URL
https://{company}.bluecamroo.com/api/Document/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)
|