API

Connections

createConnection

Create connection.

By creating connection between visits, it will add constraints between stops planning. There are different types of constraints.


/0.1/connections

Usage and SDK Samples

curl -X POST "//app.mapotempo.com/api/0.1/connections"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectionsApi;

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

public class ConnectionsApiExample {

    public static void main(String[] args) {
        
        ConnectionsApi apiInstance = new ConnectionsApi();
        Body body = ; // Body | 
        try {
            V01_connection result = apiInstance.createConnection(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#createConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectionsApi;

public class ConnectionsApiExample {

    public static void main(String[] args) {
        ConnectionsApi apiInstance = new ConnectionsApi();
        Body body = ; // Body | 
        try {
            V01_connection result = apiInstance.createConnection(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#createConnection");
            e.printStackTrace();
        }
    }
}
Body *body = ; // 

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

// Create connection.
[apiInstance createConnectionWith:body
              completionHandler: ^(V01_connection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.ConnectionsApi()
var body = ; // {{Body}} 

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

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

            var apiInstance = new ConnectionsApi();
            var body = new Body(); // Body | 

            try
            {
                // Create connection.
                V01_connection result = apiInstance.createConnection(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.createConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectionsApi();
$body = ; // Body | 

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

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

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

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

try: 
    # Create connection.
    api_response = api_instance.create_connection(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectionsApi->createConnection: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteConnection

Delete connection.

Delete connection.


/0.1/connections/{id}

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/connections/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectionsApi;

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

public class ConnectionsApiExample {

    public static void main(String[] args) {
        
        ConnectionsApi apiInstance = new ConnectionsApi();
        Integer id = 56; // Integer | Id of the connection to delete
        try {
            apiInstance.deleteConnection(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#deleteConnection");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectionsApi;

public class ConnectionsApiExample {

    public static void main(String[] args) {
        ConnectionsApi apiInstance = new ConnectionsApi();
        Integer id = 56; // Integer | Id of the connection to delete
        try {
            apiInstance.deleteConnection(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#deleteConnection");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // Id of the connection to delete

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

// Delete connection.
[apiInstance deleteConnectionWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.ConnectionsApi()
var id = 56; // {{Integer}} Id of the connection to delete

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

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

            var apiInstance = new ConnectionsApi();
            var id = 56;  // Integer | Id of the connection to delete

            try
            {
                // Delete connection.
                apiInstance.deleteConnection(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.deleteConnection: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectionsApi();
$id = 56; // Integer | Id of the connection to delete

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

my $api_instance = WWW::SwaggerClient::ConnectionsApi->new();
my $id = 56; # Integer | Id of the connection to delete

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

# create an instance of the API class
api_instance = swagger_client.ConnectionsApi()
id = 56 # Integer | Id of the connection to delete

try: 
    # Delete connection.
    api_instance.delete_connection(id)
except ApiException as e:
    print("Exception when calling ConnectionsApi->deleteConnection: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Id of the connection to delete
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteConnections

Delete multiple connections.

Delete multiple connections.


/0.1/connections

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/connections"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConnectionsApi;

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

public class ConnectionsApiExample {

    public static void main(String[] args) {
        
        ConnectionsApi apiInstance = new ConnectionsApi();
        array[Integer] ids = ; // array[Integer] | 
        try {
            apiInstance.deleteConnections(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#deleteConnections");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConnectionsApi;

public class ConnectionsApiExample {

    public static void main(String[] args) {
        ConnectionsApi apiInstance = new ConnectionsApi();
        array[Integer] ids = ; // array[Integer] | 
        try {
            apiInstance.deleteConnections(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectionsApi#deleteConnections");
            e.printStackTrace();
        }
    }
}
array[Integer] *ids = ; // 

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

// Delete multiple connections.
[apiInstance deleteConnectionsWith:ids
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.ConnectionsApi()
var ids = ; // {{array[Integer]}} 

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

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

            var apiInstance = new ConnectionsApi();
            var ids = new array[Integer](); // array[Integer] | 

            try
            {
                // Delete multiple connections.
                apiInstance.deleteConnections(ids);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConnectionsApi.deleteConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConnectionsApi();
$ids = ; // array[Integer] | 

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

my $api_instance = WWW::SwaggerClient::ConnectionsApi->new();
my $ids = []; # array[Integer] | 

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

# create an instance of the API class
api_instance = swagger_client.ConnectionsApi()
ids =  # array[Integer] | 

try: 
    # Delete multiple connections.
    api_instance.delete_connections(ids)
except ApiException as e:
    print("Exception when calling ConnectionsApi->deleteConnections: %s\n" % e)

Parameters

Form parameters
Name Description
ids*
array[Integer] (int32)
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


Customers

createCustomer

Create customer account (admin).

Create a customer account and its default data (stores, vehicle_usage_sets, vehicle_ids, deliverable_units) which are returned by this operation. Only available with an admin api_key.


/0.1/customers

Usage and SDK Samples

curl -X POST "//app.mapotempo.com/api/0.1/customers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        Body_2 body = ; // Body_2 | 
        try {
            V01_CustomerAdmin result = apiInstance.createCustomer(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#createCustomer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        Body_2 body = ; // Body_2 | 
        try {
            V01_CustomerAdmin result = apiInstance.createCustomer(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#createCustomer");
            e.printStackTrace();
        }
    }
}
Body_2 *body = ; // 

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

// Create customer account (admin).
[apiInstance createCustomerWith:body
              completionHandler: ^(V01_CustomerAdmin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var body = ; // {{Body_2}} 

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

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

            var apiInstance = new CustomersApi();
            var body = new Body_2(); // Body_2 | 

            try
            {
                // Create customer account (admin).
                V01_CustomerAdmin result = apiInstance.createCustomer(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.createCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$body = ; // Body_2 | 

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

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

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

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

try: 
    # Create customer account (admin).
    api_response = api_instance.create_customer(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->createCustomer: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteCustomer

Delete customer account (admin).

Only available with an admin api_key.


/0.1/customers/{id}

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/customers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            apiInstance.deleteCustomer(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#deleteCustomer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            apiInstance.deleteCustomer(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#deleteCustomer");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.

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

// Delete customer account (admin).
[apiInstance deleteCustomerWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.

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

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.

            try
            {
                // Delete customer account (admin).
                apiInstance.deleteCustomer(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.deleteCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.

try: 
    # Delete customer account (admin).
    api_instance.delete_customer(id)
except ApiException as e:
    print("Exception when calling CustomersApi->deleteCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteJob

Cancel job.

Cancel asynchronous job (like geocoding, optimizer) currently runned for the customer.


/0.1/customers/{id}/job/{job_id}

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/customers/{id}/job/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Integer jobId = 56; // Integer | 
        try {
            apiInstance.deleteJob(id, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#deleteJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Integer jobId = 56; // Integer | 
        try {
            apiInstance.deleteJob(id, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#deleteJob");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.
Integer *jobId = 56; // 

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

// Cancel job.
[apiInstance deleteJobWith:id
    jobId:jobId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var jobId = 56; // {{Integer}} 

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

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var jobId = 56;  // Integer | 

            try
            {
                // Cancel job.
                apiInstance.deleteJob(id, jobId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.deleteJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
$jobId = 56; // Integer | 

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.
my $jobId = 56; # Integer | 

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.
jobId = 56 # Integer | 

try: 
    # Cancel job.
    api_instance.delete_job(id, jobId)
except ApiException as e:
    print("Exception when calling CustomersApi->deleteJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required
job_id*
Integer (int32)
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


duplicateCustomer

Duplicate customer account (admin).

Create a copy of customer account. Only available with an admin api_key.


/0.1/customers/{id}/duplicate

Usage and SDK Samples

curl -X PATCH "//app.mapotempo.com/api/0.1/customers/{id}/duplicate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Boolean excludeUsers = true; // Boolean | 
        try {
            V01_CustomerAdmin result = apiInstance.duplicateCustomer(id, excludeUsers);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#duplicateCustomer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Boolean excludeUsers = true; // Boolean | 
        try {
            V01_CustomerAdmin result = apiInstance.duplicateCustomer(id, excludeUsers);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#duplicateCustomer");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.
Boolean *excludeUsers = true; //  (optional)

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

// Duplicate customer account (admin).
[apiInstance duplicateCustomerWith:id
    excludeUsers:excludeUsers
              completionHandler: ^(V01_CustomerAdmin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var opts = { 
  'excludeUsers': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.duplicateCustomer(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var excludeUsers = true;  // Boolean |  (optional) 

            try
            {
                // Duplicate customer account (admin).
                V01_CustomerAdmin result = apiInstance.duplicateCustomer(id, excludeUsers);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.duplicateCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
$excludeUsers = true; // Boolean | 

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.
my $excludeUsers = true; # Boolean | 

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.
excludeUsers = true # Boolean |  (optional)

try: 
    # Duplicate customer account (admin).
    api_response = api_instance.duplicate_customer(id, excludeUsers=excludeUsers)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->duplicateCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required
Form parameters
Name Description
exclude_users
Boolean

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getCustomer

Fetch customer account.

Get informations and details, for example customer account associated to the current api_key.


/0.1/customers/{id}

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/customers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            V01_CustomerAdmin result = apiInstance.getCustomer(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            V01_CustomerAdmin result = apiInstance.getCustomer(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomer");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.

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

// Fetch customer account.
[apiInstance getCustomerWith:id
              completionHandler: ^(V01_CustomerAdmin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.

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

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.

            try
            {
                // Fetch customer account.
                V01_CustomerAdmin result = apiInstance.getCustomer(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.getCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.

try: 
    # Fetch customer account.
    api_response = api_instance.get_customer(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->getCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getCustomerUsers

Fetch users for customer account id.

Fetch users for customer account id.


/0.1/customers/{id}/users

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/customers/{id}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        Integer id = 56; // Integer | 
        try {
            array[V01_User] result = apiInstance.getCustomerUsers(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomerUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        Integer id = 56; // Integer | 
        try {
            array[V01_User] result = apiInstance.getCustomerUsers(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomerUsers");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 

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

// Fetch users for customer account id.
[apiInstance getCustomerUsersWith:id
              completionHandler: ^(array[V01_User] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = 56; // {{Integer}} 

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

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

            var apiInstance = new CustomersApi();
            var id = 56;  // Integer | 

            try
            {
                // Fetch users for customer account id.
                array[V01_User] result = apiInstance.getCustomerUsers(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.getCustomerUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = 56; // Integer | 

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = 56; # Integer | 

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = 56 # Integer | 

try: 
    # Fetch users for customer account id.
    api_response = api_instance.get_customer_users(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->getCustomerUsers: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getCustomers

Fetch customer accounts (admin).

Retrieve all customer accounts. Only available with an admin api_key.


/0.1/customers

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/customers?name_like=&ref_like=&words_mask="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String nameLike = nameLike_example; // String | Find accounts with similarity on the name (case insensitive).
        String refLike = refLike_example; // String | Find accounts with similarity on the reference (case insensitive).
        String wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)
        try {
            array[V01_CustomerAdmin] result = apiInstance.getCustomers(nameLike, refLike, wordsMask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String nameLike = nameLike_example; // String | Find accounts with similarity on the name (case insensitive).
        String refLike = refLike_example; // String | Find accounts with similarity on the reference (case insensitive).
        String wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)
        try {
            array[V01_CustomerAdmin] result = apiInstance.getCustomers(nameLike, refLike, wordsMask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getCustomers");
            e.printStackTrace();
        }
    }
}
String *nameLike = nameLike_example; // Find accounts with similarity on the name (case insensitive). (optional)
String *refLike = refLike_example; // Find accounts with similarity on the reference (case insensitive). (optional)
String *wordsMask = wordsMask_example; // Words separated by commas that will skip the similarity check (case insensitive) (optional)

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

// Fetch customer accounts (admin).
[apiInstance getCustomersWith:nameLike
    refLike:refLike
    wordsMask:wordsMask
              completionHandler: ^(array[V01_CustomerAdmin] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var opts = { 
  'nameLike': nameLike_example, // {{String}} Find accounts with similarity on the name (case insensitive).
  'refLike': refLike_example, // {{String}} Find accounts with similarity on the reference (case insensitive).
  'wordsMask': wordsMask_example // {{String}} Words separated by commas that will skip the similarity check (case insensitive)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCustomers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CustomersApi();
            var nameLike = nameLike_example;  // String | Find accounts with similarity on the name (case insensitive). (optional) 
            var refLike = refLike_example;  // String | Find accounts with similarity on the reference (case insensitive). (optional) 
            var wordsMask = wordsMask_example;  // String | Words separated by commas that will skip the similarity check (case insensitive) (optional) 

            try
            {
                // Fetch customer accounts (admin).
                array[V01_CustomerAdmin] result = apiInstance.getCustomers(nameLike, refLike, wordsMask);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.getCustomers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$nameLike = nameLike_example; // String | Find accounts with similarity on the name (case insensitive).
$refLike = refLike_example; // String | Find accounts with similarity on the reference (case insensitive).
$wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)

try {
    $result = $api_instance->getCustomers($nameLike, $refLike, $wordsMask);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->getCustomers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomersApi;

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $nameLike = nameLike_example; # String | Find accounts with similarity on the name (case insensitive).
my $refLike = refLike_example; # String | Find accounts with similarity on the reference (case insensitive).
my $wordsMask = wordsMask_example; # String | Words separated by commas that will skip the similarity check (case insensitive)

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
nameLike = nameLike_example # String | Find accounts with similarity on the name (case insensitive). (optional)
refLike = refLike_example # String | Find accounts with similarity on the reference (case insensitive). (optional)
wordsMask = wordsMask_example # String | Words separated by commas that will skip the similarity check (case insensitive) (optional)

try: 
    # Fetch customer accounts (admin).
    api_response = api_instance.get_customers(nameLike=nameLike, refLike=refLike, wordsMask=wordsMask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->getCustomers: %s\n" % e)

Parameters

Query parameters
Name Description
name_like
String
Find accounts with similarity on the name (case insensitive).
ref_like
String
Find accounts with similarity on the reference (case insensitive).
words_mask
String
Words separated by commas that will skip the similarity check (case insensitive)

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getJob

Return a job.

Return asynchronous job (like geocoding, optimizer) currently runned for the customer.


/0.1/customers/{id}/job/{job_id}

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/customers/{id}/job/{job_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Integer jobId = 56; // Integer | 
        try {
            apiInstance.getJob(id, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getJob");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Integer jobId = 56; // Integer | 
        try {
            apiInstance.getJob(id, jobId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#getJob");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.
Integer *jobId = 56; // 

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

// Return a job.
[apiInstance getJobWith:id
    jobId:jobId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var jobId = 56; // {{Integer}} 

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

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var jobId = 56;  // Integer | 

            try
            {
                // Return a job.
                apiInstance.getJob(id, jobId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.getJob: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
$jobId = 56; // Integer | 

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.
my $jobId = 56; # Integer | 

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.
jobId = 56 # Integer | 

try: 
    # Return a job.
    api_instance.get_job(id, jobId)
except ApiException as e:
    print("Exception when calling CustomersApi->getJob: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required
job_id*
Integer (int32)
Required

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


updateCustomer

Update customer account.

Update informations and details, for example customer account associated to the current api_key.


/0.1/customers/{id}

Usage and SDK Samples

curl -X PUT "//app.mapotempo.com/api/0.1/customers/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomersApi;

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

public class CustomersApiExample {

    public static void main(String[] args) {
        
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_3 body = ; // Body_3 | 
        try {
            V01_CustomerAdmin result = apiInstance.updateCustomer(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#updateCustomer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        CustomersApi apiInstance = new CustomersApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_3 body = ; // Body_3 | 
        try {
            V01_CustomerAdmin result = apiInstance.updateCustomer(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#updateCustomer");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.
Body_3 *body = ; //  (optional)

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

// Update customer account.
[apiInstance updateCustomerWith:id
    body:body
              completionHandler: ^(V01_CustomerAdmin output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.CustomersApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var opts = { 
  'body':  // {{Body_3}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCustomer(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new CustomersApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var body = new Body_3(); // Body_3 |  (optional) 

            try
            {
                // Update customer account.
                V01_CustomerAdmin result = apiInstance.updateCustomer(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomersApi.updateCustomer: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCustomersApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
$body = ; // Body_3 | 

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

my $api_instance = WWW::SwaggerClient::CustomersApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.
my $body = WWW::SwaggerClient::Object::Body_3->new(); # Body_3 | 

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

# create an instance of the API class
api_instance = swagger_client.CustomersApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.
body =  # Body_3 |  (optional)

try: 
    # Update customer account.
    api_response = api_instance.update_customer(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomersApi->updateCustomer: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


DeliverableUnits

createDeliverableUnit

Create deliverable unit.

(Note a default deliverable unit is already automatically created when a customer account is initialized.) By creating a new deliverable unit, it will be possible to specify quantities and capacities for this another unit.


/0.1/deliverable_units

Usage and SDK Samples

curl -X POST "//app.mapotempo.com/api/0.1/deliverable_units"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        Body_5 body = ; // Body_5 | 
        try {
            V01_DeliverableUnit result = apiInstance.createDeliverableUnit(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#createDeliverableUnit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        Body_5 body = ; // Body_5 | 
        try {
            V01_DeliverableUnit result = apiInstance.createDeliverableUnit(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#createDeliverableUnit");
            e.printStackTrace();
        }
    }
}
Body_5 *body = ; //  (optional)

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

// Create deliverable unit.
[apiInstance createDeliverableUnitWith:body
              completionHandler: ^(V01_DeliverableUnit output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

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

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

            var apiInstance = new DeliverableUnitsApi();
            var body = new Body_5(); // Body_5 |  (optional) 

            try
            {
                // Create deliverable unit.
                V01_DeliverableUnit result = apiInstance.createDeliverableUnit(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.createDeliverableUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$body = ; // Body_5 | 

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

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

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

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
body =  # Body_5 |  (optional)

try: 
    # Create deliverable unit.
    api_response = api_instance.create_deliverable_unit(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->createDeliverableUnit: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteDeliverableUnit

Delete deliverable unit.

Delete deliverable unit.


/0.1/deliverable_units/{id}

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/deliverable_units/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            apiInstance.deleteDeliverableUnit(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#deleteDeliverableUnit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        try {
            apiInstance.deleteDeliverableUnit(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#deleteDeliverableUnit");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.

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

// Delete deliverable unit.
[apiInstance deleteDeliverableUnitWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DeliverableUnitsApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.

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

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

            var apiInstance = new DeliverableUnitsApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.

            try
            {
                // Delete deliverable unit.
                apiInstance.deleteDeliverableUnit(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.deleteDeliverableUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.

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

my $api_instance = WWW::SwaggerClient::DeliverableUnitsApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.

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

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.

try: 
    # Delete deliverable unit.
    api_instance.delete_deliverable_unit(id)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->deleteDeliverableUnit: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


deleteDeliverableUnits

Delete multiple deliverable units.

Delete multiple deliverable units.


/0.1/deliverable_units

Usage and SDK Samples

curl -X DELETE "//app.mapotempo.com/api/0.1/deliverable_units"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        array[String] ids = ; // array[String] | 
        try {
            apiInstance.deleteDeliverableUnits(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#deleteDeliverableUnits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        array[String] ids = ; // array[String] | 
        try {
            apiInstance.deleteDeliverableUnits(ids);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#deleteDeliverableUnits");
            e.printStackTrace();
        }
    }
}
array[String] *ids = ; // 

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

// Delete multiple deliverable units.
[apiInstance deleteDeliverableUnitsWith:ids
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DeliverableUnitsApi()
var ids = ; // {{array[String]}} 

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

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

            var apiInstance = new DeliverableUnitsApi();
            var ids = new array[String](); // array[String] | 

            try
            {
                // Delete multiple deliverable units.
                apiInstance.deleteDeliverableUnits(ids);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.deleteDeliverableUnits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$ids = ; // array[String] | 

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

my $api_instance = WWW::SwaggerClient::DeliverableUnitsApi->new();
my $ids = []; # array[String] | 

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

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
ids =  # array[String] | 

try: 
    # Delete multiple deliverable units.
    api_instance.delete_deliverable_units(ids)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->deleteDeliverableUnits: %s\n" % e)

Parameters

Form parameters
Name Description
ids*
array[String]
Required

Responses

Status: 204 - No Content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getDeliverableUnit

Fetch deliverable unit.

Fetch deliverable unit.


/0.1/deliverable_units/{id}

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/deliverable_units/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        Integer id = 56; // Integer | 
        try {
            V01_DeliverableUnit result = apiInstance.getDeliverableUnit(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#getDeliverableUnit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        Integer id = 56; // Integer | 
        try {
            V01_DeliverableUnit result = apiInstance.getDeliverableUnit(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#getDeliverableUnit");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // 

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

// Fetch deliverable unit.
[apiInstance getDeliverableUnitWith:id
              completionHandler: ^(V01_DeliverableUnit output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DeliverableUnitsApi()
var id = 56; // {{Integer}} 

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

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

            var apiInstance = new DeliverableUnitsApi();
            var id = 56;  // Integer | 

            try
            {
                // Fetch deliverable unit.
                V01_DeliverableUnit result = apiInstance.getDeliverableUnit(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.getDeliverableUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$id = 56; // Integer | 

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

my $api_instance = WWW::SwaggerClient::DeliverableUnitsApi->new();
my $id = 56; # Integer | 

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

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
id = 56 # Integer | 

try: 
    # Fetch deliverable unit.
    api_response = api_instance.get_deliverable_unit(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->getDeliverableUnit: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


getDeliverableUnits

Fetch customer's deliverable units. At least one deliverable unit exists per customer.

Fetch customer's deliverable units. At least one deliverable unit exists per customer.


/0.1/deliverable_units

Usage and SDK Samples

curl -X GET "//app.mapotempo.com/api/0.1/deliverable_units?ids=&label_like=&ref_like=&words_mask="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        array[String] ids = ; // array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
        String labelLike = labelLike_example; // String | Find deliverable units with similarity on the label (case insensitive).
        String refLike = refLike_example; // String | Find deliverable units with similarity on the reference (case insensitive).
        String wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)
        try {
            array[V01_DeliverableUnit] result = apiInstance.getDeliverableUnits(ids, labelLike, refLike, wordsMask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#getDeliverableUnits");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        array[String] ids = ; // array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
        String labelLike = labelLike_example; // String | Find deliverable units with similarity on the label (case insensitive).
        String refLike = refLike_example; // String | Find deliverable units with similarity on the reference (case insensitive).
        String wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)
        try {
            array[V01_DeliverableUnit] result = apiInstance.getDeliverableUnits(ids, labelLike, refLike, wordsMask);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#getDeliverableUnits");
            e.printStackTrace();
        }
    }
}
array[String] *ids = ; // Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`. (optional)
String *labelLike = labelLike_example; // Find deliverable units with similarity on the label (case insensitive). (optional)
String *refLike = refLike_example; // Find deliverable units with similarity on the reference (case insensitive). (optional)
String *wordsMask = wordsMask_example; // Words separated by commas that will skip the similarity check (case insensitive) (optional)

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

// Fetch customer's deliverable units. At least one deliverable unit exists per customer.
[apiInstance getDeliverableUnitsWith:ids
    labelLike:labelLike
    refLike:refLike
    wordsMask:wordsMask
              completionHandler: ^(array[V01_DeliverableUnit] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DeliverableUnitsApi()
var opts = { 
  'ids': , // {{array[String]}} Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
  'labelLike': labelLike_example, // {{String}} Find deliverable units with similarity on the label (case insensitive).
  'refLike': refLike_example, // {{String}} Find deliverable units with similarity on the reference (case insensitive).
  'wordsMask': wordsMask_example // {{String}} Words separated by commas that will skip the similarity check (case insensitive)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliverableUnits(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DeliverableUnitsApi();
            var ids = new array[String](); // array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`. (optional) 
            var labelLike = labelLike_example;  // String | Find deliverable units with similarity on the label (case insensitive). (optional) 
            var refLike = refLike_example;  // String | Find deliverable units with similarity on the reference (case insensitive). (optional) 
            var wordsMask = wordsMask_example;  // String | Words separated by commas that will skip the similarity check (case insensitive) (optional) 

            try
            {
                // Fetch customer's deliverable units. At least one deliverable unit exists per customer.
                array[V01_DeliverableUnit] result = apiInstance.getDeliverableUnits(ids, labelLike, refLike, wordsMask);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.getDeliverableUnits: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$ids = ; // array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
$labelLike = labelLike_example; // String | Find deliverable units with similarity on the label (case insensitive).
$refLike = refLike_example; // String | Find deliverable units with similarity on the reference (case insensitive).
$wordsMask = wordsMask_example; // String | Words separated by commas that will skip the similarity check (case insensitive)

try {
    $result = $api_instance->getDeliverableUnits($ids, $labelLike, $refLike, $wordsMask);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliverableUnitsApi->getDeliverableUnits: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeliverableUnitsApi;

my $api_instance = WWW::SwaggerClient::DeliverableUnitsApi->new();
my $ids = []; # array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
my $labelLike = labelLike_example; # String | Find deliverable units with similarity on the label (case insensitive).
my $refLike = refLike_example; # String | Find deliverable units with similarity on the reference (case insensitive).
my $wordsMask = wordsMask_example; # String | Words separated by commas that will skip the similarity check (case insensitive)

eval { 
    my $result = $api_instance->getDeliverableUnits(ids => $ids, labelLike => $labelLike, refLike => $refLike, wordsMask => $wordsMask);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeliverableUnitsApi->getDeliverableUnits: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
ids =  # array[String] | Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`. (optional)
labelLike = labelLike_example # String | Find deliverable units with similarity on the label (case insensitive). (optional)
refLike = refLike_example # String | Find deliverable units with similarity on the reference (case insensitive). (optional)
wordsMask = wordsMask_example # String | Words separated by commas that will skip the similarity check (case insensitive) (optional)

try: 
    # Fetch customer's deliverable units. At least one deliverable unit exists per customer.
    api_response = api_instance.get_deliverable_units(ids=ids, labelLike=labelLike, refLike=refLike, wordsMask=wordsMask)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->getDeliverableUnits: %s\n" % e)

Parameters

Query parameters
Name Description
ids
array[String]
Ids separated by comma. You can specify ref (not containing comma) instead of id, in this case you have to add `ref:` before each ref, e.g. `ref:ref1,ref:ref2,ref:ref3`.
label_like
String
Find deliverable units with similarity on the label (case insensitive).
ref_like
String
Find deliverable units with similarity on the reference (case insensitive).
words_mask
String
Words separated by commas that will skip the similarity check (case insensitive)

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


updateDeliverableUnit

Update deliverable unit.

Update deliverable unit.


/0.1/deliverable_units/{id}

Usage and SDK Samples

curl -X PUT "//app.mapotempo.com/api/0.1/deliverable_units/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeliverableUnitsApi;

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

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_7 body = ; // Body_7 | 
        try {
            V01_DeliverableUnit result = apiInstance.updateDeliverableUnit(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#updateDeliverableUnit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeliverableUnitsApi;

public class DeliverableUnitsApiExample {

    public static void main(String[] args) {
        DeliverableUnitsApi apiInstance = new DeliverableUnitsApi();
        String id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_7 body = ; // Body_7 | 
        try {
            V01_DeliverableUnit result = apiInstance.updateDeliverableUnit(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliverableUnitsApi#updateDeliverableUnit");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // Id or the ref field value, then use `ref:[value]`.
Body_7 *body = ; //  (optional)

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

// Update deliverable unit.
[apiInstance updateDeliverableUnitWith:id
    body:body
              completionHandler: ^(V01_DeliverableUnit output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DeliverableUnitsApi()
var id = id_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var opts = { 
  'body':  // {{Body_7}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDeliverableUnit(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DeliverableUnitsApi();
            var id = id_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var body = new Body_7(); // Body_7 |  (optional) 

            try
            {
                // Update deliverable unit.
                V01_DeliverableUnit result = apiInstance.updateDeliverableUnit(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeliverableUnitsApi.updateDeliverableUnit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDeliverableUnitsApi();
$id = id_example; // String | Id or the ref field value, then use `ref:[value]`.
$body = ; // Body_7 | 

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

my $api_instance = WWW::SwaggerClient::DeliverableUnitsApi->new();
my $id = id_example; # String | Id or the ref field value, then use `ref:[value]`.
my $body = WWW::SwaggerClient::Object::Body_7->new(); # Body_7 | 

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

# create an instance of the API class
api_instance = swagger_client.DeliverableUnitsApi()
id = id_example # String | Id or the ref field value, then use `ref:[value]`.
body =  # Body_7 |  (optional)

try: 
    # Update deliverable unit.
    api_response = api_instance.update_deliverable_unit(id, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliverableUnitsApi->updateDeliverableUnit: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
Id or the ref field value, then use `ref:[value]`.
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


Destinations

autocompleteDestination

Auto completion on destination.

Auto completion on address of destination. Results are priorized from last geolocated store of the customer account.


/0.1/destinations/geocode_complete

Usage and SDK Samples

curl -X PATCH "//app.mapotempo.com/api/0.1/destinations/geocode_complete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DestinationsApi;

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

public class DestinationsApiExample {

    public static void main(String[] args) {
        
        DestinationsApi apiInstance = new DestinationsApi();
        String street = street_example; // String | 
        String postalcode = postalcode_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String country = country_example; // String | 
        try {
            V01_Destination result = apiInstance.autocompleteDestination(street, postalcode, city, state, country);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#autocompleteDestination");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DestinationsApi;

public class DestinationsApiExample {

    public static void main(String[] args) {
        DestinationsApi apiInstance = new DestinationsApi();
        String street = street_example; // String | 
        String postalcode = postalcode_example; // String | 
        String city = city_example; // String | 
        String state = state_example; // String | 
        String country = country_example; // String | 
        try {
            V01_Destination result = apiInstance.autocompleteDestination(street, postalcode, city, state, country);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#autocompleteDestination");
            e.printStackTrace();
        }
    }
}
String *street = street_example; //  (optional)
String *postalcode = postalcode_example; //  (optional)
String *city = city_example; //  (optional)
String *state = state_example; //  (optional)
String *country = country_example; //  (optional)

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

// Auto completion on destination.
[apiInstance autocompleteDestinationWith:street
    postalcode:postalcode
    city:city
    state:state
    country:country
              completionHandler: ^(V01_Destination output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DestinationsApi()
var opts = { 
  'street': street_example // {{String}} 
  'postalcode': postalcode_example // {{String}} 
  'city': city_example // {{String}} 
  'state': state_example // {{String}} 
  'country': country_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.autocompleteDestination(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DestinationsApi();
            var street = street_example;  // String |  (optional) 
            var postalcode = postalcode_example;  // String |  (optional) 
            var city = city_example;  // String |  (optional) 
            var state = state_example;  // String |  (optional) 
            var country = country_example;  // String |  (optional) 

            try
            {
                // Auto completion on destination.
                V01_Destination result = apiInstance.autocompleteDestination(street, postalcode, city, state, country);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DestinationsApi.autocompleteDestination: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDestinationsApi();
$street = street_example; // String | 
$postalcode = postalcode_example; // String | 
$city = city_example; // String | 
$state = state_example; // String | 
$country = country_example; // String | 

try {
    $result = $api_instance->autocompleteDestination($street, $postalcode, $city, $state, $country);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DestinationsApi->autocompleteDestination: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DestinationsApi;

my $api_instance = WWW::SwaggerClient::DestinationsApi->new();
my $street = street_example; # String | 
my $postalcode = postalcode_example; # String | 
my $city = city_example; # String | 
my $state = state_example; # String | 
my $country = country_example; # String | 

eval { 
    my $result = $api_instance->autocompleteDestination(street => $street, postalcode => $postalcode, city => $city, state => $state, country => $country);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DestinationsApi->autocompleteDestination: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DestinationsApi()
street = street_example # String |  (optional)
postalcode = postalcode_example # String |  (optional)
city = city_example # String |  (optional)
state = state_example # String |  (optional)
country = country_example # String |  (optional)

try: 
    # Auto completion on destination.
    api_response = api_instance.autocomplete_destination(street=street, postalcode=postalcode, city=city, state=state, country=country)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DestinationsApi->autocompleteDestination: %s\n" % e)

Parameters

Form parameters
Name Description
street
String
postalcode
String
city
String
state
String
country
String

Responses

Status: 200 - OK.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


createDestination

Create destination.

Create destination (point to visit). A same destination/point can be visited multiple times.


/0.1/destinations

Usage and SDK Samples

curl -X POST "//app.mapotempo.com/api/0.1/destinations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DestinationsApi;

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

public class DestinationsApiExample {

    public static void main(String[] args) {
        
        DestinationsApi apiInstance = new DestinationsApi();
        Body_9 body = ; // Body_9 | 
        try {
            V01_Destination result = apiInstance.createDestination(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#createDestination");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DestinationsApi;

public class DestinationsApiExample {

    public static void main(String[] args) {
        DestinationsApi apiInstance = new DestinationsApi();
        Body_9 body = ; // Body_9 | 
        try {
            V01_Destination result = apiInstance.createDestination(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#createDestination");
            e.printStackTrace();
        }
    }
}
Body_9 *body = ; // 

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

// Create destination.
[apiInstance createDestinationWith:body
              completionHandler: ^(V01_Destination output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DestinationsApi()
var body = ; // {{Body_9}} 

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

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

            var apiInstance = new DestinationsApi();
            var body = new Body_9(); // Body_9 | 

            try
            {
                // Create destination.
                V01_Destination result = apiInstance.createDestination(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DestinationsApi.createDestination: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDestinationsApi();
$body = ; // Body_9 | 

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

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

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

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

try: 
    # Create destination.
    api_response = api_instance.create_destination(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DestinationsApi->createDestination: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.


createVisit

Create visit.

Create visit.


/0.1/destinations/{destination_id}/visits

Usage and SDK Samples

curl -X POST "//app.mapotempo.com/api/0.1/destinations/{destination_id}/visits"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DestinationsApi;

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

public class DestinationsApiExample {

    public static void main(String[] args) {
        
        DestinationsApi apiInstance = new DestinationsApi();
        String destinationId = destinationId_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_15 body = ; // Body_15 | 
        try {
            V01_Visit result = apiInstance.createVisit(destinationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#createVisit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DestinationsApi;

public class DestinationsApiExample {

    public static void main(String[] args) {
        DestinationsApi apiInstance = new DestinationsApi();
        String destinationId = destinationId_example; // String | Id or the ref field value, then use `ref:[value]`.
        Body_15 body = ; // Body_15 | 
        try {
            V01_Visit result = apiInstance.createVisit(destinationId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DestinationsApi#createVisit");
            e.printStackTrace();
        }
    }
}
String *destinationId = destinationId_example; // Id or the ref field value, then use `ref:[value]`.
Body_15 *body = ; //  (optional)

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

// Create visit.
[apiInstance createVisitWith:destinationId
    body:body
              completionHandler: ^(V01_Visit output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Api = require('api');

var api = new Api.DestinationsApi()
var destinationId = destinationId_example; // {{String}} Id or the ref field value, then use `ref:[value]`.
var opts = { 
  'body':  // {{Body_15}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createVisit(destinationId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new DestinationsApi();
            var destinationId = destinationId_example;  // String | Id or the ref field value, then use `ref:[value]`.
            var body = new Body_15(); // Body_15 |  (optional) 

            try
            {
                // Create visit.
                V01_Visit result = apiInstance.createVisit(destinationId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DestinationsApi.createVisit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiDestinationsApi();
$destinationId = destinationId_example; // String | Id or the ref field value, then use `ref:[value]`.
$body = ; // Body_15 | 

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

my $api_instance = WWW::SwaggerClient::DestinationsApi->new();
my $destinationId = destinationId_example; # String | Id or the ref field value, then use `ref:[value]`.
my $body = WWW::SwaggerClient::Object::Body_15->new(); # Body_15 | 

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

# create an instance of the API class
api_instance = swagger_client.DestinationsApi()
destinationId = destinationId_example # String | Id or the ref field value, then use `ref:[value]`.
body =  # Body_15 |  (optional)

try: 
    # Create visit.
    api_response = api_instance.create_visit(destinationId, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DestinationsApi->createVisit: %s\n" % e)

Parameters

Path parameters
Name Description
destination_id*
String
Id or the ref field value, then use `ref:[value]`.
Required
Body parameters
Name Description
body

Responses

Status: 201 - Created.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 402 - Subscription error.

Status: 403 - Forbidden.

Status: 404 - Not found.

Status: 405 - Method not allowed.

Status: 409 - Conflict.

Status: 500 - Internal servor error.