Octane REST API
  1. Other Rated Order
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
      • Book Appointment
    • 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
            POST
          • Change Access of an Other Rated Service
            POST
        • Create an Order
          POST
        • Cancel an Order
          POST
        • Query an Order
          POST
        • Reset an Order
          POST
      • 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. Other Rated Order

Create an Other Rated Service

Testing Env
https://benzine.telcoinabox.com/tiab
Testing Env
https://benzine.telcoinabox.com/tiab
POST
https://benzine.telcoinabox.com/tiab
/tiab/UtbOrder
order

UtbOrder:orderCreate#

This service is to be exposed by the Octane application. This service will be used by external systems such as the Service Provider and other Telcoinabox systems/sites to create a new Other Rated ServiceType on a customer account in Octane.
This Octane service will be exposed as a SOAP message via the UtbOrder WSDL.

Request

Header Params
Content-Type
string 
required
Example:
text/xml; charset=utf-8
Body Params application/xml
Body
object 
required
orderCreate
object 
required
Example
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ord:orderCreate xmlns:ord="http://order.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <createRequest>
        <custNo>-42963058</custNo>
        <orderType>SRVC_ORD</orderType>
        <orderAction>ORS_ADD_NEW</orderAction>
        <custReqDate>2024-03-04T09:15:26.196Z</custReqDate>
        <orderItems>
          <orsNewReqItem>
            <serviceNumber>0288884444</serviceNumber>
            <name>Joe Bloggs</name>
            <department>Sales Team</department>
            <lineType>R</lineType>
            <serviceId>NR</serviceId>
            <planNo>123456</planNo>
            <orderNotes>Some notes here</orderNotes>
            <orderItemAddress>
              <additionalAddress>Hunter Building</additionalAddress>
              <subAddressType>L</subAddressType>
              <subAddressNumber>10</subAddressNumber>
              <streetNumber>9</streetNumber>
              <streetNumberSuffix>A</streetNumberSuffix>
              <streetName>HUNTER</streetName>
              <streetType>ST</streetType>
              <streetSuffix>E</streetSuffix>
              <locality>SYDNEY</locality>
              <postcode>2000</postcode>
            </orderItemAddress>
          </orsNewReqItem>
        </orderItems>
      </createRequest>
    </ord:orderCreate>
  </soapenv:Body>
</soapenv:Envelope>

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/tiab/UtbOrder' \
--header 'Content-Type: text/xml; charset=utf-8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ord:orderCreate xmlns:ord="http://order.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <createRequest>
        <custNo>-42963058</custNo>
        <orderType>SRVC_ORD</orderType>
        <orderAction>ORS_ADD_NEW</orderAction>
        <custReqDate>2024-03-04T09:15:26.196Z</custReqDate>
        <orderItems>
          <orsNewReqItem>
            <serviceNumber>0288884444</serviceNumber>
            <name>Joe Bloggs</name>
            <department>Sales Team</department>
            <lineType>R</lineType>
            <serviceId>NR</serviceId>
            <planNo>123456</planNo>
            <orderNotes>Some notes here</orderNotes>
            <orderItemAddress>
              <additionalAddress>Hunter Building</additionalAddress>
              <subAddressType>L</subAddressType>
              <subAddressNumber>10</subAddressNumber>
              <streetNumber>9</streetNumber>
              <streetNumberSuffix>A</streetNumberSuffix>
              <streetName>HUNTER</streetName>
              <streetType>ST</streetType>
              <streetSuffix>E</streetSuffix>
              <locality>SYDNEY</locality>
              <postcode>2000</postcode>
            </orderItemAddress>
          </orsNewReqItem>
        </orderItems>
      </createRequest>
    </ord:orderCreate>
  </soapenv:Body>
</soapenv:Envelope>'

Responses

🟢200orderCreate response
application/xml
Body
Body
object 
required
orderCreateResponse
object 
required
Examples
<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header />
   <S:Body>
      <ns2:orderCreateResponse xmlns:ns2="http://order.frontend.ws.utilibill.com.au/">
         <return>
            <errorCode>0</errorCode>
            <orderId>74705</orderId>
         </return>
      </ns2:orderCreateResponse>
   </S:Body>
</S:Envelope>
Modified at 2024-03-04 12:19:33
Previous
Configure Business SIP Trunk
Next
Change Access of an Other Rated Service
Built with