Common Data Types

Standard data types and formats used across Open Access Forum APIs.

Identifiers

UUID

• Format: UUID
• Example: 123e4567-e89b-12d3-a456-426614174000
• Usage: Resource identifiers, event IDs

Timestamps

ISO 8601 DateTime

• Format: YYYY-MM-DDTHH:mm:ssZ
• Example: 2025-06-08T14:22:00Z
• Usage: All timestamp fields
• Note: Always use UTC time with Z suffix

ISO 8601 Date

• Format: YYYY-MM-DD
• Example: 2025-06-08
• Usage: Date-only fields (e.g., availableDate)
• Note: The date should represent the date in UTC time.

Enumerations

All enumerations use UPPER_CASE format.

General Rules

• Use descriptive names
• Avoid abbreviations unless widely understood
• Include other when list may expand
• Document all possible values

Null Values

• Omit optional fields rather than including null values
• If field must be included, use null not "null" or empty string