Webex · Schema

queryRegistrants

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
status string Registrant's status. * `approved` - Registrant has been approved. * `pending` - Registrant is in a pending list waiting for host or cohost approval. * `rejected` - Registrant has been rejected by the
orderType string Sort order for the registrants.
orderBy string Registrant ordering field. Ordered by `registrationTime` by default. * `firstName` - Registrant's first name. * `lastName` - Registrant's last name. * `status` - Registrant's status. * `email` - regis
emails array List of registrant email addresses.
View JSON Schema on GitHub

JSON Schema

webex-queryregistrants-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/queryRegistrants",
  "title": "queryRegistrants",
  "type": "object",
  "required": [
    "emails"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "approved",
        "pending",
        "rejected"
      ],
      "description": "Registrant's status.\n * `approved` - Registrant has been approved.\n * `pending` - Registrant is in a pending list waiting for host or cohost approval.\n * `rejected` - Registrant has been rejected by the host or cohost.\n"
    },
    "orderType": {
      "type": "string",
      "enum": [
        "DESC",
        "ASC"
      ],
      "description": "Sort order for the registrants."
    },
    "orderBy": {
      "type": "string",
      "enum": [
        "firstName",
        "lastName",
        "status",
        "email"
      ],
      "description": "Registrant ordering field. Ordered by `registrationTime` by default.\n * `firstName` - Registrant's first name.\n * `lastName` - Registrant's last name.\n * `status` - Registrant's status.\n * `email` - registrant's email.\n"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "[email protected]"
      },
      "description": "List of registrant email addresses."
    }
  }
}