|
ExtraField
An object that represents an extra field.
Supported API Calls: List | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique Id value for the ExtraField object. When adding a new ExtraField the value must be 0. |
|
FieldType |
string (100) |
The type of table cell. Can be: text, textarea, checkbox, radio, selection, or date |
|
Size |
integer |
Fields size in pixels. This value is optional. |
|
Row |
integer |
Fields size in pixels. This value is optional. |
|
Col |
integer |
Fields size in pixels. This value is optional. |
|
IsRequired |
boolean |
If true, the extrafield is required. |
|
NumberOfColumn |
integer |
If you've selected checkbox or radio fields, enter how many columns you wish to display your fields in. This value is optional. |
|
SortOrder |
integer |
Sorting order of the lookup value. This can be null. Read only. |
|
AssociateObject |
string (100) |
Object this extrafield is available for. Values can be: User, Lead, Account (if it's an organization), Person, Contact, Opportunity, Project, Case, Time Sheet |
|
Section |
string (100) |
Indicates what section of the object's details page the extrafield should go. Values: |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the extrafield object is a child of. Values are lead, account (if it's an organization), contact, opportunity, project, case, user, timesheet |
|
ExtraFieldDescList |
List<ExtraFieldDesc> |
A list of ExtraFieldDesc objects. |
|
ExtraFieldOptionList |
List<ExtraFieldOption> |
A list of ExtraFieldOption objects. |
List
Description
Returns a list of extra fields for a specified object type (e.g., lead, organization, etc.)
URL
https://{company}.bluecamroo.com/api/extrafield/list?ParentObject={ParentObject}
HTTP Method
GET
Parameters
None
Data Return
Returns the extrafield list for the parent 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 the extra field to an object type's list of extra fields.
URL
https://{company}.bluecamroo.com/api/extrafield/add
HTTP Method
POST
Parameters
An extrafield object
Data Return
Returns the extrafield in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
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)
Update
Description
Updates a specified extrafield.
URL
https://{company}.bluecamroo.com/api/extrafield/update
HTTP Method
PUT
Parameters
An extrafield object
Data Return
Returns the extrafield 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 extra field.
URL
https://{company}.bluecamroo.com/api/extrafield/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)
|