Octane REST API
  1. Appointment
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
        GET
      • Book Appointment
        POST
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Appointment

Book Appointment

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
POST
https://benzine.telcoinabox.com/tiab/api
/v1/appointment
Book a new appointment or reschedule an existing one for an NBN order

Request

Body Params application/json
appointmentRequestId
string 
required
The unique appointmentRequestID returned for the preceding Query Appointment Timeslots call
slotId
string 
required
The unique Appointment Slot ID returned on the preceding Query Appointment Timeslots call.
Example
{
    "appointmentRequestId": "string",
    "slotId": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/appointment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appointmentRequestId": "string",
    "slotId": "string"
}'

Responses

🟢200OK
application/json
Body
slotId
string 
optional
The Carrier ID of the Appointment Timeslot - this ID is used when booking a new appointment
nbnAppointmentId
string 
optional
The NBN identifier of the appointment.
slotType
enum<string> 
optional
Type of timeslot. Note: For typical AVC connections, only AM or PM should be selected. Other options may incur additional charges.
Allowed values:
AMPMAHACA
startTime
string 
optional
The start time of the appointment timeslot. Start time is returned in UTC timezone format - Timezone offset should be applied to get exact Appointment Time for Customer’s location.
endTime
string <date-time>
optional
The end time of the appointment timeslot. Start time is returned in UTC timezone format - Timezone offset should be applied to get exact Appointment Time for Customer’s location.
timezoneOffset
string 
optional
Represents the Timezone offset for the timeslot based on location (different offset will apply depending on state).
priorityAssist
string 
optional
Indicates whether the appointment is for a priority assistance customer or not
eSla
enum<string> 
optional
The level of restoration SLA that the appointment will have
Allowed values:
StandardAcceleratedPriorityAssistReducedLeadTime
demandType
enum<string> 
optional
Indicates whether the End User will be required on premises for the appointment or not
Allowed values:
StandardAcceleratedPriorityAssistReducedLeadTime
contact
object 
optional
Contact details for the appointment
name
string 
optional
The name of the contact person for the appointment
type
string 
optional
The type of the contact person for the appointment
phone
string 
optional
The phone number of the contact person
notes
string 
optional
Additional installation notes, if any
bookedOn
string <date-time>
optional
Datetime of when the appointment was booked
Example
{
    "slotId": "string",
    "nbnAppointmentId": "string",
    "slotType": "AM",
    "startTime": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "timezoneOffset": "string",
    "priorityAssist": "string",
    "eSla": "Standard",
    "demandType": "Standard",
    "contact": {
        "name": "string",
        "type": "string",
        "phone": "string",
        "notes": "string"
    },
    "bookedOn": "2019-08-24T14:15:22Z"
}
🟠403Invalid access
Modified at 2024-04-17 03:15:03
Previous
Query Appointment Timeslots
Next
Get Available Diagnostic Tests
Built with