Home > API Fields


API Fields

Formatting Restrictions

Unless otherwise noted, all of the field names listed are case sensitive, and the fields accept special characters such as @, #, and %.

The values of the item_#_ fields must not contain carets (^) or colons (:), because these characters are reserved for use by the ICS services. The values of all request fields must not contain newlines or carriage returns. However, they can contain embedded spaces and any other printable characters. All leading and trailing spaces are removed.

Data Type Definitions

 

For more information about these data types, see the World Wide Web Consortium (W3C) XML Schema Part 2: Datatypes Second Edition.

Table 16Data Type Definitions

Data Type

Description

Date and time

Format is YYYY-MM-DDThh:mm:ssZ, where:

nT separates the date and the time

nZ indicates Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT)

Example  2020-01-11T22:47:57Z equals January 11, 2020, at 22:47:57 (10:47:57 p.m.).

Integer

Whole number {..., -3, -2, -1, 0, 1, 2, 3, ...}

String

Sequence of letters, numbers, spaces, and special characters