ADT · JSON Structure

Platform Api Access Code Input Structure

Request to create an access code.

Type: object Properties: 4 Required: 3
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

AccessCodeInput is a JSON Structure definition published by ADT, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name code type expiresAt

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-structure/platform-api-access-code-input-structure.json",
  "name": "AccessCodeInput",
  "description": "Request to create an access code.",
  "type": "object",
  "required": [
    "name",
    "code",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the access code.",
      "example": "Contractor Code"
    },
    "code": {
      "type": "string",
      "description": "The numeric access code (4-8 digits).",
      "example": "5678"
    },
    "type": {
      "type": "string",
      "description": "Type of access code.",
      "enum": [
        "standard",
        "temporary"
      ],
      "example": "temporary"
    },
    "expiresAt": {
      "type": "datetime",
      "description": "Expiration time for temporary codes.",
      "example": "2025-03-20T23:59:59Z"
    }
  }
}