Preview Webservices

Preview

createPreviewTicket

Creates a new preview ticket.


/v1/preview

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/previewwebservices/v1/preview"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PreviewApi;

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

public class PreviewApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PreviewApi apiInstance = new PreviewApi();
        PreviewTicket body = ; // PreviewTicket | 
        try {
            previewTicket result = apiInstance.createPreviewTicket(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#createPreviewTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PreviewApi;

public class PreviewApiExample {

    public static void main(String[] args) {
        PreviewApi apiInstance = new PreviewApi();
        PreviewTicket body = ; // PreviewTicket | 
        try {
            previewTicket result = apiInstance.createPreviewTicket(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#createPreviewTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PreviewTicket *body = ; // 

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

// Creates a new preview ticket.
[apiInstance createPreviewTicketWith:body
              completionHandler: ^(previewTicket output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PreviewWebservices = require('preview_webservices');
var defaultClient = PreviewWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PreviewWebservices.PreviewApi()
var body = ; // {{PreviewTicket}} 

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PreviewApi();
            var body = new PreviewTicket(); // PreviewTicket | 

            try
            {
                // Creates a new preview ticket.
                previewTicket result = apiInstance.createPreviewTicket(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PreviewApi.createPreviewTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPreviewApi();
$body = ; // PreviewTicket | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PreviewApi->new();
my $body = WWW::SwaggerClient::Object::PreviewTicket->new(); # PreviewTicket | 

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PreviewApi()
body =  # PreviewTicket | 

try: 
    # Creates a new preview ticket.
    api_response = api_instance.create_preview_ticket(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PreviewApi->createPreviewTicket: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Not Found


getPreviewTicket

Returns a preview ticket DTO.


/v1/preview/{ticketId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/xml,application/json"\
"http://localhost:9001/previewwebservices/v1/preview/{ticketId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PreviewApi;

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

public class PreviewApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PreviewApi apiInstance = new PreviewApi();
        String ticketId = ticketId_example; // String | Preview ticket identifier
        try {
            apiInstance.getPreviewTicket(ticketId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#getPreviewTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PreviewApi;

public class PreviewApiExample {

    public static void main(String[] args) {
        PreviewApi apiInstance = new PreviewApi();
        String ticketId = ticketId_example; // String | Preview ticket identifier
        try {
            apiInstance.getPreviewTicket(ticketId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#getPreviewTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *ticketId = ticketId_example; // Preview ticket identifier

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

// Returns a preview ticket DTO.
[apiInstance getPreviewTicketWith:ticketId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PreviewWebservices = require('preview_webservices');
var defaultClient = PreviewWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PreviewWebservices.PreviewApi()
var ticketId = ticketId_example; // {{String}} Preview ticket identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PreviewApi();
            var ticketId = ticketId_example;  // String | Preview ticket identifier

            try
            {
                // Returns a preview ticket DTO.
                apiInstance.getPreviewTicket(ticketId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PreviewApi.getPreviewTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPreviewApi();
$ticketId = ticketId_example; // String | Preview ticket identifier

try {
    $api_instance->getPreviewTicket($ticketId);
} catch (Exception $e) {
    echo 'Exception when calling PreviewApi->getPreviewTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PreviewApi;

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PreviewApi->new();
my $ticketId = ticketId_example; # String | Preview ticket identifier

eval { 
    $api_instance->getPreviewTicket(ticketId => $ticketId);
};
if ($@) {
    warn "Exception when calling PreviewApi->getPreviewTicket: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PreviewApi()
ticketId = ticketId_example # String | Preview ticket identifier

try: 
    # Returns a preview ticket DTO.
    api_instance.get_preview_ticket(ticketId)
except ApiException as e:
    print("Exception when calling PreviewApi->getPreviewTicket: %s\n" % e)

Parameters

Path parameters
Name Description
ticketId*
String
Preview ticket identifier
Required

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Ticket with given id doesn't exist


replacePreviewTicket

Updates an existing preview ticket.


/v1/preview/{ticketId}

Usage and SDK Samples

curl -X PUT\
\
\
-H "Accept: application/xml,application/json"\
-H "Content-Type: application/xml,application/json"\
"http://localhost:9001/previewwebservices/v1/preview/{ticketId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PreviewApi;

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

public class PreviewApiExample {

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

        // Configure OAuth2 access token for authorization: oauth2_Password
        OAuth oauth2_Password = (OAuth) defaultClient.getAuthentication("oauth2_Password");
        oauth2_Password.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: oauth2_client_credentials
        OAuth oauth2_client_credentials = (OAuth) defaultClient.getAuthentication("oauth2_client_credentials");
        oauth2_client_credentials.setAccessToken("YOUR ACCESS TOKEN");

        PreviewApi apiInstance = new PreviewApi();
        PreviewTicket body = ; // PreviewTicket | 
        String ticketId = ticketId_example; // String | Preview ticket identifier
        try {
            apiInstance.replacePreviewTicket(body, ticketId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#replacePreviewTicket");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PreviewApi;

public class PreviewApiExample {

    public static void main(String[] args) {
        PreviewApi apiInstance = new PreviewApi();
        PreviewTicket body = ; // PreviewTicket | 
        String ticketId = ticketId_example; // String | Preview ticket identifier
        try {
            apiInstance.replacePreviewTicket(body, ticketId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PreviewApi#replacePreviewTicket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_Password)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: oauth2_client_credentials)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
PreviewTicket *body = ; // 
String *ticketId = ticketId_example; // Preview ticket identifier

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

// Updates an existing preview ticket.
[apiInstance replacePreviewTicketWith:body
    ticketId:ticketId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PreviewWebservices = require('preview_webservices');
var defaultClient = PreviewWebservices.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2_Password
var oauth2_Password = defaultClient.authentications['oauth2_Password'];
oauth2_Password.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: oauth2_client_credentials
var oauth2_client_credentials = defaultClient.authentications['oauth2_client_credentials'];
oauth2_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new PreviewWebservices.PreviewApi()
var body = ; // {{PreviewTicket}} 
var ticketId = ticketId_example; // {{String}} Preview ticket identifier

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

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

            // Configure OAuth2 access token for authorization: oauth2_Password
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: oauth2_client_credentials
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PreviewApi();
            var body = new PreviewTicket(); // PreviewTicket | 
            var ticketId = ticketId_example;  // String | Preview ticket identifier

            try
            {
                // Updates an existing preview ticket.
                apiInstance.replacePreviewTicket(body, ticketId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PreviewApi.replacePreviewTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2_Password
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: oauth2_client_credentials
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPreviewApi();
$body = ; // PreviewTicket | 
$ticketId = ticketId_example; // String | Preview ticket identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: oauth2_client_credentials
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PreviewApi->new();
my $body = WWW::SwaggerClient::Object::PreviewTicket->new(); # PreviewTicket | 
my $ticketId = ticketId_example; # String | Preview ticket identifier

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

# Configure OAuth2 access token for authorization: oauth2_Password
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: oauth2_client_credentials
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PreviewApi()
body =  # PreviewTicket | 
ticketId = ticketId_example # String | Preview ticket identifier

try: 
    # Updates an existing preview ticket.
    api_instance.replace_preview_ticket(body, ticketId)
except ApiException as e:
    print("Exception when calling PreviewApi->replacePreviewTicket: %s\n" % e)

Parameters

Path parameters
Name Description
ticketId*
String
Preview ticket identifier
Required
Body parameters
Name Description
body *

Responses

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden. Have no access to this method

Status: 404 - Ticket with given id doesn't exist

Status: 409 - Conflict - ticket code in request body and url do not match