Flag

Use the Flag (XML API) or oaSwitch (SOAP API) object to read, add or update company or user settings.

The XML API and SOAP use the Flag (XML API) or oaSwitch (SOAP API) object as a substructure to pass company or user setting information when reading, adding or updating the Company record or User records.

XML

SOAP

REST

Database table

Object

Flag

oaSwitch

switch

The Flag (XML API) or oaSwitch (SOAP API) object has the following properties:

XML

SOAP

Database

Description

id

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

name

name

name

The name of the switch setting.

setting

setting

setting

The contents of the switch setting. A zero length field is considered 'undef'.