ExtraObjectField

An object that represents a BlueCamroo ExtraObjectField.

Object Properties

Property	Type	Description
Id	integer	A unique ID for the ExtraObjectField. When adding a new ExtraObjectField object the value must be 0.
ExtraId	integer	The ID of the parent ExtraObject.
Name	string (100)	Enter this field's name for use in the database index.
FieldLabel	string (100)	Enter the label describing the field to the user.
DataType	string (100)	Enter the field's data type. Values: string, integer, date, Boolean, double
DataSize	integer	If you select String, you can use Data Size to limit the length of the input. For example, if you want to limit input to no more than 12 characters, enter a 12. This value is optional.
DisplayInResult	boolean	If false, this field will not display to the user.
IsRequired	boolean	Flag that indicates the field is required for user input.
IsFieldCreated	boolean	Flag indicating the field has been created.
FieldType	string (100)	The field type. Values are: Text, Textarea, Checkbox, Radio, Select, Date
Size	integer	If you field is a Text field, enter how many characters across the field should display. This value is optional.
Row	integer	If the field is a Textarea, enter the Row's height in characters. This value is optional.
Col	integer	If the field is a Textarea, enter the area's width in characters. This value is optional.
NumberOfColumn	integer	How many columns you wish to display your fields in. This value is optional.
SortOrder	integer	Sorting order of the field. This can be null.
ExtraFieldOptionList	List<ExtraFieldOption>	A list of field options and their values.

List

Description

Returns a list of all extra object fields.

URL

https://{company}.bluecamroo.com/api/ExtraObjectField/list

HTTP Method

GET

Data Return

Returns the list of ExtraObjectFields 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)

List</h1>

Description

Lists the actual objects in use by a particular record.

URL

http://{company}.bluecamroo.com/api/ExtraObjectField/list?extraId={extraId}&parentId={parentId}&parentObject={parentObject}

HTTP Method

GET

Parameters

None

Data Return

Returns the list of extra objects in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

401: Not authorized (you need to log in)

Get

Description

Returns the details of a single extra object.

URL

https://{company}.bluecamroo.com/api/ExtraObjectField/get/{id}?extraId={extraId}

HTTP Method

GET

Parameters

None

Data Return

Returns an ExtraObjectField in use for the ID of the parent object and the type of ExtraObjectField as identified by extraID (the ID of the extra object type) 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 the extra object.

URL

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

HTTP Method

POST

Parameters

An ExtraObjectField object

Data Return

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

URL

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

HTTP Method

PUT

Parameters

An ExtraObjectField object.

Data Return

Returns the ExtraObjectField 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 Extra Object based on the id (of the parent object) and extraID (id of the ExtraObjectField type).

URL

https://{company}.bluecamroo.com/api/ExtraObjectField/delete/{id}?extraid={extraid}

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)