CONNEX Platform

TestResults

createTestResults

Create Test Results

The POST Test Result API endpoint provides possibility to return the list of Test Results based on the defined parameters. Parameters are as follows: modified date and/or ticket number and/or timeZone.


/v2/connex/{clientId}/test-results/search

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/test-results/search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TestResultsApi;

import java.io.File;
import java.util.*;

public class TestResultsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TestResultsApi apiInstance = new TestResultsApi();
        TestResultsSearchRequest body = ; // TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        try {
            TestResultsSearchResponse result = apiInstance.createTestResults(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestResultsApi#createTestResults");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TestResultsApi;

public class TestResultsApiExample {

    public static void main(String[] args) {
        TestResultsApi apiInstance = new TestResultsApi();
        TestResultsSearchRequest body = ; // TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        try {
            TestResultsSearchResponse result = apiInstance.createTestResults(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestResultsApi#createTestResults");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
TestResultsSearchRequest *body = ; // Specifies query parameters for the Test Results Search.
String *clientId = clientId_example; // A unique client identifier used to authorize the request.

TestResultsApi *apiInstance = [[TestResultsApi alloc] init];

// Create Test Results
[apiInstance createTestResultsWith:body
    clientId:clientId
              completionHandler: ^(TestResultsSearchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TestResultsApi()
var body = ; // {{TestResultsSearchRequest}} Specifies query parameters for the Test Results Search.
var clientId = clientId_example; // {{String}} A unique client identifier used to authorize the request.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTestResults(bodyclientId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTestResultsExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TestResultsApi();
            var body = new TestResultsSearchRequest(); // TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
            var clientId = clientId_example;  // String | A unique client identifier used to authorize the request.

            try
            {
                // Create Test Results
                TestResultsSearchResponse result = apiInstance.createTestResults(body, clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TestResultsApi.createTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTestResultsApi();
$body = ; // TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
$clientId = clientId_example; // String | A unique client identifier used to authorize the request.

try {
    $result = $api_instance->createTestResults($body, $clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestResultsApi->createTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TestResultsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TestResultsApi->new();
my $body = WWW::SwaggerClient::Object::TestResultsSearchRequest->new(); # TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
my $clientId = clientId_example; # String | A unique client identifier used to authorize the request.

eval { 
    my $result = $api_instance->createTestResults(body => $body, clientId => $clientId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestResultsApi->createTestResults: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestResultsApi()
body =  # TestResultsSearchRequest | Specifies query parameters for the Test Results Search.
clientId = clientId_example # String | A unique client identifier used to authorize the request.

try: 
    # Create Test Results
    api_response = api_instance.create_test_results(body, clientId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestResultsApi->createTestResults: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
A unique client identifier used to authorize the request.
Required
Body parameters
Name Description
body *

Responses

Status: 200 -


getTestResults

Get Test Results

The GET Test Results API allows users to retrieve test measurements for the material on a specified ticket. Test Results consist of test measurements as well as other information related to material testing, such as sampling technician and sampling method.


/v2/connex/{clientId}/tickets/{ticketRef}/test-results

Usage and SDK Samples

curl -X GET\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{ticketRef}/test-results"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TestResultsApi;

import java.io.File;
import java.util.*;

public class TestResultsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TestResultsApi apiInstance = new TestResultsApi();
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.
        try {
            TestResultSearchResponse result = apiInstance.getTestResults(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestResultsApi#getTestResults");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TestResultsApi;

public class TestResultsApiExample {

    public static void main(String[] args) {
        TestResultsApi apiInstance = new TestResultsApi();
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.
        try {
            TestResultSearchResponse result = apiInstance.getTestResults(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestResultsApi#getTestResults");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
String *clientId = clientId_example; // A unique client identifier used to authorize the request.
String *ticketRef = ticketRef_example; // A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

TestResultsApi *apiInstance = [[TestResultsApi alloc] init];

// Get Test Results
[apiInstance getTestResultsWith:clientId
    ticketRef:ticketRef
              completionHandler: ^(TestResultSearchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TestResultsApi()
var clientId = clientId_example; // {{String}} A unique client identifier used to authorize the request.
var ticketRef = ticketRef_example; // {{String}} A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTestResults(clientId, ticketRef, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTestResultsExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TestResultsApi();
            var clientId = clientId_example;  // String | A unique client identifier used to authorize the request.
            var ticketRef = ticketRef_example;  // String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

            try
            {
                // Get Test Results
                TestResultSearchResponse result = apiInstance.getTestResults(clientId, ticketRef);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TestResultsApi.getTestResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTestResultsApi();
$clientId = clientId_example; // String | A unique client identifier used to authorize the request.
$ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

try {
    $result = $api_instance->getTestResults($clientId, $ticketRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestResultsApi->getTestResults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TestResultsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TestResultsApi->new();
my $clientId = clientId_example; # String | A unique client identifier used to authorize the request.
my $ticketRef = ticketRef_example; # String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

eval { 
    my $result = $api_instance->getTestResults(clientId => $clientId, ticketRef => $ticketRef);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestResultsApi->getTestResults: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestResultsApi()
clientId = clientId_example # String | A unique client identifier used to authorize the request.
ticketRef = ticketRef_example # String | A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.

try: 
    # Get Test Results
    api_response = api_instance.get_test_results(clientId, ticketRef)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestResultsApi->getTestResults: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
A unique client identifier used to authorize the request.
Required
ticketRef*
String
A unique identifier for the parent ticket object. This is the "crn" property returned from a previous Ticket Search or Create Ticket action.
Required

Responses

Status: 200 -


TicketEvents

createTicketEvent

Create Ticket Event

The ticket create API allows developers with a valid API key and matching client identifier to create new ticket events or update the existing one. HTTP status 201 and response with created object in the case of a created record, and 200 with no content for an update object.


/v2/connex/{clientId}/tickets/{ticketRef}/ticket-events

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{ticketRef}/ticket-events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketEventsApi;

import java.io.File;
import java.util.*;

public class TicketEventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketEventsApi apiInstance = new TicketEventsApi();
        TicketEvent body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
}; // TicketEvent | Specify the fields and values for new ticket
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String ticketRef = ticketRef_example; // String | Existing ticket CRN or reference
        try {
            TicketEvent result = apiInstance.createTicketEvent(body, clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketEventsApi#createTicketEvent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketEventsApi;

public class TicketEventsApiExample {

    public static void main(String[] args) {
        TicketEventsApi apiInstance = new TicketEventsApi();
        TicketEvent body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
}; // TicketEvent | Specify the fields and values for new ticket
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String ticketRef = ticketRef_example; // String | Existing ticket CRN or reference
        try {
            TicketEvent result = apiInstance.createTicketEvent(body, clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketEventsApi#createTicketEvent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
TicketEvent *body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
}; // Specify the fields and values for new ticket
String *clientId = clientId_example; // Specifies the client ID used to authorize the request.
String *ticketRef = ticketRef_example; // Existing ticket CRN or reference

TicketEventsApi *apiInstance = [[TicketEventsApi alloc] init];

// Create Ticket Event
[apiInstance createTicketEventWith:body
    clientId:clientId
    ticketRef:ticketRef
              completionHandler: ^(TicketEvent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketEventsApi()
var body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
}; // {{TicketEvent}} Specify the fields and values for new ticket
var clientId = clientId_example; // {{String}} Specifies the client ID used to authorize the request.
var ticketRef = ticketRef_example; // {{String}} Existing ticket CRN or reference

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTicketEvent(bodyclientIdticketRef, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTicketEventExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketEventsApi();
            var body = new TicketEvent(); // TicketEvent | Specify the fields and values for new ticket
            var clientId = clientId_example;  // String | Specifies the client ID used to authorize the request.
            var ticketRef = ticketRef_example;  // String | Existing ticket CRN or reference

            try
            {
                // Create Ticket Event
                TicketEvent result = apiInstance.createTicketEvent(body, clientId, ticketRef);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketEventsApi.createTicketEvent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketEventsApi();
$body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
}; // TicketEvent | Specify the fields and values for new ticket
$clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
$ticketRef = ticketRef_example; // String | Existing ticket CRN or reference

try {
    $result = $api_instance->createTicketEvent($body, $clientId, $ticketRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketEventsApi->createTicketEvent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketEventsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketEventsApi->new();
my $body = WWW::SwaggerClient::Object::TicketEvent->new(); # TicketEvent | Specify the fields and values for new ticket
my $clientId = clientId_example; # String | Specifies the client ID used to authorize the request.
my $ticketRef = ticketRef_example; # String | Existing ticket CRN or reference

eval { 
    my $result = $api_instance->createTicketEvent(body => $body, clientId => $clientId, ticketRef => $ticketRef);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketEventsApi->createTicketEvent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketEventsApi()
body = {
  "statusCode" : "ARRIVE_JOB",
  "eventDateTime" : "2020-07-06T19:59:59Z"
} # TicketEvent | Specify the fields and values for new ticket
clientId = clientId_example # String | Specifies the client ID used to authorize the request.
ticketRef = ticketRef_example # String | Existing ticket CRN or reference

try: 
    # Create Ticket Event
    api_response = api_instance.create_ticket_event(body, clientId, ticketRef)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketEventsApi->createTicketEvent: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Specifies the client ID used to authorize the request.
Required
ticketRef*
String
Existing ticket CRN or reference
Required
Body parameters
Name Description
body *

Responses

Status: 200 -

Status: 400 - Request parameter is invalid. Request schema is invalid. Missing mandatory property. Wrong data type.

Status: 403 - Wrong clientId or x-api-key

Status: 404 - Ticket not found

Status: 500 - Internal Server Error


getTicketEvents

Get Ticket Events

The GET Ticket Events API allows developers with a valid API key and matching client identifier to fetch list of ticket events that connected to the specific ticket.


/v2/connex/{clientId}/tickets/{ticketRef}/ticket-events

Usage and SDK Samples

curl -X GET\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{ticketRef}/ticket-events"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketEventsApi;

import java.io.File;
import java.util.*;

public class TicketEventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketEventsApi apiInstance = new TicketEventsApi();
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String ticketRef = ticketRef_example; // String | Existing ticket CRN or reference
        try {
            TicketEventsResponse result = apiInstance.getTicketEvents(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketEventsApi#getTicketEvents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketEventsApi;

public class TicketEventsApiExample {

    public static void main(String[] args) {
        TicketEventsApi apiInstance = new TicketEventsApi();
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String ticketRef = ticketRef_example; // String | Existing ticket CRN or reference
        try {
            TicketEventsResponse result = apiInstance.getTicketEvents(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketEventsApi#getTicketEvents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
String *clientId = clientId_example; // Specifies the client ID used to authorize the request.
String *ticketRef = ticketRef_example; // Existing ticket CRN or reference

TicketEventsApi *apiInstance = [[TicketEventsApi alloc] init];

// Get Ticket Events
[apiInstance getTicketEventsWith:clientId
    ticketRef:ticketRef
              completionHandler: ^(TicketEventsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketEventsApi()
var clientId = clientId_example; // {{String}} Specifies the client ID used to authorize the request.
var ticketRef = ticketRef_example; // {{String}} Existing ticket CRN or reference

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTicketEvents(clientId, ticketRef, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTicketEventsExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketEventsApi();
            var clientId = clientId_example;  // String | Specifies the client ID used to authorize the request.
            var ticketRef = ticketRef_example;  // String | Existing ticket CRN or reference

            try
            {
                // Get Ticket Events
                TicketEventsResponse result = apiInstance.getTicketEvents(clientId, ticketRef);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketEventsApi.getTicketEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketEventsApi();
$clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
$ticketRef = ticketRef_example; // String | Existing ticket CRN or reference

try {
    $result = $api_instance->getTicketEvents($clientId, $ticketRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketEventsApi->getTicketEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketEventsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketEventsApi->new();
my $clientId = clientId_example; # String | Specifies the client ID used to authorize the request.
my $ticketRef = ticketRef_example; # String | Existing ticket CRN or reference

eval { 
    my $result = $api_instance->getTicketEvents(clientId => $clientId, ticketRef => $ticketRef);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketEventsApi->getTicketEvents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketEventsApi()
clientId = clientId_example # String | Specifies the client ID used to authorize the request.
ticketRef = ticketRef_example # String | Existing ticket CRN or reference

try: 
    # Get Ticket Events
    api_response = api_instance.get_ticket_events(clientId, ticketRef)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketEventsApi->getTicketEvents: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Specifies the client ID used to authorize the request.
Required
ticketRef*
String
Existing ticket CRN or reference
Required

Responses

Status: 200 -

Status: 403 - Wrong clientId or x-api-key

Status: 404 - Invalid or wrong ticket reference

Status: 500 - Internal Server Error


TicketProductions

getTicketProductions

Get Ticket Productions

The GET Ticket Productions API allows a developer to retrieve the production information for a specified ticket. Production information consists of batch quantities and other properties of a specific load of material manufactured for the ticket item, typically concrete or hot mix asphalt.


/v2/connex/{clientId}/tickets/{ticketRef}/productions

Usage and SDK Samples

curl -X GET\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{ticketRef}/productions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketProductionsApi;

import java.io.File;
import java.util.*;

public class TicketProductionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketProductionsApi apiInstance = new TicketProductionsApi();
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object.
        try {
            TicketProductionsResponse result = apiInstance.getTicketProductions(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketProductionsApi#getTicketProductions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketProductionsApi;

public class TicketProductionsApiExample {

    public static void main(String[] args) {
        TicketProductionsApi apiInstance = new TicketProductionsApi();
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object.
        try {
            TicketProductionsResponse result = apiInstance.getTicketProductions(clientId, ticketRef);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketProductionsApi#getTicketProductions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
String *clientId = clientId_example; // A unique client identifier used to authorize the request.
String *ticketRef = ticketRef_example; // A unique identifier for the parent ticket object.

TicketProductionsApi *apiInstance = [[TicketProductionsApi alloc] init];

// Get Ticket Productions
[apiInstance getTicketProductionsWith:clientId
    ticketRef:ticketRef
              completionHandler: ^(TicketProductionsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketProductionsApi()
var clientId = clientId_example; // {{String}} A unique client identifier used to authorize the request.
var ticketRef = ticketRef_example; // {{String}} A unique identifier for the parent ticket object.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTicketProductions(clientId, ticketRef, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTicketProductionsExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketProductionsApi();
            var clientId = clientId_example;  // String | A unique client identifier used to authorize the request.
            var ticketRef = ticketRef_example;  // String | A unique identifier for the parent ticket object.

            try
            {
                // Get Ticket Productions
                TicketProductionsResponse result = apiInstance.getTicketProductions(clientId, ticketRef);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketProductionsApi.getTicketProductions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketProductionsApi();
$clientId = clientId_example; // String | A unique client identifier used to authorize the request.
$ticketRef = ticketRef_example; // String | A unique identifier for the parent ticket object.

try {
    $result = $api_instance->getTicketProductions($clientId, $ticketRef);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketProductionsApi->getTicketProductions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketProductionsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketProductionsApi->new();
my $clientId = clientId_example; # String | A unique client identifier used to authorize the request.
my $ticketRef = ticketRef_example; # String | A unique identifier for the parent ticket object.

eval { 
    my $result = $api_instance->getTicketProductions(clientId => $clientId, ticketRef => $ticketRef);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketProductionsApi->getTicketProductions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketProductionsApi()
clientId = clientId_example # String | A unique client identifier used to authorize the request.
ticketRef = ticketRef_example # String | A unique identifier for the parent ticket object.

try: 
    # Get Ticket Productions
    api_response = api_instance.get_ticket_productions(clientId, ticketRef)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketProductionsApi->getTicketProductions: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
A unique client identifier used to authorize the request.
Required
ticketRef*
String
A unique identifier for the parent ticket object.
Required

Responses

Status: 200 -

Status: 403 - Wrong clientId or x-api-key

Status: 404 - Ticket not found

Status: 500 - Internal Server Error


Tickets

createTicket

Create a Ticket

The ticket create API allows developers with a valid API key and matching client identifier to create new tickets.


/v2/connex/{clientId}/tickets

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketsApi apiInstance = new TicketsApi();
        Ticket body = ; // Ticket | Specify the fields and values for new ticket
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        try {
            Ticket result = apiInstance.createTicket(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#createTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        Ticket body = ; // Ticket | Specify the fields and values for new ticket
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        try {
            Ticket result = apiInstance.createTicket(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#createTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
Ticket *body = ; // Specify the fields and values for new ticket
String *clientId = clientId_example; // Specifies the client ID used to authorize the request.

TicketsApi *apiInstance = [[TicketsApi alloc] init];

// Create a Ticket
[apiInstance createTicketWith:body
    clientId:clientId
              completionHandler: ^(Ticket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketsApi()
var body = ; // {{Ticket}} Specify the fields and values for new ticket
var clientId = clientId_example; // {{String}} Specifies the client ID used to authorize the request.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createTicket(bodyclientId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTicketExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketsApi();
            var body = new Ticket(); // Ticket | Specify the fields and values for new ticket
            var clientId = clientId_example;  // String | Specifies the client ID used to authorize the request.

            try
            {
                // Create a Ticket
                Ticket result = apiInstance.createTicket(body, clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketsApi.createTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$body = ; // Ticket | Specify the fields and values for new ticket
$clientId = clientId_example; // String | Specifies the client ID used to authorize the request.

try {
    $result = $api_instance->createTicket($body, $clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketsApi->createTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $body = WWW::SwaggerClient::Object::Ticket->new(); # Ticket | Specify the fields and values for new ticket
my $clientId = clientId_example; # String | Specifies the client ID used to authorize the request.

eval { 
    my $result = $api_instance->createTicket(body => $body, clientId => $clientId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketsApi->createTicket: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
body =  # Ticket | Specify the fields and values for new ticket
clientId = clientId_example # String | Specifies the client ID used to authorize the request.

try: 
    # Create a Ticket
    api_response = api_instance.create_ticket(body, clientId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketsApi->createTicket: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Specifies the client ID used to authorize the request.
Required
Body parameters
Name Description
body *

Responses

Status: 200 -

Status: 400 - Request parameter is invalid. Request schema is invalid. Missing mandatory property. Wrong data type.

Status: 500 - Internal Server Error


replaceTicket

Replace a Ticket

The ticket update (replace) API allows developers with a valid API key and matching client identifier to update (replace) ticket.


/v2/connex/{clientId}/tickets/{crn}

Usage and SDK Samples

curl -X PUT\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{crn}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketsApi apiInstance = new TicketsApi();
        Ticket body = ; // Ticket | 
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String crn = crn_example; // String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.
        try {
            apiInstance.replaceTicket(body, clientId, crn);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#replaceTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        Ticket body = ; // Ticket | 
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        String crn = crn_example; // String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.
        try {
            apiInstance.replaceTicket(body, clientId, crn);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#replaceTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
Ticket *body = ; // 
String *clientId = clientId_example; // Specifies the client ID used to authorize the request.
String *crn = crn_example; // Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

TicketsApi *apiInstance = [[TicketsApi alloc] init];

// Replace a Ticket
[apiInstance replaceTicketWith:body
    clientId:clientId
    crn:crn
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketsApi()
var body = ; // {{Ticket}} 
var clientId = clientId_example; // {{String}} Specifies the client ID used to authorize the request.
var crn = crn_example; // {{String}} Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.replaceTicket(bodyclientIdcrn, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class replaceTicketExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketsApi();
            var body = new Ticket(); // Ticket | 
            var clientId = clientId_example;  // String | Specifies the client ID used to authorize the request.
            var crn = crn_example;  // String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

            try
            {
                // Replace a Ticket
                apiInstance.replaceTicket(body, clientId, crn);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketsApi.replaceTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$body = ; // Ticket | 
$clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
$crn = crn_example; // String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

try {
    $api_instance->replaceTicket($body, $clientId, $crn);
} catch (Exception $e) {
    echo 'Exception when calling TicketsApi->replaceTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $body = WWW::SwaggerClient::Object::Ticket->new(); # Ticket | 
my $clientId = clientId_example; # String | Specifies the client ID used to authorize the request.
my $crn = crn_example; # String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

eval { 
    $api_instance->replaceTicket(body => $body, clientId => $clientId, crn => $crn);
};
if ($@) {
    warn "Exception when calling TicketsApi->replaceTicket: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
body =  # Ticket | 
clientId = clientId_example # String | Specifies the client ID used to authorize the request.
crn = crn_example # String | Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.

try: 
    # Replace a Ticket
    api_instance.replace_ticket(body, clientId, crn)
except ApiException as e:
    print("Exception when calling TicketsApi->replaceTicket: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Specifies the client ID used to authorize the request.
Required
crn*
String
Canonical Resource Name. A UUID per RFC-4122. Must be globally unique because this object will be shared across entity partitions.
Required
Body parameters
Name Description
body *

Responses

Status: 200 -

Status: 400 - Request parameter is invalid. Request schema is invalid. Missing mandatory property. Wrong data type.

Status: 404 - Requested resource does not exist physically or for the User/Client.


searchTickets

Search Tickets

The ticket search API allows developers with a valid API key and matching client identifier to search for tickets within a specified date and time range.


/v2/connex/{clientId}/tickets/search

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketsApi apiInstance = new TicketsApi();
        TicketSearchRequest body = ; // TicketSearchRequest | Specifies query parameters for the Ticket Search.
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        try {
            TicketSearchResponse result = apiInstance.searchTickets(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#searchTickets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        TicketSearchRequest body = ; // TicketSearchRequest | Specifies query parameters for the Ticket Search.
        String clientId = clientId_example; // String | Specifies the client ID used to authorize the request.
        try {
            TicketSearchResponse result = apiInstance.searchTickets(body, clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#searchTickets");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
TicketSearchRequest *body = ; // Specifies query parameters for the Ticket Search.
String *clientId = clientId_example; // Specifies the client ID used to authorize the request.

TicketsApi *apiInstance = [[TicketsApi alloc] init];

// Search Tickets
[apiInstance searchTicketsWith:body
    clientId:clientId
              completionHandler: ^(TicketSearchResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketsApi()
var body = ; // {{TicketSearchRequest}} Specifies query parameters for the Ticket Search.
var clientId = clientId_example; // {{String}} Specifies the client ID used to authorize the request.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchTickets(bodyclientId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTicketsExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketsApi();
            var body = new TicketSearchRequest(); // TicketSearchRequest | Specifies query parameters for the Ticket Search.
            var clientId = clientId_example;  // String | Specifies the client ID used to authorize the request.

            try
            {
                // Search Tickets
                TicketSearchResponse result = apiInstance.searchTickets(body, clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketsApi.searchTickets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$body = ; // TicketSearchRequest | Specifies query parameters for the Ticket Search.
$clientId = clientId_example; // String | Specifies the client ID used to authorize the request.

try {
    $result = $api_instance->searchTickets($body, $clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketsApi->searchTickets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $body = WWW::SwaggerClient::Object::TicketSearchRequest->new(); # TicketSearchRequest | Specifies query parameters for the Ticket Search.
my $clientId = clientId_example; # String | Specifies the client ID used to authorize the request.

eval { 
    my $result = $api_instance->searchTickets(body => $body, clientId => $clientId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketsApi->searchTickets: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
body =  # TicketSearchRequest | Specifies query parameters for the Ticket Search.
clientId = clientId_example # String | Specifies the client ID used to authorize the request.

try: 
    # Search Tickets
    api_response = api_instance.search_tickets(body, clientId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketsApi->searchTickets: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Specifies the client ID used to authorize the request.
Required
Body parameters
Name Description
body *

Responses

Status: 200 -


updateTicket

Update a Ticket

The PATCH Ticket API allows customers to update certain selected fields on existing tickets in CONNEX.


/v2/connex/{clientId}/tickets/{crn}

Usage and SDK Samples

curl -X PATCH\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://api.commandalkon.io/v2/connex/{clientId}/tickets/{crn}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TicketsApi;

import java.io.File;
import java.util.*;

public class TicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: api-key
        ApiKeyAuth api-key = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
        api-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api-key.setApiKeyPrefix("Token");

        TicketsApi apiInstance = new TicketsApi();
        TicketPatch body = ; // TicketPatch | Specifies the fields and their values to be changed on the ticket
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String crn = crn_example; // String | Canonical Resource Name. A unique identifier of the ticket.
        try {
            apiInstance.updateTicket(body, clientId, crn);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#updateTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TicketsApi;

public class TicketsApiExample {

    public static void main(String[] args) {
        TicketsApi apiInstance = new TicketsApi();
        TicketPatch body = ; // TicketPatch | Specifies the fields and their values to be changed on the ticket
        String clientId = clientId_example; // String | A unique client identifier used to authorize the request.
        String crn = crn_example; // String | Canonical Resource Name. A unique identifier of the ticket.
        try {
            apiInstance.updateTicket(body, clientId, crn);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketsApi#updateTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
TicketPatch *body = ; // Specifies the fields and their values to be changed on the ticket
String *clientId = clientId_example; // A unique client identifier used to authorize the request.
String *crn = crn_example; // Canonical Resource Name. A unique identifier of the ticket.

TicketsApi *apiInstance = [[TicketsApi alloc] init];

// Update a Ticket
[apiInstance updateTicketWith:body
    clientId:clientId
    crn:crn
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ConnexPlatform = require('connex_platform');
var defaultClient = ConnexPlatform.ApiClient.instance;

// Configure API key authorization: api-key
var api-key = defaultClient.authentications['api-key'];
api-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api-key.apiKeyPrefix['x-api-key'] = "Token"

var api = new ConnexPlatform.TicketsApi()
var body = ; // {{TicketPatch}} Specifies the fields and their values to be changed on the ticket
var clientId = clientId_example; // {{String}} A unique client identifier used to authorize the request.
var crn = crn_example; // {{String}} Canonical Resource Name. A unique identifier of the ticket.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTicket(bodyclientIdcrn, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateTicketExample
    {
        public void main()
        {

            // Configure API key authorization: api-key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new TicketsApi();
            var body = new TicketPatch(); // TicketPatch | Specifies the fields and their values to be changed on the ticket
            var clientId = clientId_example;  // String | A unique client identifier used to authorize the request.
            var crn = crn_example;  // String | Canonical Resource Name. A unique identifier of the ticket.

            try
            {
                // Update a Ticket
                apiInstance.updateTicket(body, clientId, crn);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TicketsApi.updateTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiTicketsApi();
$body = ; // TicketPatch | Specifies the fields and their values to be changed on the ticket
$clientId = clientId_example; // String | A unique client identifier used to authorize the request.
$crn = crn_example; // String | Canonical Resource Name. A unique identifier of the ticket.

try {
    $api_instance->updateTicket($body, $clientId, $crn);
} catch (Exception $e) {
    echo 'Exception when calling TicketsApi->updateTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TicketsApi;

# Configure API key authorization: api-key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TicketsApi->new();
my $body = WWW::SwaggerClient::Object::TicketPatch->new(); # TicketPatch | Specifies the fields and their values to be changed on the ticket
my $clientId = clientId_example; # String | A unique client identifier used to authorize the request.
my $crn = crn_example; # String | Canonical Resource Name. A unique identifier of the ticket.

eval { 
    $api_instance->updateTicket(body => $body, clientId => $clientId, crn => $crn);
};
if ($@) {
    warn "Exception when calling TicketsApi->updateTicket: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api-key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TicketsApi()
body =  # TicketPatch | Specifies the fields and their values to be changed on the ticket
clientId = clientId_example # String | A unique client identifier used to authorize the request.
crn = crn_example # String | Canonical Resource Name. A unique identifier of the ticket.

try: 
    # Update a Ticket
    api_instance.update_ticket(body, clientId, crn)
except ApiException as e:
    print("Exception when calling TicketsApi->updateTicket: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
A unique client identifier used to authorize the request.
Required
crn*
String
Canonical Resource Name. A unique identifier of the ticket.
Required
Body parameters
Name Description
body *

Responses

Status: 200 -

Status: 400 - Request parameter is invalid. Request schema is invalid. Missing mandatory property. Wrong data type.

Status: 404 - Requested resource does not exist physically or for the User/Client.