Data Types {#types}

In general, we adhere to JSON standards for encoding both the input and output data types:

  • String: "Double quotes and \" escaping"
  • Array: [1,2,3,4,5]
    • All elements should be the same type
    • INCORRECT: [1,2,3,4,"five"]
    • CORRECT: ["1","2","3","4","five"]
  • Object: {"key":"value","foo":"bar"}
  • Boolean: true or false

Other types:

  • Date: "2012-02-01"
  • Date Range: ["2012-02-01", "2012-02-08"]
  • Time: 13:49:28 GMT-0500"
  • DateTime: "2012-02-01 13:49:28 GMT-0500"
  • DateTime Range: ["2012-02-01 13:49:28 GMT-0500","2012-02-08 03:00:00 GMT-0500"]

CUID

A Core Unique Identifier (CUID) is a simple way to identify an object. It is an identifying number with a one or two letters type prefix that specifies the type of the object. For example, T48175 is a Ticket object with an ID of 48175.

You will be passing CUIDs back and forth to communicate with our API about the objects you are interested in. Below is a list of CUID object type prefixes:

  • CC – Credit card
  • D – Domain
  • H – Hosting package
  • I – Invoice
  • L – Software License
  • R – Reboot request
  • S – Server
  • T – Ticket
  • TR – Ticket response
  • V – VPS