AppointmentSlotEnquiryRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telstra/main/json-schema/telstra-appointment-slot-enquiry-request-schema.json",
  "title": "AppointmentSlotEnquiryRequest",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telstra-field-workforce-partners-api-openapi.yml#/components/schemas/AppointmentSlotEnquiryRequest",
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "An optional identifier for this transaction generated by the consumer (such as a random UUIDv4 string). If not supplied the WFM Partner Gateway will generate its own value.\n"
    },
    "data": {
      "type": "object",
      "description": "A grouping object holding the main details of the request body\n",
      "properties": {
        "scenario": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "A field which indicates whether this request relates to a new or reschedule case.\n",
          "enum": [
            "NEW",
            "RESCHEDULE"
          ]
        },
        "transactionReferenceID": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "A traceable partner provided reference related to this appointment request. For example an order number, ticket number or similar. Mandatory when scenario = NEW\n"
        },
        "serviceOffering": {
          "type": "object",
          "description": "An object holding the Telstra service offering details being requested by the partner. Mandatory when scenario = NEW\n",
          "properties": {
            "serviceCatalogue": {
              "type": "object",
              "description": "An object holding the details of the service catalogue related to this offering.\n",
              "properties": {
                "name": {
                  "type": "string",
                  "maxLength": 255,
                  "minLength": 1,
                  "description": "The name of the catalogue instance within the Telstra service catalogue.\n"
                }
              },
              "required": [
                "name"
              ]
            },
            "serviceCandidate": {
              "type": "array",
              "minItems": 1,
              "description": "An array holding the service candidates under the catalogue being requested. For a simplex appointment type a max of two items will be supported. For complex/bundle requests only one is allowed.\n",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "maxLength": 255,
                    "minLength": 1,
                    "description": "The name of service candidate.\n"
                  }
                },
                "required": [
                  "name"
                ]
              }
            }
          },
          "required": [
            "serviceCatalogue",
            "serviceCandidate"
          ]
        },
        "place": {
          "type": "object",
          "description": "An object which defines the location of the appointment visit. Mandatory when scenario = NEW\n",
          "properties": {
            "type": {
              "type": "string",
              "maxLength": 20,
              "minLength": 1,
              "description": "The type of address input.\n",
              "enum": [
                "TELSTRA ADDRESS ID"
              ]
            },
            "id": {
              "type": "string",
              "maxLength": 20,
              "minLength": 1,
              "description": "The Telstra address ID. Mandatory when place > type = TELSTRA ADDRESS ID\n"
            }
          },
          "required": [
            "type",
            "id"
          ]
        },
        "appointmentCategory": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The category of the appointment. Mandatory when scenario = NEW\n"
        },
        "appointmentType": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The type of appointment under the category. Mandatory when scenario = NEW\n"
        },
        "appointmentSubType": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The sub type of the appointment under the category/type. Mandatory when scenario = NEW\n"
        },
        "priority": {
          "type": "string",
          "maxLength": 20,
          "minLength": 1,
          "description": "Indicates the priority of the request. Common values are recorded below, but individual partners may be given additional bespoke values outside of this list.\n",
          "enum": [
            "STANDARD"
          ]
        },
        "searchStartDate": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50,
          "format": "yyyy-MM-dd'T'HH:mm:ss",
          "description": "The earliest date/time from which available appointments should be searched in Australia/Sydney time. Value must be a future date/time.\n"
        },
        "timeFilter": {
          "type": "string",
          "maxLength": 10,
          "minLength": 1,
          "description": "Allows indication of the time bracket if applicable. If there is no time bracket requirement then the field should not be sent.\n",
          "enum": [
            "AM",
            "PM"
          ]
        },
        "appointmentID": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The existing appointmentID to be rescheduled. Mandatory when scenario = RESCHEDULE\n"
        },
        "rescheduleReasonCode": {
          "type": "string",
          "maxLength": 2,
          "minLength": 1,
          "description": "The code indicating the reason for the reschedule being required. Mandatory when scenario = RESCHEDULE\n",
          "enum": [
            "51 (Request date change by customer or partner)",
            "61 (Telstra Technician was not available)"
          ]
        }
      },
      "required": [
        "scenario",
        "priority",
        "searchStartDate"
      ]
    }
  },
  "required": [
    "data"
  ]
}