ABMS public API

Accounting

getInvoicePdf

Return invoice pdf file.


/api/orders/{id}/printable

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/pdf" \
 "http://localhost/api/orders/{id}/printable"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AccountingApi;

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

public class AccountingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AccountingApi apiInstance = new AccountingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getInvoicePdf(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountingApi#getInvoicePdf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AccountingApi;

public class AccountingApiExample {
    public static void main(String[] args) {
        AccountingApi apiInstance = new AccountingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getInvoicePdf(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountingApi#getInvoicePdf");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AccountingApi *apiInstance = [[AccountingApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getInvoicePdfWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.AccountingApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new AccountingApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                File result = apiInstance.getInvoicePdf(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccountingApi.getInvoicePdf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AccountingApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getInvoicePdf($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountingApi->getInvoicePdf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AccountingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AccountingApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.AccountingApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_invoice_pdf(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountingApi->getInvoicePdf: %s\n" % e)
extern crate AccountingApi;

pub fn main() {
    let id = id_example; // String

    let mut context = AccountingApi::Context::default();
    let result = client.getInvoicePdf(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


Crm

addAccount

Creation of an Aremiti account for a user of the site.


/api/account

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/account" \
 -d '{
  "lastName" : "lastName",
  "firstName" : "firstName",
  "civility" : "civility",
  "address" : {
    "zipCode" : "zipCode",
    "country" : "country",
    "city" : "city",
    "island" : "island",
    "street" : "street",
    "state" : "state",
    "line2" : "line2",
    "line1" : "line1"
  },
  "phone" : "phone",
  "dateOfBirth" : "2000-01-23",
  "id" : "id",
  "contactPreferences" : {
    "allowPromotionalContact" : true,
    "allowTransportInfoContact" : true
  },
  "userId" : "userId",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        CustomerAccountDto customerAccountDto = ; // CustomerAccountDto | 

        try {
            CustomerAccountDto result = apiInstance.addAccount(customerAccountDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#addAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        CustomerAccountDto customerAccountDto = ; // CustomerAccountDto | 

        try {
            CustomerAccountDto result = apiInstance.addAccount(customerAccountDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#addAccount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
CustomerAccountDto *customerAccountDto = ; // 

[apiInstance addAccountWith:customerAccountDto
              completionHandler: ^(CustomerAccountDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var customerAccountDto = ; // {CustomerAccountDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var customerAccountDto = new CustomerAccountDto(); // CustomerAccountDto | 

            try {
                CustomerAccountDto result = apiInstance.addAccount(customerAccountDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.addAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$customerAccountDto = ; // CustomerAccountDto | 

try {
    $result = $api_instance->addAccount($customerAccountDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->addAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $customerAccountDto = WWW::OPenAPIClient::Object::CustomerAccountDto->new(); # CustomerAccountDto | 

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
customerAccountDto =  # CustomerAccountDto | 

try:
    api_response = api_instance.add_account(customerAccountDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->addAccount: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let customerAccountDto = ; // CustomerAccountDto

    let mut context = CrmApi::Context::default();
    let result = client.addAccount(customerAccountDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
customerAccountDto *

The body contains the information entered by the user

Responses


getAccount

Returns the information of a given user.


/api/accounts/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/accounts/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            CustomerAccountDto result = apiInstance.getAccount(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            CustomerAccountDto result = apiInstance.getAccount(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getAccountWith:id
              completionHandler: ^(CustomerAccountDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                CustomerAccountDto result = apiInstance.getAccount(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getAccount($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_account(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getAccount: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CrmApi::Context::default();
    let result = client.getAccount(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getAccountLoyalty

Returns the loyalty account information of a given user.


/api/accounts/{id}/loyalty-program

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/accounts/{id}/loyalty-program"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            CustomerLoyaltyDto result = apiInstance.getAccountLoyalty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountLoyalty");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            CustomerLoyaltyDto result = apiInstance.getAccountLoyalty(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountLoyalty");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getAccountLoyaltyWith:id
              completionHandler: ^(CustomerLoyaltyDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                CustomerLoyaltyDto result = apiInstance.getAccountLoyalty(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getAccountLoyalty: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getAccountLoyalty($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getAccountLoyalty: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_account_loyalty(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getAccountLoyalty: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CrmApi::Context::default();
    let result = client.getAccountLoyalty(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getAccountOrders

Search customer orders.


/api/accounts/{id}/orders

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/accounts/{id}/orders?createdAfter=2013-10-20&createdBefore=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on
        date createdAfter = 2013-10-20; // date | Search period start date
        date createdBefore = 2013-10-20; // date | Search period end date

        try {
            OrderPageDto result = apiInstance.getAccountOrders(id, createdAfter, createdBefore);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountOrders");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on
        date createdAfter = 2013-10-20; // date | Search period start date
        date createdBefore = 2013-10-20; // date | Search period end date

        try {
            OrderPageDto result = apiInstance.getAccountOrders(id, createdAfter, createdBefore);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountOrders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)
date *createdAfter = 2013-10-20; // Search period start date (optional) (default to null)
date *createdBefore = 2013-10-20; // Search period end date (optional) (default to null)

[apiInstance getAccountOrdersWith:id
    createdAfter:createdAfter
    createdBefore:createdBefore
              completionHandler: ^(OrderPageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on
var opts = {
  'createdAfter': 2013-10-20, // {date} Search period start date
  'createdBefore': 2013-10-20 // {date} Search period end date
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountOrders(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)
            var createdAfter = 2013-10-20;  // date | Search period start date (optional)  (default to null)
            var createdBefore = 2013-10-20;  // date | Search period end date (optional)  (default to null)

            try {
                OrderPageDto result = apiInstance.getAccountOrders(id, createdAfter, createdBefore);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getAccountOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on
$createdAfter = 2013-10-20; // date | Search period start date
$createdBefore = 2013-10-20; // date | Search period end date

try {
    $result = $api_instance->getAccountOrders($id, $createdAfter, $createdBefore);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getAccountOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on
my $createdAfter = 2013-10-20; # date | Search period start date
my $createdBefore = 2013-10-20; # date | Search period end date

eval {
    my $result = $api_instance->getAccountOrders(id => $id, createdAfter => $createdAfter, createdBefore => $createdBefore);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CrmApi->getAccountOrders: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)
createdAfter = 2013-10-20 # date | Search period start date (optional) (default to null)
createdBefore = 2013-10-20 # date | Search period end date (optional) (default to null)

try:
    api_response = api_instance.get_account_orders(id, createdAfter=createdAfter, createdBefore=createdBefore)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getAccountOrders: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String
    let createdAfter = 2013-10-20; // date
    let createdBefore = 2013-10-20; // date

    let mut context = CrmApi::Context::default();
    let result = client.getAccountOrders(id, createdAfter, createdBefore, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required
Query parameters
Name Description
createdAfter
date (date)
Search period start date
createdBefore
date (date)
Search period end date

Responses


getAccountSubscriptions

Returns all subscriptions of the user.


/api/accounts/{id}/subscriptions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/accounts/{id}/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketPageDto result = apiInstance.getAccountSubscriptions(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountSubscriptions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketPageDto result = apiInstance.getAccountSubscriptions(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountSubscriptions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getAccountSubscriptionsWith:id
              completionHandler: ^(TicketPageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                TicketPageDto result = apiInstance.getAccountSubscriptions(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getAccountSubscriptions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getAccountSubscriptions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getAccountSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_account_subscriptions(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getAccountSubscriptions: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CrmApi::Context::default();
    let result = client.getAccountSubscriptions(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getAccountTickets

Customer ID + Valid Bar Code ( Home screen once logged in => All my valid tickets )


/api/accounts/{id}/tickets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/accounts/{id}/tickets"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketPageDto result = apiInstance.getAccountTickets(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountTickets");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketPageDto result = apiInstance.getAccountTickets(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getAccountTickets");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getAccountTicketsWith:id
              completionHandler: ^(TicketPageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                TicketPageDto result = apiInstance.getAccountTickets(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getAccountTickets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getAccountTickets($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getAccountTickets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_account_tickets(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getAccountTickets: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CrmApi::Context::default();
    let result = client.getAccountTickets(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getCustomerPicture

Returns the picture of a user.


/api/accounts/{id}/picture

Usage and SDK Samples

curl -X GET \
 -H "Accept: image/png" \
 "http://localhost/api/accounts/{id}/picture"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getCustomerPicture(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getCustomerPicture");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getCustomerPicture(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#getCustomerPicture");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getCustomerPictureWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                File result = apiInstance.getCustomerPicture(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.getCustomerPicture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getCustomerPicture($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->getCustomerPicture: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_customer_picture(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->getCustomerPicture: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String

    let mut context = CrmApi::Context::default();
    let result = client.getCustomerPicture(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


updateAccount

Modification of a user's information.


/api/account/{id}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/account/{id}" \
 -d '{
  "lastName" : "lastName",
  "firstName" : "firstName",
  "civility" : "civility",
  "address" : {
    "zipCode" : "zipCode",
    "country" : "country",
    "city" : "city",
    "island" : "island",
    "street" : "street",
    "state" : "state",
    "line2" : "line2",
    "line1" : "line1"
  },
  "phone" : "phone",
  "dateOfBirth" : "2000-01-23",
  "id" : "id",
  "contactPreferences" : {
    "allowPromotionalContact" : true,
    "allowTransportInfoContact" : true
  },
  "userId" : "userId",
  "email" : "email"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CrmApi;

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

public class CrmApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on
        CustomerAccountDto customerAccountDto = ; // CustomerAccountDto | 

        try {
            CustomerAccountDto result = apiInstance.updateAccount(id, customerAccountDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#updateAccount");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CrmApi;

public class CrmApiExample {
    public static void main(String[] args) {
        CrmApi apiInstance = new CrmApi();
        String id = id_example; // String | ID of record to operate on
        CustomerAccountDto customerAccountDto = ; // CustomerAccountDto | 

        try {
            CustomerAccountDto result = apiInstance.updateAccount(id, customerAccountDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CrmApi#updateAccount");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
CrmApi *apiInstance = [[CrmApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)
CustomerAccountDto *customerAccountDto = ; // 

[apiInstance updateAccountWith:id
    customerAccountDto:customerAccountDto
              completionHandler: ^(CustomerAccountDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.CrmApi()
var id = id_example; // {String} ID of record to operate on
var customerAccountDto = ; // {CustomerAccountDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAccount(id, customerAccountDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new CrmApi();
            var id = id_example;  // String | ID of record to operate on (default to null)
            var customerAccountDto = new CustomerAccountDto(); // CustomerAccountDto | 

            try {
                CustomerAccountDto result = apiInstance.updateAccount(id, customerAccountDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CrmApi.updateAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CrmApi();
$id = id_example; // String | ID of record to operate on
$customerAccountDto = ; // CustomerAccountDto | 

try {
    $result = $api_instance->updateAccount($id, $customerAccountDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CrmApi->updateAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CrmApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CrmApi->new();
my $id = id_example; # String | ID of record to operate on
my $customerAccountDto = WWW::OPenAPIClient::Object::CustomerAccountDto->new(); # CustomerAccountDto | 

eval {
    my $result = $api_instance->updateAccount(id => $id, customerAccountDto => $customerAccountDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CrmApi->updateAccount: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CrmApi()
id = id_example # String | ID of record to operate on (default to null)
customerAccountDto =  # CustomerAccountDto | 

try:
    api_response = api_instance.update_account(id, customerAccountDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CrmApi->updateAccount: %s\n" % e)
extern crate CrmApi;

pub fn main() {
    let id = id_example; // String
    let customerAccountDto = ; // CustomerAccountDto

    let mut context = CrmApi::Context::default();
    let result = client.updateAccount(id, customerAccountDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required
Body parameters
Name Description
customerAccountDto *

The body contains the information that the user has modified

Responses


Operations

getTrip

Get trip by ID.


/api/trips/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/trips/{id}?departureDate=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperationsApi;

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

public class OperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OperationsApi apiInstance = new OperationsApi();
        String id = id_example; // String | ID of record to operate on
        date departureDate = 2013-10-20; // date | Search by departure date

        try {
            array[TripDto] result = apiInstance.getTrip(id, departureDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#getTrip");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperationsApi;

public class OperationsApiExample {
    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        String id = id_example; // String | ID of record to operate on
        date departureDate = 2013-10-20; // date | Search by departure date

        try {
            array[TripDto] result = apiInstance.getTrip(id, departureDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#getTrip");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OperationsApi *apiInstance = [[OperationsApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)
date *departureDate = 2013-10-20; // Search by departure date (optional) (default to null)

[apiInstance getTripWith:id
    departureDate:departureDate
              completionHandler: ^(array[TripDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.OperationsApi()
var id = id_example; // {String} ID of record to operate on
var opts = {
  'departureDate': 2013-10-20 // {date} Search by departure date
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTrip(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new OperationsApi();
            var id = id_example;  // String | ID of record to operate on (default to null)
            var departureDate = 2013-10-20;  // date | Search by departure date (optional)  (default to null)

            try {
                array[TripDto] result = apiInstance.getTrip(id, departureDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperationsApi.getTrip: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OperationsApi();
$id = id_example; // String | ID of record to operate on
$departureDate = 2013-10-20; // date | Search by departure date

try {
    $result = $api_instance->getTrip($id, $departureDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->getTrip: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OperationsApi->new();
my $id = id_example; # String | ID of record to operate on
my $departureDate = 2013-10-20; # date | Search by departure date

eval {
    my $result = $api_instance->getTrip(id => $id, departureDate => $departureDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperationsApi->getTrip: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OperationsApi()
id = id_example # String | ID of record to operate on (default to null)
departureDate = 2013-10-20 # date | Search by departure date (optional) (default to null)

try:
    api_response = api_instance.get_trip(id, departureDate=departureDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperationsApi->getTrip: %s\n" % e)
extern crate OperationsApi;

pub fn main() {
    let id = id_example; // String
    let departureDate = 2013-10-20; // date

    let mut context = OperationsApi::Context::default();
    let result = client.getTrip(id, departureDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required
Query parameters
Name Description
departureDate
date (date)
Search by departure date

Responses


getTripParkingGauge

Returns parking space gauge.


/api/trips/{id}/parking-gauge

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/trips/{id}/parking-gauge?island=island_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperationsApi;

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

public class OperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OperationsApi apiInstance = new OperationsApi();
        String id = id_example; // String | departure boat is "catam" (aremiti 6) or "ferry"
        String island = island_example; // String | departure island is "moorea" or "tahiti"

        try {
            'String' result = apiInstance.getTripParkingGauge(id, island);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#getTripParkingGauge");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperationsApi;

public class OperationsApiExample {
    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        String id = id_example; // String | departure boat is "catam" (aremiti 6) or "ferry"
        String island = island_example; // String | departure island is "moorea" or "tahiti"

        try {
            'String' result = apiInstance.getTripParkingGauge(id, island);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#getTripParkingGauge");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OperationsApi *apiInstance = [[OperationsApi alloc] init];
String *id = id_example; // departure boat is "catam" (aremiti 6) or "ferry" (default to null)
String *island = island_example; // departure island is "moorea" or "tahiti" (optional) (default to null)

[apiInstance getTripParkingGaugeWith:id
    island:island
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.OperationsApi()
var id = id_example; // {String} departure boat is "catam" (aremiti 6) or "ferry"
var opts = {
  'island': island_example // {String} departure island is "moorea" or "tahiti"
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTripParkingGauge(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new OperationsApi();
            var id = id_example;  // String | departure boat is "catam" (aremiti 6) or "ferry" (default to null)
            var island = island_example;  // String | departure island is "moorea" or "tahiti" (optional)  (default to null)

            try {
                'String' result = apiInstance.getTripParkingGauge(id, island);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperationsApi.getTripParkingGauge: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OperationsApi();
$id = id_example; // String | departure boat is "catam" (aremiti 6) or "ferry"
$island = island_example; // String | departure island is "moorea" or "tahiti"

try {
    $result = $api_instance->getTripParkingGauge($id, $island);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->getTripParkingGauge: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OperationsApi->new();
my $id = id_example; # String | departure boat is "catam" (aremiti 6) or "ferry"
my $island = island_example; # String | departure island is "moorea" or "tahiti"

eval {
    my $result = $api_instance->getTripParkingGauge(id => $id, island => $island);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperationsApi->getTripParkingGauge: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OperationsApi()
id = id_example # String | departure boat is "catam" (aremiti 6) or "ferry" (default to null)
island = island_example # String | departure island is "moorea" or "tahiti" (optional) (default to null)

try:
    api_response = api_instance.get_trip_parking_gauge(id, island=island)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperationsApi->getTripParkingGauge: %s\n" % e)
extern crate OperationsApi;

pub fn main() {
    let id = id_example; // String
    let island = island_example; // String

    let mut context = OperationsApi::Context::default();
    let result = client.getTripParkingGauge(id, island, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
departure boat is "catam" (aremiti 6) or "ferry"
Required
Query parameters
Name Description
island
String
departure island is "moorea" or "tahiti"

Responses


searchTrips

Search trips.


/api/trips

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/trips?departureAfter=2013-10-20&departureBefore=2013-10-20"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.OperationsApi;

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

public class OperationsApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        OperationsApi apiInstance = new OperationsApi();
        date departureAfter = 2013-10-20; // date | Search period start date
        date departureBefore = 2013-10-20; // date | Search period end date

        try {
            array[TripDto] result = apiInstance.searchTrips(departureAfter, departureBefore);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#searchTrips");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.OperationsApi;

public class OperationsApiExample {
    public static void main(String[] args) {
        OperationsApi apiInstance = new OperationsApi();
        date departureAfter = 2013-10-20; // date | Search period start date
        date departureBefore = 2013-10-20; // date | Search period end date

        try {
            array[TripDto] result = apiInstance.searchTrips(departureAfter, departureBefore);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperationsApi#searchTrips");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
OperationsApi *apiInstance = [[OperationsApi alloc] init];
date *departureAfter = 2013-10-20; // Search period start date (optional) (default to null)
date *departureBefore = 2013-10-20; // Search period end date (optional) (default to null)

[apiInstance searchTripsWith:departureAfter
    departureBefore:departureBefore
              completionHandler: ^(array[TripDto] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.OperationsApi()
var opts = {
  'departureAfter': 2013-10-20, // {date} Search period start date
  'departureBefore': 2013-10-20 // {date} Search period end date
};

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

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

            // Create an instance of the API class
            var apiInstance = new OperationsApi();
            var departureAfter = 2013-10-20;  // date | Search period start date (optional)  (default to null)
            var departureBefore = 2013-10-20;  // date | Search period end date (optional)  (default to null)

            try {
                array[TripDto] result = apiInstance.searchTrips(departureAfter, departureBefore);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling OperationsApi.searchTrips: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\OperationsApi();
$departureAfter = 2013-10-20; // date | Search period start date
$departureBefore = 2013-10-20; // date | Search period end date

try {
    $result = $api_instance->searchTrips($departureAfter, $departureBefore);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperationsApi->searchTrips: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::OperationsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::OperationsApi->new();
my $departureAfter = 2013-10-20; # date | Search period start date
my $departureBefore = 2013-10-20; # date | Search period end date

eval {
    my $result = $api_instance->searchTrips(departureAfter => $departureAfter, departureBefore => $departureBefore);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperationsApi->searchTrips: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.OperationsApi()
departureAfter = 2013-10-20 # date | Search period start date (optional) (default to null)
departureBefore = 2013-10-20 # date | Search period end date (optional) (default to null)

try:
    api_response = api_instance.search_trips(departureAfter=departureAfter, departureBefore=departureBefore)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperationsApi->searchTrips: %s\n" % e)
extern crate OperationsApi;

pub fn main() {
    let departureAfter = 2013-10-20; // date
    let departureBefore = 2013-10-20; // date

    let mut context = OperationsApi::Context::default();
    let result = client.searchTrips(departureAfter, departureBefore, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
departureAfter
date (date)
Search period start date
departureBefore
date (date)
Search period end date

Responses


Payment

addOrderPayment

Add a payment for an order. When adding a successful payment, order status is updated. Failed payment are stored in backend for later investigation. Depending on the requested content-type of the response, We either return the updated status or an HTML iframe for redirection.


/api/order/{id}/payment

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "http://localhost/api/order/{id}/payment" \
 -d '{
  "reference" : "reference",
  "keycloakId" : "keycloakId",
  "source" : "source",
  "status" : "status"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentApi;

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

public class PaymentApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PaymentApi apiInstance = new PaymentApi();
        String id = id_example; // String | ID of record to operate on
        PaymentDto paymentDto = ; // PaymentDto | 

        try {
            OrderDto result = apiInstance.addOrderPayment(id, paymentDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#addOrderPayment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentApi;

public class PaymentApiExample {
    public static void main(String[] args) {
        PaymentApi apiInstance = new PaymentApi();
        String id = id_example; // String | ID of record to operate on
        PaymentDto paymentDto = ; // PaymentDto | 

        try {
            OrderDto result = apiInstance.addOrderPayment(id, paymentDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#addOrderPayment");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PaymentApi *apiInstance = [[PaymentApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)
PaymentDto *paymentDto = ; // 

[apiInstance addOrderPaymentWith:id
    paymentDto:paymentDto
              completionHandler: ^(OrderDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.PaymentApi()
var id = id_example; // {String} ID of record to operate on
var paymentDto = ; // {PaymentDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOrderPayment(id, paymentDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PaymentApi();
            var id = id_example;  // String | ID of record to operate on (default to null)
            var paymentDto = new PaymentDto(); // PaymentDto | 

            try {
                OrderDto result = apiInstance.addOrderPayment(id, paymentDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentApi.addOrderPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentApi();
$id = id_example; // String | ID of record to operate on
$paymentDto = ; // PaymentDto | 

try {
    $result = $api_instance->addOrderPayment($id, $paymentDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->addOrderPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentApi->new();
my $id = id_example; # String | ID of record to operate on
my $paymentDto = WWW::OPenAPIClient::Object::PaymentDto->new(); # PaymentDto | 

eval {
    my $result = $api_instance->addOrderPayment(id => $id, paymentDto => $paymentDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentApi->addOrderPayment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.PaymentApi()
id = id_example # String | ID of record to operate on (default to null)
paymentDto =  # PaymentDto | 

try:
    api_response = api_instance.add_order_payment(id, paymentDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentApi->addOrderPayment: %s\n" % e)
extern crate PaymentApi;

pub fn main() {
    let id = id_example; // String
    let paymentDto = ; // PaymentDto

    let mut context = PaymentApi::Context::default();
    let result = client.addOrderPayment(id, paymentDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required
Body parameters
Name Description
paymentDto *

Payment data.

Responses


getOrderPayment

Get a payment status for an order. When adding a successful payment, order status is updated. Payzen return response to PWA and IPN is sending to the API, The PWA must check if the status payment on the API.


/api/order/{id}/payment

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/order/{id}/payment"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentApi;

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

public class PaymentApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PaymentApi apiInstance = new PaymentApi();
        String id = id_example; // String | ID of record to operate on

        try {
            OrderDto result = apiInstance.getOrderPayment(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#getOrderPayment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentApi;

public class PaymentApiExample {
    public static void main(String[] args) {
        PaymentApi apiInstance = new PaymentApi();
        String id = id_example; // String | ID of record to operate on

        try {
            OrderDto result = apiInstance.getOrderPayment(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentApi#getOrderPayment");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PaymentApi *apiInstance = [[PaymentApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getOrderPaymentWith:id
              completionHandler: ^(OrderDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.PaymentApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new PaymentApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                OrderDto result = apiInstance.getOrderPayment(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentApi.getOrderPayment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getOrderPayment($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->getOrderPayment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.PaymentApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_order_payment(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentApi->getOrderPayment: %s\n" % e)
extern crate PaymentApi;

pub fn main() {
    let id = id_example; // String

    let mut context = PaymentApi::Context::default();
    let result = client.getOrderPayment(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


Payzen

updateTransactionState

'This endpoint is to be consumed exclusively by PayZen.' 'Its purpose is to allow PayZen to update transactions states into ABMS.'


/api/payzen

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/payzen" \
 -d '{
  "vads_payment_cards" : "vads_payment_cards",
  "vads_url_error" : "vads_url_error",
  "signature" : "signature",
  "vads_url_success" : "vads_url_success",
  "vads_validation_mode" : "vads_validation_mode",
  "vads_trans_date" : "vads_trans_date",
  "vads_ctx_mode" : "vads_ctx_mode",
  "vads_action_mode" : "vads_action_mode",
  "vads_page_action" : "vads_page_action",
  "vads_redirect_success_timeout" : "vads_redirect_success_timeout",
  "vads_redirect_error_timeout" : "vads_redirect_error_timeout",
  "vads_currency" : "vads_currency",
  "vads_version" : "vads_version",
  "vads_capture_delay" : "vads_capture_delay",
  "vads_trans_id" : "vads_trans_id",
  "vads_ext_info_id_payzen" : "vads_ext_info_id_payzen",
  "vads_amount" : 0,
  "vads_url_cancel" : "vads_url_cancel",
  "vads_cust_email" : "vads_cust_email",
  "vads_payment_config" : "vads_payment_config",
  "vads_url_refused" : "vads_url_refused",
  "vads_site_id" : "vads_site_id"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PayzenApi;

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

public class PayzenApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        PayzenApi apiInstance = new PayzenApi();
        PayzenIPNDto payzenIPNDto = ; // PayzenIPNDto | 

        try {
            apiInstance.updateTransactionState(payzenIPNDto);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayzenApi#updateTransactionState");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PayzenApi;

public class PayzenApiExample {
    public static void main(String[] args) {
        PayzenApi apiInstance = new PayzenApi();
        PayzenIPNDto payzenIPNDto = ; // PayzenIPNDto | 

        try {
            apiInstance.updateTransactionState(payzenIPNDto);
        } catch (ApiException e) {
            System.err.println("Exception when calling PayzenApi#updateTransactionState");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PayzenApi *apiInstance = [[PayzenApi alloc] init];
PayzenIPNDto *payzenIPNDto = ; // 

[apiInstance updateTransactionStateWith:payzenIPNDto
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.PayzenApi()
var payzenIPNDto = ; // {PayzenIPNDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTransactionState(payzenIPNDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new PayzenApi();
            var payzenIPNDto = new PayzenIPNDto(); // PayzenIPNDto | 

            try {
                apiInstance.updateTransactionState(payzenIPNDto);
            } catch (Exception e) {
                Debug.Print("Exception when calling PayzenApi.updateTransactionState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PayzenApi();
$payzenIPNDto = ; // PayzenIPNDto | 

try {
    $api_instance->updateTransactionState($payzenIPNDto);
} catch (Exception $e) {
    echo 'Exception when calling PayzenApi->updateTransactionState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PayzenApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PayzenApi->new();
my $payzenIPNDto = WWW::OPenAPIClient::Object::PayzenIPNDto->new(); # PayzenIPNDto | 

eval {
    $api_instance->updateTransactionState(payzenIPNDto => $payzenIPNDto);
};
if ($@) {
    warn "Exception when calling PayzenApi->updateTransactionState: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.PayzenApi()
payzenIPNDto =  # PayzenIPNDto | 

try:
    api_instance.update_transaction_state(payzenIPNDto)
except ApiException as e:
    print("Exception when calling PayzenApi->updateTransactionState: %s\n" % e)
extern crate PayzenApi;

pub fn main() {
    let payzenIPNDto = ; // PayzenIPNDto

    let mut context = PayzenApi::Context::default();
    let result = client.updateTransactionState(payzenIPNDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
payzenIPNDto *

Contains the up-to-date state for a given transaction.

Responses


Sales

addOrder

Create an order (ie a cart).


/api/order

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/order" \
 -d '{
  "accountId" : "accountId",
  "pointOfSale" : "pointOfSale",
  "purchaseDate" : "2000-01-23",
  "cancellationReason" : [ {
    "date" : "2000-01-23",
    "author" : "author",
    "comment" : "comment"
  }, {
    "date" : "2000-01-23",
    "author" : "author",
    "comment" : "comment"
  } ],
  "id" : "id",
  "successfulPayment" : {
    "reference" : "reference",
    "keycloakId" : "keycloakId",
    "source" : "source",
    "status" : "status"
  },
  "items" : [ {
    "quantity" : 0,
    "tickets" : [ {
      "purchaseDate" : "2000-01-23",
      "booking" : {
        "tripId" : "tripId"
      },
      "code" : "code",
      "productId" : "productId",
      "cancellationReason" : [ {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      }, {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      } ],
      "initialCredit" : 0,
      "scanDate" : "2000-01-23",
      "packId" : "packId",
      "reference" : "reference",
      "validityPeriod" : {
        "start" : "2000-01-23",
        "end" : "2000-01-23"
      },
      "idDossier" : "idDossier",
      "currentCredit" : 0,
      "isTacitlyRenewable" : true,
      "id" : "id",
      "status" : "status"
    }, {
      "purchaseDate" : "2000-01-23",
      "booking" : {
        "tripId" : "tripId"
      },
      "code" : "code",
      "productId" : "productId",
      "cancellationReason" : [ {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      }, {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      } ],
      "initialCredit" : 0,
      "scanDate" : "2000-01-23",
      "packId" : "packId",
      "reference" : "reference",
      "validityPeriod" : {
        "start" : "2000-01-23",
        "end" : "2000-01-23"
      },
      "idDossier" : "idDossier",
      "currentCredit" : 0,
      "isTacitlyRenewable" : true,
      "id" : "id",
      "status" : "status"
    } ],
    "productId" : "productId",
    "cancellationReason" : [ {
      "date" : "2000-01-23",
      "author" : "author",
      "comment" : "comment"
    }, {
      "date" : "2000-01-23",
      "author" : "author",
      "comment" : "comment"
    } ],
    "productName" : "productName",
    "pricing" : {
      "fee" : {
        "amount" : 0.8008281904610115
      },
      "netPrice" : {
        "amount" : 0.8008281904610115
      },
      "grossPrice" : {
        "amount" : 0.8008281904610115
      },
      "tax" : {
        "amount" : 0.8008281904610115
      },
      "taxCPS" : {
        "amount" : 0.8008281904610115
      }
    },
    "status" : "status"
  }, {
    "quantity" : 0,
    "tickets" : [ {
      "purchaseDate" : "2000-01-23",
      "booking" : {
        "tripId" : "tripId"
      },
      "code" : "code",
      "productId" : "productId",
      "cancellationReason" : [ {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      }, {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      } ],
      "initialCredit" : 0,
      "scanDate" : "2000-01-23",
      "packId" : "packId",
      "reference" : "reference",
      "validityPeriod" : {
        "start" : "2000-01-23",
        "end" : "2000-01-23"
      },
      "idDossier" : "idDossier",
      "currentCredit" : 0,
      "isTacitlyRenewable" : true,
      "id" : "id",
      "status" : "status"
    }, {
      "purchaseDate" : "2000-01-23",
      "booking" : {
        "tripId" : "tripId"
      },
      "code" : "code",
      "productId" : "productId",
      "cancellationReason" : [ {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      }, {
        "date" : "2000-01-23",
        "author" : "author",
        "comment" : "comment"
      } ],
      "initialCredit" : 0,
      "scanDate" : "2000-01-23",
      "packId" : "packId",
      "reference" : "reference",
      "validityPeriod" : {
        "start" : "2000-01-23",
        "end" : "2000-01-23"
      },
      "idDossier" : "idDossier",
      "currentCredit" : 0,
      "isTacitlyRenewable" : true,
      "id" : "id",
      "status" : "status"
    } ],
    "productId" : "productId",
    "cancellationReason" : [ {
      "date" : "2000-01-23",
      "author" : "author",
      "comment" : "comment"
    }, {
      "date" : "2000-01-23",
      "author" : "author",
      "comment" : "comment"
    } ],
    "productName" : "productName",
    "pricing" : {
      "fee" : {
        "amount" : 0.8008281904610115
      },
      "netPrice" : {
        "amount" : 0.8008281904610115
      },
      "grossPrice" : {
        "amount" : 0.8008281904610115
      },
      "tax" : {
        "amount" : 0.8008281904610115
      },
      "taxCPS" : {
        "amount" : 0.8008281904610115
      }
    },
    "status" : "status"
  } ],
  "pricing" : {
    "fee" : {
      "amount" : 0.8008281904610115
    },
    "netPrice" : {
      "amount" : 0.8008281904610115
    },
    "grossPrice" : {
      "amount" : 0.8008281904610115
    },
    "tax" : {
      "amount" : 0.8008281904610115
    },
    "taxCPS" : {
      "amount" : 0.8008281904610115
    }
  },
  "status" : "status"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SalesApi;

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

public class SalesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SalesApi apiInstance = new SalesApi();
        OrderDto orderDto = ; // OrderDto | 

        try {
            OrderDto result = apiInstance.addOrder(orderDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#addOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SalesApi;

public class SalesApiExample {
    public static void main(String[] args) {
        SalesApi apiInstance = new SalesApi();
        OrderDto orderDto = ; // OrderDto | 

        try {
            OrderDto result = apiInstance.addOrder(orderDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#addOrder");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SalesApi *apiInstance = [[SalesApi alloc] init];
OrderDto *orderDto = ; // 

[apiInstance addOrderWith:orderDto
              completionHandler: ^(OrderDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.SalesApi()
var orderDto = ; // {OrderDto} 

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

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

            // Create an instance of the API class
            var apiInstance = new SalesApi();
            var orderDto = new OrderDto(); // OrderDto | 

            try {
                OrderDto result = apiInstance.addOrder(orderDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SalesApi.addOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SalesApi();
$orderDto = ; // OrderDto | 

try {
    $result = $api_instance->addOrder($orderDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesApi->addOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SalesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SalesApi->new();
my $orderDto = WWW::OPenAPIClient::Object::OrderDto->new(); # OrderDto | 

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

# Create an instance of the API class
api_instance = openapi_client.SalesApi()
orderDto =  # OrderDto | 

try:
    api_response = api_instance.add_order(orderDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SalesApi->addOrder: %s\n" % e)
extern crate SalesApi;

pub fn main() {
    let orderDto = ; // OrderDto

    let mut context = SalesApi::Context::default();
    let result = client.addOrder(orderDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
orderDto *

Order data.

Responses


getOrder

Get order by ID.


/api/orders/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/orders/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SalesApi;

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

public class SalesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SalesApi apiInstance = new SalesApi();
        String id = id_example; // String | ID of record to operate on

        try {
            OrderDto result = apiInstance.getOrder(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getOrder");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SalesApi;

public class SalesApiExample {
    public static void main(String[] args) {
        SalesApi apiInstance = new SalesApi();
        String id = id_example; // String | ID of record to operate on

        try {
            OrderDto result = apiInstance.getOrder(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getOrder");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SalesApi *apiInstance = [[SalesApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getOrderWith:id
              completionHandler: ^(OrderDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.SalesApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new SalesApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                OrderDto result = apiInstance.getOrder(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SalesApi.getOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SalesApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getOrder($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesApi->getOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SalesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SalesApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.SalesApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_order(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SalesApi->getOrder: %s\n" % e)
extern crate SalesApi;

pub fn main() {
    let id = id_example; // String

    let mut context = SalesApi::Context::default();
    let result = client.getOrder(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getPackages

Search packages available today.


/api/packages

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/packages"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SalesApi;

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

public class SalesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SalesApi apiInstance = new SalesApi();

        try {
            PackagePageDto result = apiInstance.getPackages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getPackages");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SalesApi;

public class SalesApiExample {
    public static void main(String[] args) {
        SalesApi apiInstance = new SalesApi();

        try {
            PackagePageDto result = apiInstance.getPackages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getPackages");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SalesApi *apiInstance = [[SalesApi alloc] init];

[apiInstance getPackagesWithCompletionHandler: 
              ^(PackagePageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.SalesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPackages(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SalesApi();

            try {
                PackagePageDto result = apiInstance.getPackages();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SalesApi.getPackages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SalesApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SalesApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.SalesApi()

try:
    api_response = api_instance.get_packages()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SalesApi->getPackages: %s\n" % e)
extern crate SalesApi;

pub fn main() {

    let mut context = SalesApi::Context::default();
    let result = client.getPackages(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getProductRate

Get product rate by ID.


/api/product-rates/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/product-rates/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SalesApi;

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

public class SalesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SalesApi apiInstance = new SalesApi();
        String id = id_example; // String | ID of record to operate on

        try {
            ProductRateDto result = apiInstance.getProductRate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getProductRate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SalesApi;

public class SalesApiExample {
    public static void main(String[] args) {
        SalesApi apiInstance = new SalesApi();
        String id = id_example; // String | ID of record to operate on

        try {
            ProductRateDto result = apiInstance.getProductRate(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getProductRate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SalesApi *apiInstance = [[SalesApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getProductRateWith:id
              completionHandler: ^(ProductRateDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.SalesApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new SalesApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                ProductRateDto result = apiInstance.getProductRate(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SalesApi.getProductRate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SalesApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getProductRate($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesApi->getProductRate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SalesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SalesApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.SalesApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_product_rate(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SalesApi->getProductRate: %s\n" % e)
extern crate SalesApi;

pub fn main() {
    let id = id_example; // String

    let mut context = SalesApi::Context::default();
    let result = client.getProductRate(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getProductRates

Returns product rates saleable today on the site.


/api/product-rates

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/product-rates"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SalesApi;

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

public class SalesApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        SalesApi apiInstance = new SalesApi();

        try {
            ProductRatePageDto result = apiInstance.getProductRates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getProductRates");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SalesApi;

public class SalesApiExample {
    public static void main(String[] args) {
        SalesApi apiInstance = new SalesApi();

        try {
            ProductRatePageDto result = apiInstance.getProductRates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SalesApi#getProductRates");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
SalesApi *apiInstance = [[SalesApi alloc] init];

[apiInstance getProductRatesWithCompletionHandler: 
              ^(ProductRatePageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.SalesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProductRates(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new SalesApi();

            try {
                ProductRatePageDto result = apiInstance.getProductRates();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SalesApi.getProductRates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SalesApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SalesApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.SalesApi()

try:
    api_response = api_instance.get_product_rates()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SalesApi->getProductRates: %s\n" % e)
extern crate SalesApi;

pub fn main() {

    let mut context = SalesApi::Context::default();
    let result = client.getProductRates(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


Ticketing

getTicket

Get ticket by ID


/api/tickets/{id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/tickets/{id}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketingApi;

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

public class TicketingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketDto result = apiInstance.getTicket(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicket");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TicketingApi;

public class TicketingApiExample {
    public static void main(String[] args) {
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            TicketDto result = apiInstance.getTicket(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketingApi *apiInstance = [[TicketingApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getTicketWith:id
              completionHandler: ^(TicketDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.TicketingApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new TicketingApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                TicketDto result = apiInstance.getTicket(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketingApi.getTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketingApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getTicket($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketingApi->getTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketingApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.TicketingApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_ticket(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketingApi->getTicket: %s\n" % e)
extern crate TicketingApi;

pub fn main() {
    let id = id_example; // String

    let mut context = TicketingApi::Context::default();
    let result = client.getTicket(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


getTicketBookingValidity

Returns booking status.


/api/tickets/{id}/booking

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/tickets/{id}/booking"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketingApi;

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

public class TicketingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketingApi apiInstance = new TicketingApi();
        String id = 02523G6LUA8; // String | ID booking with 11 alphanumeric characters

        try {
            BookingAvailabilityDto result = apiInstance.getTicketBookingValidity(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicketBookingValidity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TicketingApi;

public class TicketingApiExample {
    public static void main(String[] args) {
        TicketingApi apiInstance = new TicketingApi();
        String id = 02523G6LUA8; // String | ID booking with 11 alphanumeric characters

        try {
            BookingAvailabilityDto result = apiInstance.getTicketBookingValidity(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicketBookingValidity");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketingApi *apiInstance = [[TicketingApi alloc] init];
String *id = 02523G6LUA8; // ID booking with 11 alphanumeric characters (default to null)

[apiInstance getTicketBookingValidityWith:id
              completionHandler: ^(BookingAvailabilityDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.TicketingApi()
var id = 02523G6LUA8; // {String} ID booking with 11 alphanumeric characters

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

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

            // Create an instance of the API class
            var apiInstance = new TicketingApi();
            var id = 02523G6LUA8;  // String | ID booking with 11 alphanumeric characters (default to null)

            try {
                BookingAvailabilityDto result = apiInstance.getTicketBookingValidity(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketingApi.getTicketBookingValidity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketingApi();
$id = 02523G6LUA8; // String | ID booking with 11 alphanumeric characters

try {
    $result = $api_instance->getTicketBookingValidity($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketingApi->getTicketBookingValidity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketingApi->new();
my $id = 02523G6LUA8; # String | ID booking with 11 alphanumeric characters

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

# Create an instance of the API class
api_instance = openapi_client.TicketingApi()
id = 02523G6LUA8 # String | ID booking with 11 alphanumeric characters (default to null)

try:
    api_response = api_instance.get_ticket_booking_validity(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketingApi->getTicketBookingValidity: %s\n" % e)
extern crate TicketingApi;

pub fn main() {
    let id = 02523G6LUA8; // String

    let mut context = TicketingApi::Context::default();
    let result = client.getTicketBookingValidity(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID booking with 11 alphanumeric characters
Required

Responses


getTicketPdf

Return ticket pdf file.


/api/tickets/{id}/printable

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/pdf" \
 "http://localhost/api/tickets/{id}/printable"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketingApi;

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

public class TicketingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getTicketPdf(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicketPdf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TicketingApi;

public class TicketingApiExample {
    public static void main(String[] args) {
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on

        try {
            File result = apiInstance.getTicketPdf(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#getTicketPdf");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketingApi *apiInstance = [[TicketingApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)

[apiInstance getTicketPdfWith:id
              completionHandler: ^(File output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.TicketingApi()
var id = id_example; // {String} ID of record to operate on

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

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

            // Create an instance of the API class
            var apiInstance = new TicketingApi();
            var id = id_example;  // String | ID of record to operate on (default to null)

            try {
                File result = apiInstance.getTicketPdf(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketingApi.getTicketPdf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketingApi();
$id = id_example; // String | ID of record to operate on

try {
    $result = $api_instance->getTicketPdf($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketingApi->getTicketPdf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketingApi->new();
my $id = id_example; # String | ID of record to operate on

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

# Create an instance of the API class
api_instance = openapi_client.TicketingApi()
id = id_example # String | ID of record to operate on (default to null)

try:
    api_response = api_instance.get_ticket_pdf(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketingApi->getTicketPdf: %s\n" % e)
extern crate TicketingApi;

pub fn main() {
    let id = id_example; // String

    let mut context = TicketingApi::Context::default();
    let result = client.getTicketPdf(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required

Responses


searchTicket

Search tickets by id dossier.


/api/tickets

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/tickets?idDossier=idDossier_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketingApi;

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

public class TicketingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketingApi apiInstance = new TicketingApi();
        String idDossier = idDossier_example; // String | Id dossier from a ticket (voucher or vhl ticket)

        try {
            TicketPageDto result = apiInstance.searchTicket(idDossier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#searchTicket");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TicketingApi;

public class TicketingApiExample {
    public static void main(String[] args) {
        TicketingApi apiInstance = new TicketingApi();
        String idDossier = idDossier_example; // String | Id dossier from a ticket (voucher or vhl ticket)

        try {
            TicketPageDto result = apiInstance.searchTicket(idDossier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#searchTicket");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketingApi *apiInstance = [[TicketingApi alloc] init];
String *idDossier = idDossier_example; // Id dossier from a ticket (voucher or vhl ticket) (default to null)

[apiInstance searchTicketWith:idDossier
              completionHandler: ^(TicketPageDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.TicketingApi()
var idDossier = idDossier_example; // {String} Id dossier from a ticket (voucher or vhl ticket)

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

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

            // Create an instance of the API class
            var apiInstance = new TicketingApi();
            var idDossier = idDossier_example;  // String | Id dossier from a ticket (voucher or vhl ticket) (default to null)

            try {
                TicketPageDto result = apiInstance.searchTicket(idDossier);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketingApi.searchTicket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketingApi();
$idDossier = idDossier_example; // String | Id dossier from a ticket (voucher or vhl ticket)

try {
    $result = $api_instance->searchTicket($idDossier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketingApi->searchTicket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketingApi->new();
my $idDossier = idDossier_example; # String | Id dossier from a ticket (voucher or vhl ticket)

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

# Create an instance of the API class
api_instance = openapi_client.TicketingApi()
idDossier = idDossier_example # String | Id dossier from a ticket (voucher or vhl ticket) (default to null)

try:
    api_response = api_instance.search_ticket(idDossier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketingApi->searchTicket: %s\n" % e)
extern crate TicketingApi;

pub fn main() {
    let idDossier = idDossier_example; // String

    let mut context = TicketingApi::Context::default();
    let result = client.searchTicket(idDossier, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
idDossier*
String
Id dossier from a ticket (voucher or vhl ticket)
Required

Responses


updateTicketBooking

Exchange corresponds to a booking modification of a given ticket.


/api/tickets/{id}/booking

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/tickets/{id}/booking" \
 -d '{
  "booking" : [ {
    "tripId" : "tripId"
  }, {
    "tripId" : "tripId"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TicketingApi;

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

public class TicketingApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on
        BookingPageDto bookingPageDto = ; // BookingPageDto | 

        try {
            TicketDto result = apiInstance.updateTicketBooking(id, bookingPageDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#updateTicketBooking");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TicketingApi;

public class TicketingApiExample {
    public static void main(String[] args) {
        TicketingApi apiInstance = new TicketingApi();
        String id = id_example; // String | ID of record to operate on
        BookingPageDto bookingPageDto = ; // BookingPageDto | 

        try {
            TicketDto result = apiInstance.updateTicketBooking(id, bookingPageDto);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TicketingApi#updateTicketBooking");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TicketingApi *apiInstance = [[TicketingApi alloc] init];
String *id = id_example; // ID of record to operate on (default to null)
BookingPageDto *bookingPageDto = ; // 

[apiInstance updateTicketBookingWith:id
    bookingPageDto:bookingPageDto
              completionHandler: ^(TicketDto output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AbmsPublicApi = require('abms_public_api');

// Create an instance of the API class
var api = new AbmsPublicApi.TicketingApi()
var id = id_example; // {String} ID of record to operate on
var bookingPageDto = ; // {BookingPageDto} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateTicketBooking(id, bookingPageDto, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TicketingApi();
            var id = id_example;  // String | ID of record to operate on (default to null)
            var bookingPageDto = new BookingPageDto(); // BookingPageDto | 

            try {
                TicketDto result = apiInstance.updateTicketBooking(id, bookingPageDto);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TicketingApi.updateTicketBooking: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TicketingApi();
$id = id_example; // String | ID of record to operate on
$bookingPageDto = ; // BookingPageDto | 

try {
    $result = $api_instance->updateTicketBooking($id, $bookingPageDto);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TicketingApi->updateTicketBooking: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TicketingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TicketingApi->new();
my $id = id_example; # String | ID of record to operate on
my $bookingPageDto = WWW::OPenAPIClient::Object::BookingPageDto->new(); # BookingPageDto | 

eval {
    my $result = $api_instance->updateTicketBooking(id => $id, bookingPageDto => $bookingPageDto);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TicketingApi->updateTicketBooking: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TicketingApi()
id = id_example # String | ID of record to operate on (default to null)
bookingPageDto =  # BookingPageDto | 

try:
    api_response = api_instance.update_ticket_booking(id, bookingPageDto)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TicketingApi->updateTicketBooking: %s\n" % e)
extern crate TicketingApi;

pub fn main() {
    let id = id_example; // String
    let bookingPageDto = ; // BookingPageDto

    let mut context = TicketingApi::Context::default();
    let result = client.updateTicketBooking(id, bookingPageDto, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
id*
String
ID of record to operate on
Required
Body parameters
Name Description
bookingPageDto *

New booking data.

Responses