Overview
The underlying basic data types used in the WSDL, can have different interpretations depending on context. For example, text, textarea, email, phone number, enum, and autonumber are all different types of string fields. The possible interpretations of the basic WSDL data types are provided on the following table.
Field Types and Descriptions
All field names are case sensitive.
| Field Type | Base Type | Interpretation |
|---|---|---|
| autonumber | string | When there is an autonumber field, you don’t need to specify a value. Instead, the system automatically generates a number for you based on your administrator settings. If you do specify a value, then it will validate your specified values for consistency against the system definition. |
| boolean | boolean | A boolean value is either 'true' or 'false'. The numbers 1 (true) and 0 (false) may also apply. |
| currency | float | All currency fields are of type float. |
| date | date | Format: YYYY-DD-MM |
dateTime | dateTime | In Emersion, dates change at midnight (12:00 AM), which is considered to be the beginning of the day. For example, an account invoice period of time that extends from January 1 through February 1 begins at midnight January 1 (immediately after 11:59 PM, December 31), and ends at midnight on February 1 (immediately after 11:59 PM, January 31) is one day. |
| string | Email fields contain email addresses. It is your responsibility to specify valid and properly formatted email addresses in your calls. | |
| enum | string | This type is a string that is restricted to a certain set of values. The set depends on the field and the object context. All enum fields are case sensitive. |
| id | ID | All objects in the API have an ID field. This field is inherited from the object. The ID is a unique identifier for each record in an object. Some ID fields are automatically generated or updated by the system. |
| int | int | An int (integer) data type is a whole number without a decimal point or any value that would follow a decimal point. The value 1, for example, is an integer; 1.0 and 1. are not. An integer can be a negative number. |
| phone | string | Phone fields contain telephone numbers, which can include alphabetic characters. As with the email fields, it is your responsibility to format phone numbers. |
| quantity | float | all quantity fields are of type float. |
| text | string | A string value. The size varies with the field and object context |
| textarea | string | A textarea field is a string that is displayed as a multiline text field. it can contain more than 4,000 bytes of text. |
Required and Optional Indicators
Some fields are marked required, and the rest are marked optional. Whether or not a field is required is from the perspective of you, as the API user, not the perspective of the database. Therefore, a required field is a field that requires your input in every call of the object.
For most objects, only a few fields are required.
Emersion IDs
Emersion IDs, including the account ID, service subscription ID, service ID, product ID and all other IDs in the system, are unique values that are used as Primary Keys for objects. The IDs are generated by Emersion.