Before you use the API, the following must be considered:
- Bold360 API currently has two versions, v1 and v2. This documentation covers version 1 and makes special note whenever version 2 differs from version 1 specifications.
- Strings are UTF-8 encoded.
- The language of strings returned by the API are in U.S. English, unless otherwise specified by the language parameter of methods that support it. The language parameter must be an ISO 639-1 language code, optionally followed by a dash and the ISO 3166-1 country code, such as en-US for U.S. English. If an unrecognized or unsupported language code is passed as parameter, the returned string value defaults to the U.S. English variant.
- Field Types
- All data retrieval methods support an extra parameter called IncludeFieldTypes. If this parameter is set to true, the response will include an extra value called FieldTypes, detailing the type for each value of the response and a maximum length (if set).