7.2. Tickets

Prev – Next

7.2. Tickets

List tickets

You can access a user's ticket using the Babelway REST API. Here are the specifications for this call:

URL Endpoint

http://www.babelway.net/SelfService/rest/v1/hub-{hubId}/tickets.{format}

where

format : either 'json' or 'xml'
hubId : the ID of your account environment. It can be found on your account page.

HTTP Method

GET

Requires authentification

yes ( About authentication )

Parameters

kw	A keyword to filter the tickets by. It will search within the description.
type	The type of ticket, one in the following list. If the entry is not within the list, a HTTP Status code 400 (bad request) will be returned. _0_MONITORING _1_MESSAGE_PROCESSING_ISSUES _1_1_UNIDENTIFIED_SOURCE _1_2_UNIDENTIFIED_MESSAGE_IN _1_3_UNIDENTIFIED_CHANNEL _1_4_MESSAGE_VALIDATION_ISSUE _1_5_FAILED_DELIVERY _1_6_PLANNED_CLEANING_OF_UNATTENDED_MESSAGES _2_HUB_ISSUES _2_1_STORAGE_CAPACITY_REACHED _2_2_PLANNED_MAINTENANCE_UNAVAILABILITY _2_3_NEW_FUNCTIONALITY_AVAILABLE _3_ACCOUNT_ISSUES _3_1_CREDIT_LIMIT_REACHED _3_2_UNPAID_INVOICE _3_3_CREDIT_LIMIT_NEAR_REACHED _3_4_VAT_CHANGED _4_CHANNEL_MANAGEMENT_ISSUE _4_1_MAINTENANCE_WARNING_OF_A_LINKED_CHANNEL _4_2_PLANNED_DELETION_OF_UNUSED_CHANNELS _4_3_DOCUMENTATION_OF_A_CHANNEL _4_4_CERTIFICATE_EXPIRATION _5_USER_MANAGEMENT_ISSUE _5_1_FAILED_CONNECTION_ATTEMPTS _5_2_FIRST_CONNECTION_FROM_INVITEE _5_3_PLANNED_CLEANING_OF_DORMANT_USERS _5_4_INVITATION_EXPIRED
status	The status of ticket, one in the following list. If the entry is not within the list, a HTTP Status code 400 (bad request) will be returned. OPEN CLOSED
severity	The severity of ticket, one in the following list. If the entry is not within the list, a HTTP Status code 400 (bad request) will be returned. HIGH MEDIUM LOW INFO
since	Returns tickets created after the given timestamp. Timestamp should be formatted as a UNIX Epoch time (number of seconds since the first of January 1970)
before	Returns tickets created before the given timestamp. Timestamp should be formatted as a UNIX Epoch time (number of seconds since the first of January 1970)
start	An integer to set the first result. By default, the value is at 0. The API returns 25 results per query. To get the 25 next one, it should be 25, then 50, then 75, ...

Get ticket details

URL Endpoint

http://www.babelway.net/SelfService/rest/v1/ticket-{key}.{format}

where

format : either 'json' or 'xml'
key : the ticket key as found by listing messages

HTTP Method

GET

Requires authentification

yes ( About authentication )

Examples

Get tickets with severity HIGH in environment 12345 in JSON format

https://www.babelway.net/SelfService/rest/v1/hub-12345/tickets.json?status=HIGH

[
   {
      "ticket":{
         "createdOn":1297082796140,
         "description":"Ftp server (ftp:\/\/ftp.server.com\/input) became DOWN at 07\/02\/2011 01:46:34.\nDue to exception:ftp.server.com",
         "severity":"HIGH",
         "status":"OPEN",
         "summary":"Ftp server : ftp:\/\/ftp.server.com\/input DOWN",
         "ticketKey":"539d51c6-23cb-4358-a822-c991c106a9bb",
         "type":"_5_1_FAILED_CONNECTION_ATTEMPTS"
      }
   }
]

Get tickets of type "Failed Connection Attempts" in environment 12345 in XML format

https://www.babelway.net/SelfService/rest/v1/hub-12345/tickets.xml?type=_5_1_FAILED_CONNECTION_ATTEMPTS

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
	<ticket>
		<createdOn>1297082796140</createdOn>
		<description>Ftp server (ftp://ftp.server.com/input) became DOWN at 07/02/2011 01:46:34.
Due to exception:ftp.server.com</description>
		<severity>HIGH</severity>
		<status>OPEN</status>
		<summary>Ftp server : ftp://ftp.server.com/input DOWN</summary>
		<ticketKey>539d51c6-23cb-4358-a822-c991c106a9bb</ticketKey>
		<type>_5_1_FAILED_CONNECTION_ATTEMPTS</type>
	</ticket>
</collection>

Get the details for the ticket with key 'abcdef' in JSON format

https://www.babelway.net/SelfService/rest/v1/ticket-abcdef.json

[
   {
      "ticket":{
         "createdOn":1297082796140,
         "description":"Ftp server (ftp:\/\/ftp.server.com\/input) became DOWN at 07\/02\/2011 01:46:34.\nDue to exception:ftp.server.com",
         "severity":"HIGH",
         "status":"OPEN",
         "summary":"Ftp server : ftp:\/\/ftp.server.com\/input DOWN",
         "ticketKey":"abcdef",
         "type":"_5_1_FAILED_CONNECTION_ATTEMPTS"
      }
   }
]

Prev	Up	Next
7.1. Introduction	Reference Manual	7.3. Messages