Skip to main content
Aria Knowledge Central

Forming JSON API Calls

Overview

Aria Core and Object Query API calls accept well-formed JSON input that is compliant with Aria's API schema.

  • Aria Billing Cloud API: All Core, Object Query, and Admintools API call specifications are documented on Knowledge Central with guides presenting key usage notes and use case guidance, and JSON sample calls and responses.

    Note: Admintools API calls do not support JSON input. You can test these APIs using Aria's API Live.

  • Swagger SDK: Aria provides a Swagger file, in the JSON format, to generate an SDK in your preferred programming language. A new Swagger file is generated for each Aria release. This can help to rapidly develop custom applications that integrate with Aria, in several different programming languages, that format data into JSON inputs to the Aria API out of the box.
  • json.org: If you plan to develop your own code to integrate with Aria, you can refer to json.org to understand how to properly format API calls.

Code Sample

Below is a formatted create_order JSON call:

{
    "rest_call": "create_order_m",
    "output_format": "json",
    "client_no": 1234,
    "auth_key": "(not displayed)",
    "do_write": "false",
    "bill_immediately": 1,
    "acct_no": 2345,
    "plan_instance_no":3456 ,
    "order_line_items": [
        {"client_sku":"Taxable Order", "units": 3},
        {"client_sku":"Taxable Order", "units": 4}
    ]
}
TOP
  • Was this article helpful?