Asynchronous Usage Event Processing

Submits usage for rating asynchronously.

For more information, please search through the Gotransverse online documentation:

Request Content-Types: application/json
Response Content-Types: application/json
Version: 2.0.0

Callback Management

GET /callbacks

Gets the list of current callbacks

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "callback_type_key": "string",
    "callback_url": "string",
    "callback_username": "string",
    "callback_headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
X-Elements-Count

The total results returned in this request. Used to drive paging requests.

integer (int64)
X-Total-Pages

The total pages available for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /callbacks

Adds a new callback

The callback to create

Request Content-Types: application/json
Request Example
{
  "callback_type_key": "string",
  "callback_url": "string",
  "callback_username": "string",
  "callback_headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "callback_type_key": "string",
  "callback_url": "string",
  "callback_username": "string",
  "callback_headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /callbacks/{callback_type_key}

Updates a callback

The callback to update

callback_type_key: string EVENT_BULK
in path

The callback key to update

Request Content-Types: application/json
Request Example
{
  "callback_type_key": "string",
  "callback_url": "string",
  "callback_username": "string",
  "callback_headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "callback_type_key": "string",
  "callback_url": "string",
  "callback_username": "string",
  "callback_headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /callbacks/{callback_type_key}

Deletes a callback

callback_type_key: string EVENT_BULK
in path

The callback key to update

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Asynchronous Usage Event Management

POST /events/bulk

Rates a batch of usage events

send bulk usage for rating

Request Content-Types: application/json
Request Example
{
  "mode": "string",
  "usage_events": [
    {
      "start_time": "string (date-time)",
      "end_time": "string (date-time)",
      "service_resource_identifier": "string",
      "service_resource_type": "string",
      "usage_uom": "string",
      "usage_amount": "number",
      "reference_id": "string",
      "sequence_id": "string",
      "text01": "string",
      "text02": "string",
      "text03": "string",
      "text04": "string",
      "text05": "string",
      "number1": "number",
      "number2": "number",
      "number3": "number",
      "number4": "number",
      "number5": "number",
      "boolean01": "boolean",
      "boolean02": "boolean",
      "boolean03": "boolean",
      "boolean04": "boolean",
      "boolean05": "boolean",
      "date01": "string (date-time)",
      "date02": "string (date-time)",
      "date03": "string (date-time)",
      "date04": "string (date-time)",
      "date05": "string (date-time)",
      "id": "string"
    }
  ]
}
202 Accepted

Accepted

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "request_id": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Schema Definitions

BulkUsageEventsRequest: object

mode: UsageMode
usage_events: UsageEvent
UsageEvent
Example
{
  "mode": "string",
  "usage_events": [
    {
      "start_time": "string (date-time)",
      "end_time": "string (date-time)",
      "service_resource_identifier": "string",
      "service_resource_type": "string",
      "usage_uom": "string",
      "usage_amount": "number",
      "reference_id": "string",
      "sequence_id": "string",
      "text01": "string",
      "text02": "string",
      "text03": "string",
      "text04": "string",
      "text05": "string",
      "number1": "number",
      "number2": "number",
      "number3": "number",
      "number4": "number",
      "number5": "number",
      "boolean01": "boolean",
      "boolean02": "boolean",
      "boolean03": "boolean",
      "boolean04": "boolean",
      "boolean05": "boolean",
      "date01": "string (date-time)",
      "date02": "string (date-time)",
      "date03": "string (date-time)",
      "date04": "string (date-time)",
      "date05": "string (date-time)",
      "id": "string"
    }
  ]
}

AsyncCallback: object

callback_type_key: string EVENT_BULK

A callback type

callback_url: string

The URL to callback to for the particular type.

callback_username: string

The username associated with the callback, used to direct callbacks on a per username basis.

callback_headers: KeyValue
KeyValue
Example
{
  "callback_type_key": "string",
  "callback_url": "string",
  "callback_username": "string",
  "callback_headers": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

AsyncMessageResponse: object

request_id: string

A request_id for message tracking

Example
{
  "request_id": "string"
}

UsageMode: string

string FAIL_ON_EXISTING

UsageEvent:

start_time: string (date-time)
end_time: string (date-time)
service_resource_identifier: string
service_resource_type: ServiceResourceType
usage_uom: UsageDurationUom
usage_amount: number
reference_id: string
sequence_id: string
text01: string
text02: string
text03: string
text04: string
text05: string
number1: number
number2: number
number3: number
number4: number
number5: number
boolean01: boolean
boolean02: boolean
boolean03: boolean
boolean04: boolean
boolean05: boolean
date01: string (date-time)
date02: string (date-time)
date03: string (date-time)
date04: string (date-time)
date05: string (date-time)
Example
{
  "start_time": "string (date-time)",
  "end_time": "string (date-time)",
  "service_resource_identifier": "string",
  "service_resource_type": "string",
  "usage_uom": "string",
  "usage_amount": "number",
  "reference_id": "string",
  "sequence_id": "string",
  "text01": "string",
  "text02": "string",
  "text03": "string",
  "text04": "string",
  "text05": "string",
  "number1": "number",
  "number2": "number",
  "number3": "number",
  "number4": "number",
  "number5": "number",
  "boolean01": "boolean",
  "boolean02": "boolean",
  "boolean03": "boolean",
  "boolean04": "boolean",
  "boolean05": "boolean",
  "date01": "string (date-time)",
  "date02": "string (date-time)",
  "date03": "string (date-time)",
  "date04": "string (date-time)",
  "date05": "string (date-time)",
  "id": "string"
}

KeyValue: object

A simple key-value pair.

key: string

A unique key for this pair.

value: string

A value for this pair.

Example
{
  "key": "string",
  "value": "string"
}

Error: object

code: string

A code for the specific error. Used to help in determining possible root causes of an error.

message: string

A message providing additional detail for an error.

Example
{
  "code": "string",
  "message": "string"
}

Entity: object

A representation of a TRACT entity object

id: string

The internal entity id for this entity representation

Example
{
  "id": "string"
}

ServiceResourceType: string

string GENERIC_SERVICE_RESOURCE

UsageDurationUom: string

string MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, EVENT, BYTE, KILOBYTE, MEGABYTE, GIGABYTE, TERABYTE, COUNT, BITS_PER_SECOND, KILOBITS_PER_SECOND, MEGABITS_PER_SECOND, GIGABITS_PER_SECOND, CURRENCY, WATT, KILOWATT, MEGAWATT, GIGAWATT, WATTS_PER_HOUR, KILOWATTS_PER_HOUR, MEGAWATTS_PER_HOUR, GIGAWATTS_PER_HOUR