Skip to main content

​
File Naming Convention

All field names follow the snake_case format:
<descriptive_term>_<type_or_context>
  • Use lowercase letters only.
  • Words are separated by underscores (_).
  • Examples:
    • received_date
    • user_name
    • is_active
    • status_enum
This consistent naming ensures readability and clarity across all API fields.

​
Supported Data Types

​
1. text

  • Description: A string of characters.
  • Example: "Hello, world!"

​
2. yes/no

  • Description: A boolean value representing a binary choice.
  • Accepted Values: true / false (or yes / no, depending on context)
  • Example: true

​
3. number

  • Description: Any numeric value, including integers and floats.
  • Example: 42, 3.14

​
4. date-time

  • Description: A date and time string in ISO 8601 format.
  • Format: YYYY-MM-DDTHH:MM:SSZ
  • Example: "2025-06-12T14:30:00Z"

​
5. enum

  • Description: A predefined set of string values. Use this type when the value must be one of a known set, where status can be one of: “pending”, “approved”, “rejected”
  • Example: JSON 
    {
  "status": "pending"
}