Route2 REST API

Attributes

attributesQuery

Query dynamic values for attribute


/attribute/query

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/attribute/query?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&query=query_example&args=Object"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AttributesApi;

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

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

        // Create an instance of the API class
        AttributesApi apiInstance = new AttributesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String query = query_example; // String | Identifier of the query to be fetched
        map[String, Object] args = Object; // map[String, Object] | Additional parameters for the query

        try {
            anyOf result = apiInstance.attributesQuery(tenantId, query, args);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#attributesQuery");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AttributesApi;

public class AttributesApiExample {
    public static void main(String[] args) {
        AttributesApi apiInstance = new AttributesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String query = query_example; // String | Identifier of the query to be fetched
        map[String, Object] args = Object; // map[String, Object] | Additional parameters for the query

        try {
            anyOf result = apiInstance.attributesQuery(tenantId, query, args);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttributesApi#attributesQuery");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AttributesApi *apiInstance = [[AttributesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
String *query = query_example; // Identifier of the query to be fetched (default to null)
map[String, Object] *args = Object; // Additional parameters for the query (optional) (default to null)

[apiInstance attributesQueryWith:tenantId
    query:query
    args:args
              completionHandler: ^(anyOf output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.AttributesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var query = query_example; // {String} Identifier of the query to be fetched
var opts = {
  'args': Object // {map[String, Object]} Additional parameters for the query
};

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

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

            // Create an instance of the API class
            var apiInstance = new AttributesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var query = query_example;  // String | Identifier of the query to be fetched (default to null)
            var args = new map[String, Object](); // map[String, Object] | Additional parameters for the query (optional)  (default to null)

            try {
                anyOf result = apiInstance.attributesQuery(tenantId, query, args);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AttributesApi.attributesQuery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AttributesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$query = query_example; // String | Identifier of the query to be fetched
$args = Object; // map[String, Object] | Additional parameters for the query

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AttributesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $query = query_example; # String | Identifier of the query to be fetched
my $args = Object; # map[String, Object] | Additional parameters for the query

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

# Create an instance of the API class
api_instance = openapi_client.AttributesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
query = query_example # String | Identifier of the query to be fetched (default to null)
args = Object # map[String, Object] | Additional parameters for the query (optional) (default to null)

try:
    api_response = api_instance.attributes_query(tenantId, query, args=args)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AttributesApi->attributesQuery: %s\n" % e)
extern crate AttributesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let query = query_example; // String
    let args = Object; // map[String, Object]

    let mut context = AttributesApi::Context::default();
    let result = client.attributesQuery(tenantId, query, args, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
query*
String
Identifier of the query to be fetched
Required
args
map[String, Object]
Additional parameters for the query

Responses


Bookings

attachmentCreate

Create an attachment


/booking/attachment

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://rest.route2.aleet.co/booking/attachment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&bookingId=38400000-8cf0-11bd-b23e-10b96e4ef00d&subtaskId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the booking related to the attachment.
        File file = BINARY_DATA_HERE; // File | Attached file
        UUID subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the subtask related to the attachment.

        try {
            BookingAttachmentMetadata result = apiInstance.attachmentCreate(tenantId, bookingId, file, subtaskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the booking related to the attachment.
        File file = BINARY_DATA_HERE; // File | Attached file
        UUID subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the subtask related to the attachment.

        try {
            BookingAttachmentMetadata result = apiInstance.attachmentCreate(tenantId, bookingId, file, subtaskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the booking related to the attachment. (default to null)
File *file = BINARY_DATA_HERE; // Attached file (default to null)
UUID *subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the subtask related to the attachment. (optional) (default to null)

[apiInstance attachmentCreateWith:tenantId
    bookingId:bookingId
    file:file
    subtaskId:subtaskId
              completionHandler: ^(BookingAttachmentMetadata output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the booking related to the attachment.
var file = BINARY_DATA_HERE; // {File} Attached file
var opts = {
  'subtaskId': 38400000-8cf0-11bd-b23e-10b96e4ef00d // {UUID} The id of the subtask related to the attachment.
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the booking related to the attachment. (default to null)
            var file = BINARY_DATA_HERE;  // File | Attached file (default to null)
            var subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the subtask related to the attachment. (optional)  (default to null)

            try {
                BookingAttachmentMetadata result = apiInstance.attachmentCreate(tenantId, bookingId, file, subtaskId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.attachmentCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the booking related to the attachment.
$file = BINARY_DATA_HERE; // File | Attached file
$subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the subtask related to the attachment.

try {
    $result = $api_instance->attachmentCreate($tenantId, $bookingId, $file, $subtaskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->attachmentCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BookingsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the booking related to the attachment.
my $file = BINARY_DATA_HERE; # File | Attached file
my $subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the subtask related to the attachment.

eval {
    my $result = $api_instance->attachmentCreate(tenantId => $tenantId, bookingId => $bookingId, file => $file, subtaskId => $subtaskId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BookingsApi->attachmentCreate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the booking related to the attachment. (default to null)
file = BINARY_DATA_HERE # File | Attached file (default to null)
subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the subtask related to the attachment. (optional) (default to null)

try:
    api_response = api_instance.attachment_create(tenantId, bookingId, file, subtaskId=subtaskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->attachmentCreate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let file = BINARY_DATA_HERE; // File
    let subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.attachmentCreate(tenantId, bookingId, file, subtaskId, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
file*
File (binary)
Attached file
Required
Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
bookingId*
UUID (uuid)
The id of the booking related to the attachment.
Required
subtaskId
UUID (uuid)
The id of the subtask related to the attachment.

Responses


attachmentDelete

Delete an attachment


/booking/attachment

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking/attachment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.attachmentDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.attachmentDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance attachmentDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.attachmentDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.attachmentDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.attachment_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling BookingsApi->attachmentDelete: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.attachmentDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


attachmentDownload

Get attachment content


/booking/attachment

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/octet-stream,application/json" \
 "https://rest.route2.aleet.co/booking/attachment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            byte[] result = apiInstance.attachmentDownload(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentDownload");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            byte[] result = apiInstance.attachmentDownload(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentDownload");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance attachmentDownloadWith:tenantId
    id:id
              completionHandler: ^(byte[] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                byte[] result = apiInstance.attachmentDownload(tenantId, id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.attachmentDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.attachment_download(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->attachmentDownload: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.attachmentDownload(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses

Name Type Format Description
ContentMinusDisposition String File name
XMinusAttachmentMinusId String Attachment ID
XMinusAttachmentMinusMimetype String MIME type of the file


attachmentUpdate

Update an attachment


/booking/attachment

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: multipart/form-data" \
 "https://rest.route2.aleet.co/booking/attachment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        File file = BINARY_DATA_HERE; // File | Attached file

        try {
            BookingAttachmentMetadata result = apiInstance.attachmentUpdate(tenantId, id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        File file = BINARY_DATA_HERE; // File | Attached file

        try {
            BookingAttachmentMetadata result = apiInstance.attachmentUpdate(tenantId, id, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#attachmentUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)
File *file = BINARY_DATA_HERE; // Attached file (default to null)

[apiInstance attachmentUpdateWith:tenantId
    id:id
    file:file
              completionHandler: ^(BookingAttachmentMetadata output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.
var file = BINARY_DATA_HERE; // {File} Attached file

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)
            var file = BINARY_DATA_HERE;  // File | Attached file (default to null)

            try {
                BookingAttachmentMetadata result = apiInstance.attachmentUpdate(tenantId, id, file);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.attachmentUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
$file = BINARY_DATA_HERE; // File | Attached file

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.
my $file = BINARY_DATA_HERE; # File | Attached file

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)
file = BINARY_DATA_HERE # File | Attached file (default to null)

try:
    api_response = api_instance.attachment_update(tenantId, id, file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->attachmentUpdate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let file = BINARY_DATA_HERE; // File

    let mut context = BookingsApi::Context::default();
    let result = client.attachmentUpdate(tenantId, id, file, &context).wait();

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

Scopes

Parameters

Form parameters
Name Description
file*
File (binary)
Attached file
Required
Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


bookingAssignments

Get booking assignments


/booking/bookingAssignments

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking/bookingAssignments?offset=56&limit=56&orderBy=orderBy_example&tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

        try {
            array[BookingAssignment] result = apiInstance.bookingAssignments(tenantId, id, offset, limit, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingAssignments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

        try {
            array[BookingAssignment] result = apiInstance.bookingAssignments(tenantId, id, offset, limit, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingAssignments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)

[apiInstance bookingAssignmentsWith:tenantId
    id:id
    offset:offset
    limit:limit
    orderBy:orderBy
              completionHandler: ^(array[BookingAssignment] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example // {String} Name of the field to sort the list by. Default is empty - no sorting.
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)

            try {
                array[BookingAssignment] result = apiInstance.bookingAssignments(tenantId, id, offset, limit, orderBy);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingAssignments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)

try:
    api_response = api_instance.booking_assignments(tenantId, id, offset=offset, limit=limit, orderBy=orderBy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingAssignments: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String

    let mut context = BookingsApi::Context::default();
    let result = client.bookingAssignments(tenantId, id, offset, limit, orderBy, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


bookingBatchDelete

Delete a batch of bookings


/booking/batch

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/booking/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.bookingBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingBatchDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.bookingBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingBatchDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BatchDeleteRequest *batchDeleteRequest = ; //  (optional)

[apiInstance bookingBatchDeleteWith:tenantId
    batchDeleteRequest:batchDeleteRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'batchDeleteRequest':  // {BatchDeleteRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var batchDeleteRequest = new BatchDeleteRequest(); // BatchDeleteRequest |  (optional) 

            try {
                apiInstance.bookingBatchDelete(tenantId, batchDeleteRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingBatchDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$batchDeleteRequest = ; // BatchDeleteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $batchDeleteRequest = WWW::OPenAPIClient::Object::BatchDeleteRequest->new(); # BatchDeleteRequest | 

eval {
    $api_instance->bookingBatchDelete(tenantId => $tenantId, batchDeleteRequest => $batchDeleteRequest);
};
if ($@) {
    warn "Exception when calling BookingsApi->bookingBatchDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
batchDeleteRequest =  # BatchDeleteRequest |  (optional)

try:
    api_instance.booking_batch_delete(tenantId, batchDeleteRequest=batchDeleteRequest)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingBatchDelete: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let batchDeleteRequest = ; // BatchDeleteRequest

    let mut context = BookingsApi::Context::default();
    let result = client.bookingBatchDelete(tenantId, batchDeleteRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
batchDeleteRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


bookingBatchUpdate

Update a batch of bookings


/booking/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/booking/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "allOrNothing" : true,
  "ids" : [ "ids", "ids" ],
  "bookingArgs" : {
    "dropOff" : {
      "timeWindowDate" : "timeWindowDate",
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "timeWindowTime" : {
        "start" : "54000",
        "end" : "54000"
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "pickUp" : {
      "timeWindowDate" : "timeWindowDate",
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "timeWindowTime" : {
        "start" : "54000",
        "end" : "54000"
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingBatchUpdateRequest bookingBatchUpdateRequest = ; // BookingBatchUpdateRequest | 

        try {
            array[BookingOrError] result = apiInstance.bookingBatchUpdate(tenantId, bookingBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingBatchUpdateRequest bookingBatchUpdateRequest = ; // BookingBatchUpdateRequest | 

        try {
            array[BookingOrError] result = apiInstance.bookingBatchUpdate(tenantId, bookingBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BookingBatchUpdateRequest *bookingBatchUpdateRequest = ; //  (optional)

[apiInstance bookingBatchUpdateWith:tenantId
    bookingBatchUpdateRequest:bookingBatchUpdateRequest
              completionHandler: ^(array[BookingOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'bookingBatchUpdateRequest':  // {BookingBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var bookingBatchUpdateRequest = new BookingBatchUpdateRequest(); // BookingBatchUpdateRequest |  (optional) 

            try {
                array[BookingOrError] result = apiInstance.bookingBatchUpdate(tenantId, bookingBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$bookingBatchUpdateRequest = ; // BookingBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $bookingBatchUpdateRequest = WWW::OPenAPIClient::Object::BookingBatchUpdateRequest->new(); # BookingBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
bookingBatchUpdateRequest =  # BookingBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.booking_batch_update(tenantId, bookingBatchUpdateRequest=bookingBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingBatchUpdate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let bookingBatchUpdateRequest = ; // BookingBatchUpdateRequest

    let mut context = BookingsApi::Context::default();
    let result = client.bookingBatchUpdate(tenantId, bookingBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
bookingBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


bookingById

Get booking object


/booking

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Booking result = apiInstance.bookingById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Booking result = apiInstance.bookingById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance bookingByIdWith:tenantId
    id:id
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.booking_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingById: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.bookingById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


bookingCreate

Create a booking


/booking

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/booking?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "booking" : {
    "dropOff" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "externalId" : "externalId",
    "pickUp" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingCreateRequest bookingCreateRequest = ; // BookingCreateRequest | 

        try {
            Booking result = apiInstance.bookingCreate(tenantId, bookingCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingCreateRequest bookingCreateRequest = ; // BookingCreateRequest | 

        try {
            Booking result = apiInstance.bookingCreate(tenantId, bookingCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BookingCreateRequest *bookingCreateRequest = ; //  (optional)

[apiInstance bookingCreateWith:tenantId
    bookingCreateRequest:bookingCreateRequest
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'bookingCreateRequest':  // {BookingCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var bookingCreateRequest = new BookingCreateRequest(); // BookingCreateRequest |  (optional) 

            try {
                Booking result = apiInstance.bookingCreate(tenantId, bookingCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$bookingCreateRequest = ; // BookingCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $bookingCreateRequest = WWW::OPenAPIClient::Object::BookingCreateRequest->new(); # BookingCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
bookingCreateRequest =  # BookingCreateRequest |  (optional)

try:
    api_response = api_instance.booking_create(tenantId, bookingCreateRequest=bookingCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingCreate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let bookingCreateRequest = ; // BookingCreateRequest

    let mut context = BookingsApi::Context::default();
    let result = client.bookingCreate(tenantId, bookingCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
bookingCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


bookingCreateBatch

Create a batch of bookings


/booking/batch

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/booking/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true" \
 -d '{
  "bookings" : [ {
    "dropOff" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "externalId" : "externalId",
    "pickUp" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "attributes" : "attributes"
  }, {
    "dropOff" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "externalId" : "externalId",
    "pickUp" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "attributes" : "attributes"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        BookingCreateBatchRequest bookingCreateBatchRequest = ; // BookingCreateBatchRequest | 

        try {
            array[BookingOrError] result = apiInstance.bookingCreateBatch(tenantId, allOrNothing, bookingCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingCreateBatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        BookingCreateBatchRequest bookingCreateBatchRequest = ; // BookingCreateBatchRequest | 

        try {
            array[BookingOrError] result = apiInstance.bookingCreateBatch(tenantId, allOrNothing, bookingCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingCreateBatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
BookingCreateBatchRequest *bookingCreateBatchRequest = ; //  (optional)

[apiInstance bookingCreateBatchWith:tenantId
    allOrNothing:allOrNothing
    bookingCreateBatchRequest:bookingCreateBatchRequest
              completionHandler: ^(array[BookingOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var opts = {
  'bookingCreateBatchRequest':  // {BookingCreateBatchRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var bookingCreateBatchRequest = new BookingCreateBatchRequest(); // BookingCreateBatchRequest |  (optional) 

            try {
                array[BookingOrError] result = apiInstance.bookingCreateBatch(tenantId, allOrNothing, bookingCreateBatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingCreateBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$bookingCreateBatchRequest = ; // BookingCreateBatchRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $bookingCreateBatchRequest = WWW::OPenAPIClient::Object::BookingCreateBatchRequest->new(); # BookingCreateBatchRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
bookingCreateBatchRequest =  # BookingCreateBatchRequest |  (optional)

try:
    api_response = api_instance.booking_create_batch(tenantId, allOrNothing, bookingCreateBatchRequest=bookingCreateBatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingCreateBatch: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let bookingCreateBatchRequest = ; // BookingCreateBatchRequest

    let mut context = BookingsApi::Context::default();
    let result = client.bookingCreateBatch(tenantId, allOrNothing, bookingCreateBatchRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
bookingCreateBatchRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required

Responses


bookingDelete

Delete a booking


/booking

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.bookingDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.bookingDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance bookingDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.bookingDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.booking_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingDelete: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.bookingDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


bookingDuplicate

Duplicate a booking


/booking/duplicate

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking/duplicate?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Booking result = apiInstance.bookingDuplicate(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingDuplicate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Booking result = apiInstance.bookingDuplicate(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingDuplicate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance bookingDuplicateWith:tenantId
    id:id
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.booking_duplicate(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingDuplicate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = BookingsApi::Context::default();
    let result = client.bookingDuplicate(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


bookingUpdate

Update a booking


/booking

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/booking?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "booking" : {
    "dropOff" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "externalId" : "externalId",
    "pickUp" : {
      "timeWindow" : {
        "start" : "2024-01-15T15:00:00.000+0000",
        "end" : "2024-01-15T15:00:00.000+0000"
      },
      "notes" : "notes",
      "phone" : "phone",
      "subtasks" : [ {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      }, {
        "attributes" : "attributes",
        "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "status" : "status"
      } ],
      "name" : "name",
      "location" : {
        "address" : {
          "country" : "country",
          "streetNumber" : "streetNumber",
          "city" : "city",
          "street" : "street",
          "flatNumber" : "flatNumber",
          "additional" : "additional",
          "postalCode" : "postalCode"
        },
        "position" : {
          "lon" : 0.8008282,
          "lat" : 6.0274563
        }
      },
      "locationPointOfInterestId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    },
    "attributes" : "attributes",
    "id" : "id",
    "version" : "version"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingUpdateRequest bookingUpdateRequest = ; // BookingUpdateRequest | 

        try {
            Booking result = apiInstance.bookingUpdate(tenantId, bookingUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BookingUpdateRequest bookingUpdateRequest = ; // BookingUpdateRequest | 

        try {
            Booking result = apiInstance.bookingUpdate(tenantId, bookingUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BookingUpdateRequest *bookingUpdateRequest = ; //  (optional)

[apiInstance bookingUpdateWith:tenantId
    bookingUpdateRequest:bookingUpdateRequest
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'bookingUpdateRequest':  // {BookingUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var bookingUpdateRequest = new BookingUpdateRequest(); // BookingUpdateRequest |  (optional) 

            try {
                Booking result = apiInstance.bookingUpdate(tenantId, bookingUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$bookingUpdateRequest = ; // BookingUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $bookingUpdateRequest = WWW::OPenAPIClient::Object::BookingUpdateRequest->new(); # BookingUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
bookingUpdateRequest =  # BookingUpdateRequest |  (optional)

try:
    api_response = api_instance.booking_update(tenantId, bookingUpdateRequest=bookingUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingUpdate: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let bookingUpdateRequest = ; // BookingUpdateRequest

    let mut context = BookingsApi::Context::default();
    let result = client.bookingUpdate(tenantId, bookingUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
bookingUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


bookings

List bookings with filtering/sorting options


/booking/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&status=&pickUpTimeWindow=&dropOffTimeWindow=&externalId=externalId_example&pickUpLocation=pickUpLocation_example&dropOffLocation=dropOffLocation_example&dateFrom=2013-10-20&dateTo=2013-10-20&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[BookingStatus] status = ; // array[BookingStatus] | Filter: list of booking statuses to match.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            BookingsPage result = apiInstance.bookings(tenantId, offset, limit, orderBy, status, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[BookingStatus] status = ; // array[BookingStatus] | Filter: list of booking statuses to match.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            BookingsPage result = apiInstance.bookings(tenantId, offset, limit, orderBy, status, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[BookingStatus] *status = ; // Filter: list of booking statuses to match. (optional) (default to null)
RangeFilter *pickUpTimeWindow = ; // Filter: match pickup time window. (optional) (default to null)
RangeFilter *dropOffTimeWindow = ; // Filter: match drop off time window. (optional) (default to null)
String *externalId = externalId_example; // Filter: match by externalId (optional) (default to null)
String *pickUpLocation = pickUpLocation_example; // Filter: match by pickup location. (optional) (default to null)
String *dropOffLocation = dropOffLocation_example; // Filter: match by drop off location. (optional) (default to null)
date *dateFrom = 2013-10-20; // Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
date *dateTo = 2013-10-20; // Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance bookingsWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    status:status
    pickUpTimeWindow:pickUpTimeWindow
    dropOffTimeWindow:dropOffTimeWindow
    externalId:externalId
    pickUpLocation:pickUpLocation
    dropOffLocation:dropOffLocation
    dateFrom:dateFrom
    dateTo:dateTo
    attributes:attributes
    searchText:searchText
              completionHandler: ^(BookingsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'status': , // {array[BookingStatus]} Filter: list of booking statuses to match.
  'pickUpTimeWindow': , // {RangeFilter} Filter: match pickup time window.
  'dropOffTimeWindow': , // {RangeFilter} Filter: match drop off time window.
  'externalId': externalId_example, // {String} Filter: match by externalId
  'pickUpLocation': pickUpLocation_example, // {String} Filter: match by pickup location.
  'dropOffLocation': dropOffLocation_example, // {String} Filter: match by drop off location.
  'dateFrom': 2013-10-20, // {date} Filter: match bookings with pickup time window starting from given date (inclusive).
  'dateTo': 2013-10-20, // {date} Filter: match bookings with drop off time window ending at given date (inclusive).
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var status = new array[BookingStatus](); // array[BookingStatus] | Filter: list of booking statuses to match. (optional)  (default to null)
            var pickUpTimeWindow = new RangeFilter(); // RangeFilter | Filter: match pickup time window. (optional)  (default to null)
            var dropOffTimeWindow = new RangeFilter(); // RangeFilter | Filter: match drop off time window. (optional)  (default to null)
            var externalId = externalId_example;  // String | Filter: match by externalId (optional)  (default to null)
            var pickUpLocation = pickUpLocation_example;  // String | Filter: match by pickup location. (optional)  (default to null)
            var dropOffLocation = dropOffLocation_example;  // String | Filter: match by drop off location. (optional)  (default to null)
            var dateFrom = 2013-10-20;  // date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional)  (default to null)
            var dateTo = 2013-10-20;  // date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                BookingsPage result = apiInstance.bookings(tenantId, offset, limit, orderBy, status, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$status = ; // array[BookingStatus] | Filter: list of booking statuses to match.
$pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
$dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
$externalId = externalId_example; // String | Filter: match by externalId
$pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
$dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
$dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
$dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->bookings($tenantId, $offset, $limit, $orderBy, $status, $pickUpTimeWindow, $dropOffTimeWindow, $externalId, $pickUpLocation, $dropOffLocation, $dateFrom, $dateTo, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BookingsApi->bookings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::BookingsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $status = []; # array[BookingStatus] | Filter: list of booking statuses to match.
my $pickUpTimeWindow = ; # RangeFilter | Filter: match pickup time window.
my $dropOffTimeWindow = ; # RangeFilter | Filter: match drop off time window.
my $externalId = externalId_example; # String | Filter: match by externalId
my $pickUpLocation = pickUpLocation_example; # String | Filter: match by pickup location.
my $dropOffLocation = dropOffLocation_example; # String | Filter: match by drop off location.
my $dateFrom = 2013-10-20; # date | Filter: match bookings with pickup time window starting from given date (inclusive).
my $dateTo = 2013-10-20; # date | Filter: match bookings with drop off time window ending at given date (inclusive).
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->bookings(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, status => $status, pickUpTimeWindow => $pickUpTimeWindow, dropOffTimeWindow => $dropOffTimeWindow, externalId => $externalId, pickUpLocation => $pickUpLocation, dropOffLocation => $dropOffLocation, dateFrom => $dateFrom, dateTo => $dateTo, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BookingsApi->bookings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
status =  # array[BookingStatus] | Filter: list of booking statuses to match. (optional) (default to null)
pickUpTimeWindow =  # RangeFilter | Filter: match pickup time window. (optional) (default to null)
dropOffTimeWindow =  # RangeFilter | Filter: match drop off time window. (optional) (default to null)
externalId = externalId_example # String | Filter: match by externalId (optional) (default to null)
pickUpLocation = pickUpLocation_example # String | Filter: match by pickup location. (optional) (default to null)
dropOffLocation = dropOffLocation_example # String | Filter: match by drop off location. (optional) (default to null)
dateFrom = 2013-10-20 # date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
dateTo = 2013-10-20 # date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.bookings(tenantId, offset=offset, limit=limit, orderBy=orderBy, status=status, pickUpTimeWindow=pickUpTimeWindow, dropOffTimeWindow=dropOffTimeWindow, externalId=externalId, pickUpLocation=pickUpLocation, dropOffLocation=dropOffLocation, dateFrom=dateFrom, dateTo=dateTo, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookings: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let status = ; // array[BookingStatus]
    let pickUpTimeWindow = ; // RangeFilter
    let dropOffTimeWindow = ; // RangeFilter
    let externalId = externalId_example; // String
    let pickUpLocation = pickUpLocation_example; // String
    let dropOffLocation = dropOffLocation_example; // String
    let dateFrom = 2013-10-20; // date
    let dateTo = 2013-10-20; // date
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = BookingsApi::Context::default();
    let result = client.bookings(tenantId, offset, limit, orderBy, status, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
status
array[BookingStatus]
Filter: list of booking statuses to match.
pickUpTimeWindow
RangeFilter
Filter: match pickup time window.
dropOffTimeWindow
RangeFilter
Filter: match drop off time window.
externalId
String
Filter: match by externalId
pickUpLocation
String
Filter: match by pickup location.
dropOffLocation
String
Filter: match by drop off location.
dateFrom
date (date)
Filter: match bookings with pickup time window starting from given date (inclusive).
dateTo
date (date)
Filter: match bookings with drop off time window ending at given date (inclusive).
attributes
String
searchText
String
Filter: match by name or address.

Responses


bookingsById

Get a batch of booking objects


/booking/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/booking/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&ids=ids_example&allOrNothing=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.BookingsApi;

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

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

        // Create an instance of the API class
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String ids = ids_example; // String | 
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.

        try {
            array[BookingOrError] result = apiInstance.bookingsById(tenantId, ids, allOrNothing);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingsById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.BookingsApi;

public class BookingsApiExample {
    public static void main(String[] args) {
        BookingsApi apiInstance = new BookingsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String ids = ids_example; // String | 
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.

        try {
            array[BookingOrError] result = apiInstance.bookingsById(tenantId, ids, allOrNothing);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BookingsApi#bookingsById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
BookingsApi *apiInstance = [[BookingsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
String *ids = ids_example; //  (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)

[apiInstance bookingsByIdWith:tenantId
    ids:ids
    allOrNothing:allOrNothing
              completionHandler: ^(array[BookingOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.BookingsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var ids = ids_example; // {String} 
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.

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

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

            // Create an instance of the API class
            var apiInstance = new BookingsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var ids = ids_example;  // String |  (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)

            try {
                array[BookingOrError] result = apiInstance.bookingsById(tenantId, ids, allOrNothing);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling BookingsApi.bookingsById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\BookingsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$ids = ids_example; // String | 
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::BookingsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $ids = ids_example; # String | 
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.

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

# Create an instance of the API class
api_instance = openapi_client.BookingsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
ids = ids_example # String |  (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)

try:
    api_response = api_instance.bookings_by_id(tenantId, ids, allOrNothing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BookingsApi->bookingsById: %s\n" % e)
extern crate BookingsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let ids = ids_example; // String
    let allOrNothing = true; // Boolean

    let mut context = BookingsApi::Context::default();
    let result = client.bookingsById(tenantId, ids, allOrNothing, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
ids*
String
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required

Responses


Drivers

driverBatchUpdate

Update a batch of drivers


/driver/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/driver/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "driverArgs" : {
    "attributes" : "attributes"
  },
  "allOrNothing" : true,
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverBatchUpdateRequest driverBatchUpdateRequest = ; // DriverBatchUpdateRequest | 

        try {
            array[DriverOrError] result = apiInstance.driverBatchUpdate(tenantId, driverBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverBatchUpdateRequest driverBatchUpdateRequest = ; // DriverBatchUpdateRequest | 

        try {
            array[DriverOrError] result = apiInstance.driverBatchUpdate(tenantId, driverBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
DriverBatchUpdateRequest *driverBatchUpdateRequest = ; //  (optional)

[apiInstance driverBatchUpdateWith:tenantId
    driverBatchUpdateRequest:driverBatchUpdateRequest
              completionHandler: ^(array[DriverOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'driverBatchUpdateRequest':  // {DriverBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var driverBatchUpdateRequest = new DriverBatchUpdateRequest(); // DriverBatchUpdateRequest |  (optional) 

            try {
                array[DriverOrError] result = apiInstance.driverBatchUpdate(tenantId, driverBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$driverBatchUpdateRequest = ; // DriverBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $driverBatchUpdateRequest = WWW::OPenAPIClient::Object::DriverBatchUpdateRequest->new(); # DriverBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
driverBatchUpdateRequest =  # DriverBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.driver_batch_update(tenantId, driverBatchUpdateRequest=driverBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverBatchUpdate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let driverBatchUpdateRequest = ; // DriverBatchUpdateRequest

    let mut context = DriversApi::Context::default();
    let result = client.driverBatchUpdate(tenantId, driverBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
driverBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


driverBookingAttributesUpdate

Endpoint for updating booking's attributes.


/driver/booking

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/driver/booking?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d×tamp=56&routeId=38400000-8cf0-11bd-b23e-10b96e4ef00d&bookingId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "update" : {
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the booking to be changed
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp
        DriverAttributesUpdateRequest driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

        try {
            Booking result = apiInstance.driverBookingAttributesUpdate(tenantId, routeId, bookingId, timestamp, driverAttributesUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverBookingAttributesUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the booking to be changed
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp
        DriverAttributesUpdateRequest driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

        try {
            Booking result = apiInstance.driverBookingAttributesUpdate(tenantId, routeId, bookingId, timestamp, driverAttributesUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverBookingAttributesUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the route of the task/booking/subtask to be changed (default to null)
UUID *bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the booking to be changed (default to null)
Integer *timestamp = 56; // Integer representing epoch timestamp (optional) (default to null)
DriverAttributesUpdateRequest *driverAttributesUpdateRequest = ; //  (optional)

[apiInstance driverBookingAttributesUpdateWith:tenantId
    routeId:routeId
    bookingId:bookingId
    timestamp:timestamp
    driverAttributesUpdateRequest:driverAttributesUpdateRequest
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identifier of the route of the task/booking/subtask to be changed
var bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identifier of the booking to be changed
var opts = {
  'timestamp': 56, // {Integer} Integer representing epoch timestamp
  'driverAttributesUpdateRequest':  // {DriverAttributesUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
            var bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the booking to be changed (default to null)
            var timestamp = 56;  // Integer | Integer representing epoch timestamp (optional)  (default to null)
            var driverAttributesUpdateRequest = new DriverAttributesUpdateRequest(); // DriverAttributesUpdateRequest |  (optional) 

            try {
                Booking result = apiInstance.driverBookingAttributesUpdate(tenantId, routeId, bookingId, timestamp, driverAttributesUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverBookingAttributesUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
$bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the booking to be changed
$timestamp = 56; // Integer | Integer representing epoch timestamp
$driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

try {
    $result = $api_instance->driverBookingAttributesUpdate($tenantId, $routeId, $bookingId, $timestamp, $driverAttributesUpdateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driverBookingAttributesUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DriversApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the route of the task/booking/subtask to be changed
my $bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the booking to be changed
my $timestamp = 56; # Integer | Integer representing epoch timestamp
my $driverAttributesUpdateRequest = WWW::OPenAPIClient::Object::DriverAttributesUpdateRequest->new(); # DriverAttributesUpdateRequest | 

eval {
    my $result = $api_instance->driverBookingAttributesUpdate(tenantId => $tenantId, routeId => $routeId, bookingId => $bookingId, timestamp => $timestamp, driverAttributesUpdateRequest => $driverAttributesUpdateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DriversApi->driverBookingAttributesUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the booking to be changed (default to null)
timestamp = 56 # Integer | Integer representing epoch timestamp (optional) (default to null)
driverAttributesUpdateRequest =  # DriverAttributesUpdateRequest |  (optional)

try:
    api_response = api_instance.driver_booking_attributes_update(tenantId, routeId, bookingId, timestamp=timestamp, driverAttributesUpdateRequest=driverAttributesUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverBookingAttributesUpdate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let bookingId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let timestamp = 56; // Integer
    let driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest

    let mut context = DriversApi::Context::default();
    let result = client.driverBookingAttributesUpdate(tenantId, routeId, bookingId, timestamp, driverAttributesUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
driverAttributesUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
timestamp
Integer
Integer representing epoch timestamp
routeId*
UUID (uuid)
Identifier of the route of the task/booking/subtask to be changed
Required
bookingId*
UUID (uuid)
Identifier of the booking to be changed
Required

Responses


driverById

Get driver object


/driver

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Driver result = apiInstance.driverById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Driver result = apiInstance.driverById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance driverByIdWith:tenantId
    id:id
              completionHandler: ^(Driver output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.driver_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverById: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DriversApi::Context::default();
    let result = client.driverById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


driverConfirmedRoutes

List confirmed route for a driver


/driver/confirmedRoutes

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver/confirmedRoutes?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&attributes=attributes_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 

        try {
            DriverRoutesPage result = apiInstance.driverConfirmedRoutes(tenantId, offset, limit, orderBy, attributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverConfirmedRoutes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 

        try {
            DriverRoutesPage result = apiInstance.driverConfirmedRoutes(tenantId, offset, limit, orderBy, attributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverConfirmedRoutes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)

[apiInstance driverConfirmedRoutesWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    attributes:attributes
              completionHandler: ^(DriverRoutesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'attributes': attributes_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)

            try {
                DriverRoutesPage result = apiInstance.driverConfirmedRoutes(tenantId, offset, limit, orderBy, attributes);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverConfirmedRoutes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$attributes = attributes_example; // String | 

try {
    $result = $api_instance->driverConfirmedRoutes($tenantId, $offset, $limit, $orderBy, $attributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driverConfirmedRoutes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DriversApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $attributes = attributes_example; # String | 

eval {
    my $result = $api_instance->driverConfirmedRoutes(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, attributes => $attributes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DriversApi->driverConfirmedRoutes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)

try:
    api_response = api_instance.driver_confirmed_routes(tenantId, offset=offset, limit=limit, orderBy=orderBy, attributes=attributes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverConfirmedRoutes: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let attributes = attributes_example; // String

    let mut context = DriversApi::Context::default();
    let result = client.driverConfirmedRoutes(tenantId, offset, limit, orderBy, attributes, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
attributes
String

Responses


driverCreate

Create a driver


/driver

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/driver?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "driver" : {
    "attributes" : "attributes",
    "userId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverCreateRequest driverCreateRequest = ; // DriverCreateRequest | 

        try {
            Driver result = apiInstance.driverCreate(tenantId, driverCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverCreateRequest driverCreateRequest = ; // DriverCreateRequest | 

        try {
            Driver result = apiInstance.driverCreate(tenantId, driverCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
DriverCreateRequest *driverCreateRequest = ; //  (optional)

[apiInstance driverCreateWith:tenantId
    driverCreateRequest:driverCreateRequest
              completionHandler: ^(Driver output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'driverCreateRequest':  // {DriverCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var driverCreateRequest = new DriverCreateRequest(); // DriverCreateRequest |  (optional) 

            try {
                Driver result = apiInstance.driverCreate(tenantId, driverCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$driverCreateRequest = ; // DriverCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $driverCreateRequest = WWW::OPenAPIClient::Object::DriverCreateRequest->new(); # DriverCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
driverCreateRequest =  # DriverCreateRequest |  (optional)

try:
    api_response = api_instance.driver_create(tenantId, driverCreateRequest=driverCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverCreate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let driverCreateRequest = ; // DriverCreateRequest

    let mut context = DriversApi::Context::default();
    let result = client.driverCreate(tenantId, driverCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
driverCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


driverDelete

Delete a driver


/driver

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.driverDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.driverDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance driverDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.driverDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.driver_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling DriversApi->driverDelete: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DriversApi::Context::default();
    let result = client.driverDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


driverRoute

Get current route of logged driver. Empty if there is no route in execution at the moment associated with the driver.


/driver/route

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver/route?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&routeId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route to be fetched

        try {
            RoutingRouteExtended result = apiInstance.driverRoute(tenantId, routeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverRoute");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route to be fetched

        try {
            RoutingRouteExtended result = apiInstance.driverRoute(tenantId, routeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverRoute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the route to be fetched (optional) (default to null)

[apiInstance driverRouteWith:tenantId
    routeId:routeId
              completionHandler: ^(RoutingRouteExtended output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routeId': 38400000-8cf0-11bd-b23e-10b96e4ef00d // {UUID} Identifier of the route to be fetched
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the route to be fetched (optional)  (default to null)

            try {
                RoutingRouteExtended result = apiInstance.driverRoute(tenantId, routeId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverRoute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route to be fetched

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the route to be fetched

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the route to be fetched (optional) (default to null)

try:
    api_response = api_instance.driver_route(tenantId, routeId=routeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverRoute: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = DriversApi::Context::default();
    let result = client.driverRoute(tenantId, routeId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
routeId
UUID (uuid)
Identifier of the route to be fetched

Responses


driverSubtaskUpdate

Endpoint for updating subtask's status and/or attributes.


/driver/subtask

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/driver/subtask?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d×tamp=56&routeId=38400000-8cf0-11bd-b23e-10b96e4ef00d&subtaskId=38400000-8cf0-11bd-b23e-10b96e4ef00d&subtaskStatus=subtaskStatus_example" \
 -d '{
  "update" : {
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the subtask to be changed
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp
        String subtaskStatus = subtaskStatus_example; // String | New status of the subtask
        DriverAttributesUpdateRequest driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

        try {
            Booking result = apiInstance.driverSubtaskUpdate(tenantId, routeId, subtaskId, timestamp, subtaskStatus, driverAttributesUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverSubtaskUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the subtask to be changed
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp
        String subtaskStatus = subtaskStatus_example; // String | New status of the subtask
        DriverAttributesUpdateRequest driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

        try {
            Booking result = apiInstance.driverSubtaskUpdate(tenantId, routeId, subtaskId, timestamp, subtaskStatus, driverAttributesUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverSubtaskUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the route of the task/booking/subtask to be changed (default to null)
UUID *subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the subtask to be changed (default to null)
Integer *timestamp = 56; // Integer representing epoch timestamp (optional) (default to null)
String *subtaskStatus = subtaskStatus_example; // New status of the subtask (optional) (default to null)
DriverAttributesUpdateRequest *driverAttributesUpdateRequest = ; //  (optional)

[apiInstance driverSubtaskUpdateWith:tenantId
    routeId:routeId
    subtaskId:subtaskId
    timestamp:timestamp
    subtaskStatus:subtaskStatus
    driverAttributesUpdateRequest:driverAttributesUpdateRequest
              completionHandler: ^(Booking output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identifier of the route of the task/booking/subtask to be changed
var subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identifier of the subtask to be changed
var opts = {
  'timestamp': 56, // {Integer} Integer representing epoch timestamp
  'subtaskStatus': subtaskStatus_example, // {String} New status of the subtask
  'driverAttributesUpdateRequest':  // {DriverAttributesUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
            var subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the subtask to be changed (default to null)
            var timestamp = 56;  // Integer | Integer representing epoch timestamp (optional)  (default to null)
            var subtaskStatus = subtaskStatus_example;  // String | New status of the subtask (optional)  (default to null)
            var driverAttributesUpdateRequest = new DriverAttributesUpdateRequest(); // DriverAttributesUpdateRequest |  (optional) 

            try {
                Booking result = apiInstance.driverSubtaskUpdate(tenantId, routeId, subtaskId, timestamp, subtaskStatus, driverAttributesUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverSubtaskUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
$subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the subtask to be changed
$timestamp = 56; // Integer | Integer representing epoch timestamp
$subtaskStatus = subtaskStatus_example; // String | New status of the subtask
$driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest | 

try {
    $result = $api_instance->driverSubtaskUpdate($tenantId, $routeId, $subtaskId, $timestamp, $subtaskStatus, $driverAttributesUpdateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driverSubtaskUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DriversApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the route of the task/booking/subtask to be changed
my $subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the subtask to be changed
my $timestamp = 56; # Integer | Integer representing epoch timestamp
my $subtaskStatus = subtaskStatus_example; # String | New status of the subtask
my $driverAttributesUpdateRequest = WWW::OPenAPIClient::Object::DriverAttributesUpdateRequest->new(); # DriverAttributesUpdateRequest | 

eval {
    my $result = $api_instance->driverSubtaskUpdate(tenantId => $tenantId, routeId => $routeId, subtaskId => $subtaskId, timestamp => $timestamp, subtaskStatus => $subtaskStatus, driverAttributesUpdateRequest => $driverAttributesUpdateRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DriversApi->driverSubtaskUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the subtask to be changed (default to null)
timestamp = 56 # Integer | Integer representing epoch timestamp (optional) (default to null)
subtaskStatus = subtaskStatus_example # String | New status of the subtask (optional) (default to null)
driverAttributesUpdateRequest =  # DriverAttributesUpdateRequest |  (optional)

try:
    api_response = api_instance.driver_subtask_update(tenantId, routeId, subtaskId, timestamp=timestamp, subtaskStatus=subtaskStatus, driverAttributesUpdateRequest=driverAttributesUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverSubtaskUpdate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let subtaskId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let timestamp = 56; // Integer
    let subtaskStatus = subtaskStatus_example; // String
    let driverAttributesUpdateRequest = ; // DriverAttributesUpdateRequest

    let mut context = DriversApi::Context::default();
    let result = client.driverSubtaskUpdate(tenantId, routeId, subtaskId, timestamp, subtaskStatus, driverAttributesUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
driverAttributesUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
timestamp
Integer
Integer representing epoch timestamp
routeId*
UUID (uuid)
Identifier of the route of the task/booking/subtask to be changed
Required
subtaskId*
UUID (uuid)
Identifier of the subtask to be changed
Required
subtaskStatus
String
New status of the subtask

Responses


driverTaskUpdate

Endpoint for reporting a new task status.


/driver/task

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver/task?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d×tamp=56&routeId=38400000-8cf0-11bd-b23e-10b96e4ef00d&taskIndex=38400000-8cf0-11bd-b23e-10b96e4ef00d&taskStatus="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Index (0-based) of the task in the route
        RoutingTaskStatus taskStatus = ; // RoutingTaskStatus | New status of the task
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp

        try {
            RoutingTask result = apiInstance.driverTaskUpdate(tenantId, routeId, taskIndex, taskStatus, timestamp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverTaskUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
        UUID taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Index (0-based) of the task in the route
        RoutingTaskStatus taskStatus = ; // RoutingTaskStatus | New status of the task
        Integer timestamp = 56; // Integer | Integer representing epoch timestamp

        try {
            RoutingTask result = apiInstance.driverTaskUpdate(tenantId, routeId, taskIndex, taskStatus, timestamp);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverTaskUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Identifier of the route of the task/booking/subtask to be changed (default to null)
UUID *taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Index (0-based) of the task in the route (default to null)
RoutingTaskStatus *taskStatus = ; // New status of the task (default to null)
Integer *timestamp = 56; // Integer representing epoch timestamp (optional) (default to null)

[apiInstance driverTaskUpdateWith:tenantId
    routeId:routeId
    taskIndex:taskIndex
    taskStatus:taskStatus
    timestamp:timestamp
              completionHandler: ^(RoutingTask output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Identifier of the route of the task/booking/subtask to be changed
var taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} Index (0-based) of the task in the route
var taskStatus = ; // {RoutingTaskStatus} New status of the task
var opts = {
  'timestamp': 56 // {Integer} Integer representing epoch timestamp
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
            var taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Index (0-based) of the task in the route (default to null)
            var taskStatus = new RoutingTaskStatus(); // RoutingTaskStatus | New status of the task (default to null)
            var timestamp = 56;  // Integer | Integer representing epoch timestamp (optional)  (default to null)

            try {
                RoutingTask result = apiInstance.driverTaskUpdate(tenantId, routeId, taskIndex, taskStatus, timestamp);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverTaskUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Identifier of the route of the task/booking/subtask to be changed
$taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Index (0-based) of the task in the route
$taskStatus = ; // RoutingTaskStatus | New status of the task
$timestamp = 56; // Integer | Integer representing epoch timestamp

try {
    $result = $api_instance->driverTaskUpdate($tenantId, $routeId, $taskIndex, $taskStatus, $timestamp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->driverTaskUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DriversApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Identifier of the route of the task/booking/subtask to be changed
my $taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Index (0-based) of the task in the route
my $taskStatus = ; # RoutingTaskStatus | New status of the task
my $timestamp = 56; # Integer | Integer representing epoch timestamp

eval {
    my $result = $api_instance->driverTaskUpdate(tenantId => $tenantId, routeId => $routeId, taskIndex => $taskIndex, taskStatus => $taskStatus, timestamp => $timestamp);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DriversApi->driverTaskUpdate: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Identifier of the route of the task/booking/subtask to be changed (default to null)
taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Index (0-based) of the task in the route (default to null)
taskStatus =  # RoutingTaskStatus | New status of the task (default to null)
timestamp = 56 # Integer | Integer representing epoch timestamp (optional) (default to null)

try:
    api_response = api_instance.driver_task_update(tenantId, routeId, taskIndex, taskStatus, timestamp=timestamp)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverTaskUpdate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routeId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let taskIndex = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let taskStatus = ; // RoutingTaskStatus
    let timestamp = 56; // Integer

    let mut context = DriversApi::Context::default();
    let result = client.driverTaskUpdate(tenantId, routeId, taskIndex, taskStatus, timestamp, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
timestamp
Integer
Integer representing epoch timestamp
routeId*
UUID (uuid)
Identifier of the route of the task/booking/subtask to be changed
Required
taskIndex*
UUID (uuid)
Index (0-based) of the task in the route
Required
taskStatus*
RoutingTaskStatus
New status of the task
Required

Responses


driverUpdate

Update a driver


/driver

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/driver?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "driver" : {
    "attributes" : "attributes",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "userId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "version" : "version"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverUpdateRequest driverUpdateRequest = ; // DriverUpdateRequest | 

        try {
            Driver result = apiInstance.driverUpdate(tenantId, driverUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        DriverUpdateRequest driverUpdateRequest = ; // DriverUpdateRequest | 

        try {
            Driver result = apiInstance.driverUpdate(tenantId, driverUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driverUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
DriverUpdateRequest *driverUpdateRequest = ; //  (optional)

[apiInstance driverUpdateWith:tenantId
    driverUpdateRequest:driverUpdateRequest
              completionHandler: ^(Driver output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'driverUpdateRequest':  // {DriverUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var driverUpdateRequest = new DriverUpdateRequest(); // DriverUpdateRequest |  (optional) 

            try {
                Driver result = apiInstance.driverUpdate(tenantId, driverUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driverUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$driverUpdateRequest = ; // DriverUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $driverUpdateRequest = WWW::OPenAPIClient::Object::DriverUpdateRequest->new(); # DriverUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
driverUpdateRequest =  # DriverUpdateRequest |  (optional)

try:
    api_response = api_instance.driver_update(tenantId, driverUpdateRequest=driverUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driverUpdate: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let driverUpdateRequest = ; // DriverUpdateRequest

    let mut context = DriversApi::Context::default();
    let result = client.driverUpdate(tenantId, driverUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
driverUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


drivers

List drivers with filtering/sorting options


/driver/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&attributes=attributes_example&employment=&phone=phone_example&name=name_example&email=email_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        array[DriverEmployment] employment = ; // array[DriverEmployment] | Filter: match by employment type.
        String phone = phone_example; // String | Filter by driver phone number.
        String name = name_example; // String | Filter by driver name.
        String email = email_example; // String | Filter by driver email.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            DriversPage result = apiInstance.drivers(tenantId, offset, limit, orderBy, attributes, employment, phone, name, email, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#drivers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        array[DriverEmployment] employment = ; // array[DriverEmployment] | Filter: match by employment type.
        String phone = phone_example; // String | Filter by driver phone number.
        String name = name_example; // String | Filter by driver name.
        String email = email_example; // String | Filter by driver email.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            DriversPage result = apiInstance.drivers(tenantId, offset, limit, orderBy, attributes, employment, phone, name, email, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#drivers");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
array[DriverEmployment] *employment = ; // Filter: match by employment type. (optional) (default to null)
String *phone = phone_example; // Filter by driver phone number. (optional) (default to null)
String *name = name_example; // Filter by driver name. (optional) (default to null)
String *email = email_example; // Filter by driver email. (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance driversWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    attributes:attributes
    employment:employment
    phone:phone
    name:name
    email:email
    searchText:searchText
              completionHandler: ^(DriversPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'attributes': attributes_example, // {String} 
  'employment': , // {array[DriverEmployment]} Filter: match by employment type.
  'phone': phone_example, // {String} Filter by driver phone number.
  'name': name_example, // {String} Filter by driver name.
  'email': email_example, // {String} Filter by driver email.
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var employment = new array[DriverEmployment](); // array[DriverEmployment] | Filter: match by employment type. (optional)  (default to null)
            var phone = phone_example;  // String | Filter by driver phone number. (optional)  (default to null)
            var name = name_example;  // String | Filter by driver name. (optional)  (default to null)
            var email = email_example;  // String | Filter by driver email. (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                DriversPage result = apiInstance.drivers(tenantId, offset, limit, orderBy, attributes, employment, phone, name, email, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.drivers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$attributes = attributes_example; // String | 
$employment = ; // array[DriverEmployment] | Filter: match by employment type.
$phone = phone_example; // String | Filter by driver phone number.
$name = name_example; // String | Filter by driver name.
$email = email_example; // String | Filter by driver email.
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->drivers($tenantId, $offset, $limit, $orderBy, $attributes, $employment, $phone, $name, $email, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DriversApi->drivers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DriversApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $attributes = attributes_example; # String | 
my $employment = []; # array[DriverEmployment] | Filter: match by employment type.
my $phone = phone_example; # String | Filter by driver phone number.
my $name = name_example; # String | Filter by driver name.
my $email = email_example; # String | Filter by driver email.
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->drivers(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, attributes => $attributes, employment => $employment, phone => $phone, name => $name, email => $email, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DriversApi->drivers: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
employment =  # array[DriverEmployment] | Filter: match by employment type. (optional) (default to null)
phone = phone_example # String | Filter by driver phone number. (optional) (default to null)
name = name_example # String | Filter by driver name. (optional) (default to null)
email = email_example # String | Filter by driver email. (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.drivers(tenantId, offset=offset, limit=limit, orderBy=orderBy, attributes=attributes, employment=employment, phone=phone, name=name, email=email, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->drivers: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let attributes = attributes_example; // String
    let employment = ; // array[DriverEmployment]
    let phone = phone_example; // String
    let name = name_example; // String
    let email = email_example; // String
    let searchText = searchText_example; // String

    let mut context = DriversApi::Context::default();
    let result = client.drivers(tenantId, offset, limit, orderBy, attributes, employment, phone, name, email, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
attributes
String
employment
array[DriverEmployment]
Filter: match by employment type.
phone
String
Filter by driver phone number.
name
String
Filter by driver name.
email
String
Filter by driver email.
searchText
String
Filter: match by name or address.

Responses


driversById

Get a batch of driver objects


/driver/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/driver/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DriversApi;

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

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

        // Create an instance of the API class
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[DriverOrError] result = apiInstance.driversById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driversById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DriversApi;

public class DriversApiExample {
    public static void main(String[] args) {
        DriversApi apiInstance = new DriversApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[DriverOrError] result = apiInstance.driversById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DriversApi#driversById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DriversApi *apiInstance = [[DriversApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance driversByIdWith:tenantId
    allOrNothing:allOrNothing
    ids:ids
              completionHandler: ^(array[DriverOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.DriversApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new DriversApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[DriverOrError] result = apiInstance.driversById(tenantId, allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DriversApi.driversById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DriversApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DriversApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DriversApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.drivers_by_id(tenantId, allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DriversApi->driversById: %s\n" % e)
extern crate DriversApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = DriversApi::Context::default();
    let result = client.driversById(tenantId, allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses


PoiTypes

poiTypeBatchUpdate

Update a batch of POI types


/poiType/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poiType/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "allOrNothing" : true,
  "poiTypeArgs" : {
    "isDepot" : true,
    "attributes" : "attributes"
  },
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeBatchUpdateRequest poiTypeBatchUpdateRequest = ; // PoiTypeBatchUpdateRequest | 

        try {
            array[PoiTypeOrError] result = apiInstance.poiTypeBatchUpdate(tenantId, poiTypeBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeBatchUpdateRequest poiTypeBatchUpdateRequest = ; // PoiTypeBatchUpdateRequest | 

        try {
            array[PoiTypeOrError] result = apiInstance.poiTypeBatchUpdate(tenantId, poiTypeBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PoiTypeBatchUpdateRequest *poiTypeBatchUpdateRequest = ; //  (optional)

[apiInstance poiTypeBatchUpdateWith:tenantId
    poiTypeBatchUpdateRequest:poiTypeBatchUpdateRequest
              completionHandler: ^(array[PoiTypeOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'poiTypeBatchUpdateRequest':  // {PoiTypeBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var poiTypeBatchUpdateRequest = new PoiTypeBatchUpdateRequest(); // PoiTypeBatchUpdateRequest |  (optional) 

            try {
                array[PoiTypeOrError] result = apiInstance.poiTypeBatchUpdate(tenantId, poiTypeBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypeBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$poiTypeBatchUpdateRequest = ; // PoiTypeBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $poiTypeBatchUpdateRequest = WWW::OPenAPIClient::Object::PoiTypeBatchUpdateRequest->new(); # PoiTypeBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
poiTypeBatchUpdateRequest =  # PoiTypeBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.poi_type_batch_update(tenantId, poiTypeBatchUpdateRequest=poiTypeBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypeBatchUpdate: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let poiTypeBatchUpdateRequest = ; // PoiTypeBatchUpdateRequest

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypeBatchUpdate(tenantId, poiTypeBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
poiTypeBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiTypeById

Get POI type object


/poiType

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poiType?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            PoiType result = apiInstance.poiTypeById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            PoiType result = apiInstance.poiTypeById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance poiTypeByIdWith:tenantId
    id:id
              completionHandler: ^(PoiType output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.poi_type_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypeById: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypeById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


poiTypeCreate

Create a POI type


/poiType

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poiType?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "poiType" : {
    "isDepot" : true,
    "name" : "name",
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeCreateRequest poiTypeCreateRequest = ; // PoiTypeCreateRequest | 

        try {
            PoiType result = apiInstance.poiTypeCreate(tenantId, poiTypeCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeCreateRequest poiTypeCreateRequest = ; // PoiTypeCreateRequest | 

        try {
            PoiType result = apiInstance.poiTypeCreate(tenantId, poiTypeCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PoiTypeCreateRequest *poiTypeCreateRequest = ; //  (optional)

[apiInstance poiTypeCreateWith:tenantId
    poiTypeCreateRequest:poiTypeCreateRequest
              completionHandler: ^(PoiType output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'poiTypeCreateRequest':  // {PoiTypeCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var poiTypeCreateRequest = new PoiTypeCreateRequest(); // PoiTypeCreateRequest |  (optional) 

            try {
                PoiType result = apiInstance.poiTypeCreate(tenantId, poiTypeCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypeCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$poiTypeCreateRequest = ; // PoiTypeCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $poiTypeCreateRequest = WWW::OPenAPIClient::Object::PoiTypeCreateRequest->new(); # PoiTypeCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
poiTypeCreateRequest =  # PoiTypeCreateRequest |  (optional)

try:
    api_response = api_instance.poi_type_create(tenantId, poiTypeCreateRequest=poiTypeCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypeCreate: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let poiTypeCreateRequest = ; // PoiTypeCreateRequest

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypeCreate(tenantId, poiTypeCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
poiTypeCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiTypeDelete

Delete a POI type


/poiType

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poiType?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.poiTypeDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.poiTypeDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance poiTypeDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.poiTypeDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypeDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.poi_type_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypeDelete: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypeDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


poiTypeUpdate

Update a POI type


/poiType

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poiType?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "poiType" : {
    "isDepot" : true,
    "name" : "name",
    "attributes" : "attributes",
    "id" : "id",
    "version" : "version"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeUpdateRequest poiTypeUpdateRequest = ; // PoiTypeUpdateRequest | 

        try {
            PoiType result = apiInstance.poiTypeUpdate(tenantId, poiTypeUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PoiTypeUpdateRequest poiTypeUpdateRequest = ; // PoiTypeUpdateRequest | 

        try {
            PoiType result = apiInstance.poiTypeUpdate(tenantId, poiTypeUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypeUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PoiTypeUpdateRequest *poiTypeUpdateRequest = ; //  (optional)

[apiInstance poiTypeUpdateWith:tenantId
    poiTypeUpdateRequest:poiTypeUpdateRequest
              completionHandler: ^(PoiType output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'poiTypeUpdateRequest':  // {PoiTypeUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var poiTypeUpdateRequest = new PoiTypeUpdateRequest(); // PoiTypeUpdateRequest |  (optional) 

            try {
                PoiType result = apiInstance.poiTypeUpdate(tenantId, poiTypeUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$poiTypeUpdateRequest = ; // PoiTypeUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $poiTypeUpdateRequest = WWW::OPenAPIClient::Object::PoiTypeUpdateRequest->new(); # PoiTypeUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
poiTypeUpdateRequest =  # PoiTypeUpdateRequest |  (optional)

try:
    api_response = api_instance.poi_type_update(tenantId, poiTypeUpdateRequest=poiTypeUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypeUpdate: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let poiTypeUpdateRequest = ; // PoiTypeUpdateRequest

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypeUpdate(tenantId, poiTypeUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
poiTypeUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiTypes

List POI types with filtering/sorting options


/poiType/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poiType/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&attributes=attributes_example&isDepot=true&name=name_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        Boolean isDepot = true; // Boolean | Filter: match by isDepot flag.
        String name = name_example; // String | Filter: match by name.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            PoiTypePage result = apiInstance.poiTypes(tenantId, offset, limit, orderBy, attributes, isDepot, name, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        Boolean isDepot = true; // Boolean | Filter: match by isDepot flag.
        String name = name_example; // String | Filter: match by name.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            PoiTypePage result = apiInstance.poiTypes(tenantId, offset, limit, orderBy, attributes, isDepot, name, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
Boolean *isDepot = true; // Filter: match by isDepot flag. (optional) (default to null)
String *name = name_example; // Filter: match by name. (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance poiTypesWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    attributes:attributes
    isDepot:isDepot
    name:name
    searchText:searchText
              completionHandler: ^(PoiTypePage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'attributes': attributes_example, // {String} 
  'isDepot': true, // {Boolean} Filter: match by isDepot flag.
  'name': name_example, // {String} Filter: match by name.
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var isDepot = true;  // Boolean | Filter: match by isDepot flag. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by name. (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                PoiTypePage result = apiInstance.poiTypes(tenantId, offset, limit, orderBy, attributes, isDepot, name, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$attributes = attributes_example; // String | 
$isDepot = true; // Boolean | Filter: match by isDepot flag.
$name = name_example; // String | Filter: match by name.
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->poiTypes($tenantId, $offset, $limit, $orderBy, $attributes, $isDepot, $name, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoiTypesApi->poiTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoiTypesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $attributes = attributes_example; # String | 
my $isDepot = true; # Boolean | Filter: match by isDepot flag.
my $name = name_example; # String | Filter: match by name.
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->poiTypes(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, attributes => $attributes, isDepot => $isDepot, name => $name, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoiTypesApi->poiTypes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
isDepot = true # Boolean | Filter: match by isDepot flag. (optional) (default to null)
name = name_example # String | Filter: match by name. (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.poi_types(tenantId, offset=offset, limit=limit, orderBy=orderBy, attributes=attributes, isDepot=isDepot, name=name, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypes: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let attributes = attributes_example; // String
    let isDepot = true; // Boolean
    let name = name_example; // String
    let searchText = searchText_example; // String

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypes(tenantId, offset, limit, orderBy, attributes, isDepot, name, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
attributes
String
isDepot
Boolean
Filter: match by isDepot flag.
name
String
Filter: match by name.
searchText
String
Filter: match by name or address.

Responses


poiTypesById

Get a batch of POI type objects


/poiType/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poiType/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoiTypesApi;

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

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

        // Create an instance of the API class
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[PoiTypeOrError] result = apiInstance.poiTypesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypesById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoiTypesApi;

public class PoiTypesApiExample {
    public static void main(String[] args) {
        PoiTypesApi apiInstance = new PoiTypesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[PoiTypeOrError] result = apiInstance.poiTypesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoiTypesApi#poiTypesById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoiTypesApi *apiInstance = [[PoiTypesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance poiTypesByIdWith:tenantId
    allOrNothing:allOrNothing
    ids:ids
              completionHandler: ^(array[PoiTypeOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoiTypesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new PoiTypesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[PoiTypeOrError] result = apiInstance.poiTypesById(tenantId, allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoiTypesApi.poiTypesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoiTypesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoiTypesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.PoiTypesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.poi_types_by_id(tenantId, allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoiTypesApi->poiTypesById: %s\n" % e)
extern crate PoiTypesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = PoiTypesApi::Context::default();
    let result = client.poiTypesById(tenantId, allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses


Pois

poiBatchDelete

Delete a batch of points of interest


/poi/batch

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poi/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.poiBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiBatchDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.poiBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiBatchDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BatchDeleteRequest *batchDeleteRequest = ; //  (optional)

[apiInstance poiBatchDeleteWith:tenantId
    batchDeleteRequest:batchDeleteRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'batchDeleteRequest':  // {BatchDeleteRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var batchDeleteRequest = new BatchDeleteRequest(); // BatchDeleteRequest |  (optional) 

            try {
                apiInstance.poiBatchDelete(tenantId, batchDeleteRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiBatchDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$batchDeleteRequest = ; // BatchDeleteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $batchDeleteRequest = WWW::OPenAPIClient::Object::BatchDeleteRequest->new(); # BatchDeleteRequest | 

eval {
    $api_instance->poiBatchDelete(tenantId => $tenantId, batchDeleteRequest => $batchDeleteRequest);
};
if ($@) {
    warn "Exception when calling PoisApi->poiBatchDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
batchDeleteRequest =  # BatchDeleteRequest |  (optional)

try:
    api_instance.poi_batch_delete(tenantId, batchDeleteRequest=batchDeleteRequest)
except ApiException as e:
    print("Exception when calling PoisApi->poiBatchDelete: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let batchDeleteRequest = ; // BatchDeleteRequest

    let mut context = PoisApi::Context::default();
    let result = client.poiBatchDelete(tenantId, batchDeleteRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
batchDeleteRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiBatchUpdate

Update a batch of points of interest


/poi/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poi/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "allOrNothing" : true,
  "ids" : [ "ids", "ids" ],
  "poiArgs" : {
    "typeName" : "typeName",
    "location" : {
      "address" : {
        "country" : "country",
        "streetNumber" : "streetNumber",
        "city" : "city",
        "street" : "street",
        "flatNumber" : "flatNumber",
        "additional" : "additional",
        "postalCode" : "postalCode"
      },
      "position" : {
        "lon" : 0.8008282,
        "lat" : 6.0274563
      }
    },
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestBatchUpdateRequest pointOfInterestBatchUpdateRequest = ; // PointOfInterestBatchUpdateRequest | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poiBatchUpdate(tenantId, pointOfInterestBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestBatchUpdateRequest pointOfInterestBatchUpdateRequest = ; // PointOfInterestBatchUpdateRequest | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poiBatchUpdate(tenantId, pointOfInterestBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PointOfInterestBatchUpdateRequest *pointOfInterestBatchUpdateRequest = ; //  (optional)

[apiInstance poiBatchUpdateWith:tenantId
    pointOfInterestBatchUpdateRequest:pointOfInterestBatchUpdateRequest
              completionHandler: ^(array[PointOfInterestOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'pointOfInterestBatchUpdateRequest':  // {PointOfInterestBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var pointOfInterestBatchUpdateRequest = new PointOfInterestBatchUpdateRequest(); // PointOfInterestBatchUpdateRequest |  (optional) 

            try {
                array[PointOfInterestOrError] result = apiInstance.poiBatchUpdate(tenantId, pointOfInterestBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$pointOfInterestBatchUpdateRequest = ; // PointOfInterestBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $pointOfInterestBatchUpdateRequest = WWW::OPenAPIClient::Object::PointOfInterestBatchUpdateRequest->new(); # PointOfInterestBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
pointOfInterestBatchUpdateRequest =  # PointOfInterestBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.poi_batch_update(tenantId, pointOfInterestBatchUpdateRequest=pointOfInterestBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poiBatchUpdate: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let pointOfInterestBatchUpdateRequest = ; // PointOfInterestBatchUpdateRequest

    let mut context = PoisApi::Context::default();
    let result = client.poiBatchUpdate(tenantId, pointOfInterestBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
pointOfInterestBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiById

Get point of interest object


/poi

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poi?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            PointOfInterest result = apiInstance.poiById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            PointOfInterest result = apiInstance.poiById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance poiByIdWith:tenantId
    id:id
              completionHandler: ^(PointOfInterest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.poi_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poiById: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = PoisApi::Context::default();
    let result = client.poiById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


poiCreate

Create a point of interest


/poi

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poi?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "poi" : {
    "name" : "name",
    "typeName" : "typeName",
    "location" : {
      "address" : {
        "country" : "country",
        "streetNumber" : "streetNumber",
        "city" : "city",
        "street" : "street",
        "flatNumber" : "flatNumber",
        "additional" : "additional",
        "postalCode" : "postalCode"
      },
      "position" : {
        "lon" : 0.8008282,
        "lat" : 6.0274563
      }
    },
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestCreateRequest pointOfInterestCreateRequest = ; // PointOfInterestCreateRequest | 

        try {
            PointOfInterest result = apiInstance.poiCreate(tenantId, pointOfInterestCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestCreateRequest pointOfInterestCreateRequest = ; // PointOfInterestCreateRequest | 

        try {
            PointOfInterest result = apiInstance.poiCreate(tenantId, pointOfInterestCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PointOfInterestCreateRequest *pointOfInterestCreateRequest = ; //  (optional)

[apiInstance poiCreateWith:tenantId
    pointOfInterestCreateRequest:pointOfInterestCreateRequest
              completionHandler: ^(PointOfInterest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'pointOfInterestCreateRequest':  // {PointOfInterestCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var pointOfInterestCreateRequest = new PointOfInterestCreateRequest(); // PointOfInterestCreateRequest |  (optional) 

            try {
                PointOfInterest result = apiInstance.poiCreate(tenantId, pointOfInterestCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$pointOfInterestCreateRequest = ; // PointOfInterestCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $pointOfInterestCreateRequest = WWW::OPenAPIClient::Object::PointOfInterestCreateRequest->new(); # PointOfInterestCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
pointOfInterestCreateRequest =  # PointOfInterestCreateRequest |  (optional)

try:
    api_response = api_instance.poi_create(tenantId, pointOfInterestCreateRequest=pointOfInterestCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poiCreate: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let pointOfInterestCreateRequest = ; // PointOfInterestCreateRequest

    let mut context = PoisApi::Context::default();
    let result = client.poiCreate(tenantId, pointOfInterestCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
pointOfInterestCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


poiCreateBatch

Create a batch of pois


/poi/batch

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poi/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true" \
 -d '{
  "pois" : [ {
    "name" : "name",
    "typeName" : "typeName",
    "location" : {
      "address" : {
        "country" : "country",
        "streetNumber" : "streetNumber",
        "city" : "city",
        "street" : "street",
        "flatNumber" : "flatNumber",
        "additional" : "additional",
        "postalCode" : "postalCode"
      },
      "position" : {
        "lon" : 0.8008282,
        "lat" : 6.0274563
      }
    },
    "attributes" : "attributes"
  }, {
    "name" : "name",
    "typeName" : "typeName",
    "location" : {
      "address" : {
        "country" : "country",
        "streetNumber" : "streetNumber",
        "city" : "city",
        "street" : "street",
        "flatNumber" : "flatNumber",
        "additional" : "additional",
        "postalCode" : "postalCode"
      },
      "position" : {
        "lon" : 0.8008282,
        "lat" : 6.0274563
      }
    },
    "attributes" : "attributes"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        PointOfInterestCreateBatchRequest pointOfInterestCreateBatchRequest = ; // PointOfInterestCreateBatchRequest | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poiCreateBatch(tenantId, allOrNothing, pointOfInterestCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiCreateBatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        PointOfInterestCreateBatchRequest pointOfInterestCreateBatchRequest = ; // PointOfInterestCreateBatchRequest | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poiCreateBatch(tenantId, allOrNothing, pointOfInterestCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiCreateBatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
PointOfInterestCreateBatchRequest *pointOfInterestCreateBatchRequest = ; //  (optional)

[apiInstance poiCreateBatchWith:tenantId
    allOrNothing:allOrNothing
    pointOfInterestCreateBatchRequest:pointOfInterestCreateBatchRequest
              completionHandler: ^(array[PointOfInterestOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var opts = {
  'pointOfInterestCreateBatchRequest':  // {PointOfInterestCreateBatchRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var pointOfInterestCreateBatchRequest = new PointOfInterestCreateBatchRequest(); // PointOfInterestCreateBatchRequest |  (optional) 

            try {
                array[PointOfInterestOrError] result = apiInstance.poiCreateBatch(tenantId, allOrNothing, pointOfInterestCreateBatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiCreateBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$pointOfInterestCreateBatchRequest = ; // PointOfInterestCreateBatchRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $pointOfInterestCreateBatchRequest = WWW::OPenAPIClient::Object::PointOfInterestCreateBatchRequest->new(); # PointOfInterestCreateBatchRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
pointOfInterestCreateBatchRequest =  # PointOfInterestCreateBatchRequest |  (optional)

try:
    api_response = api_instance.poi_create_batch(tenantId, allOrNothing, pointOfInterestCreateBatchRequest=pointOfInterestCreateBatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poiCreateBatch: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let pointOfInterestCreateBatchRequest = ; // PointOfInterestCreateBatchRequest

    let mut context = PoisApi::Context::default();
    let result = client.poiCreateBatch(tenantId, allOrNothing, pointOfInterestCreateBatchRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
pointOfInterestCreateBatchRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required

Responses


poiDelete

Delete a point of interest


/poi

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poi?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.poiDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.poiDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance poiDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.poiDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.poi_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling PoisApi->poiDelete: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = PoisApi::Context::default();
    let result = client.poiDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


poiUpdate

Update a point of interest


/poi

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/poi?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "poi" : {
    "name" : "name",
    "typeName" : "typeName",
    "location" : {
      "address" : {
        "country" : "country",
        "streetNumber" : "streetNumber",
        "city" : "city",
        "street" : "street",
        "flatNumber" : "flatNumber",
        "additional" : "additional",
        "postalCode" : "postalCode"
      },
      "position" : {
        "lon" : 0.8008282,
        "lat" : 6.0274563
      }
    },
    "attributes" : "attributes",
    "id" : "id",
    "version" : "version"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestUpdateRequest pointOfInterestUpdateRequest = ; // PointOfInterestUpdateRequest | 

        try {
            PointOfInterest result = apiInstance.poiUpdate(tenantId, pointOfInterestUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        PointOfInterestUpdateRequest pointOfInterestUpdateRequest = ; // PointOfInterestUpdateRequest | 

        try {
            PointOfInterest result = apiInstance.poiUpdate(tenantId, pointOfInterestUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poiUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
PointOfInterestUpdateRequest *pointOfInterestUpdateRequest = ; //  (optional)

[apiInstance poiUpdateWith:tenantId
    pointOfInterestUpdateRequest:pointOfInterestUpdateRequest
              completionHandler: ^(PointOfInterest output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'pointOfInterestUpdateRequest':  // {PointOfInterestUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var pointOfInterestUpdateRequest = new PointOfInterestUpdateRequest(); // PointOfInterestUpdateRequest |  (optional) 

            try {
                PointOfInterest result = apiInstance.poiUpdate(tenantId, pointOfInterestUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poiUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$pointOfInterestUpdateRequest = ; // PointOfInterestUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $pointOfInterestUpdateRequest = WWW::OPenAPIClient::Object::PointOfInterestUpdateRequest->new(); # PointOfInterestUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
pointOfInterestUpdateRequest =  # PointOfInterestUpdateRequest |  (optional)

try:
    api_response = api_instance.poi_update(tenantId, pointOfInterestUpdateRequest=pointOfInterestUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poiUpdate: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let pointOfInterestUpdateRequest = ; // PointOfInterestUpdateRequest

    let mut context = PoisApi::Context::default();
    let result = client.poiUpdate(tenantId, pointOfInterestUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
pointOfInterestUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


pois

List points of interest with filtering/sorting options


/poi/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poi/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&attributes=attributes_example&typeName=&name=name_example&address=address_example&isDepot=true&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        array[String] typeName = ; // array[String] | Filter: list of type names to match.
        String name = name_example; // String | Filter: match by POI name.
        String address = address_example; // String | Filter: match by POI address.
        Boolean isDepot = true; // Boolean | Filter: match by type isDepot flag.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            PointOfInterestPage result = apiInstance.pois(tenantId, offset, limit, orderBy, attributes, typeName, name, address, isDepot, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#pois");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String attributes = attributes_example; // String | 
        array[String] typeName = ; // array[String] | Filter: list of type names to match.
        String name = name_example; // String | Filter: match by POI name.
        String address = address_example; // String | Filter: match by POI address.
        Boolean isDepot = true; // Boolean | Filter: match by type isDepot flag.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            PointOfInterestPage result = apiInstance.pois(tenantId, offset, limit, orderBy, attributes, typeName, name, address, isDepot, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#pois");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
array[String] *typeName = ; // Filter: list of type names to match. (optional) (default to null)
String *name = name_example; // Filter: match by POI name. (optional) (default to null)
String *address = address_example; // Filter: match by POI address. (optional) (default to null)
Boolean *isDepot = true; // Filter: match by type isDepot flag. (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance poisWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    attributes:attributes
    typeName:typeName
    name:name
    address:address
    isDepot:isDepot
    searchText:searchText
              completionHandler: ^(PointOfInterestPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'attributes': attributes_example, // {String} 
  'typeName': , // {array[String]} Filter: list of type names to match.
  'name': name_example, // {String} Filter: match by POI name.
  'address': address_example, // {String} Filter: match by POI address.
  'isDepot': true, // {Boolean} Filter: match by type isDepot flag.
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var typeName = new array[String](); // array[String] | Filter: list of type names to match. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by POI name. (optional)  (default to null)
            var address = address_example;  // String | Filter: match by POI address. (optional)  (default to null)
            var isDepot = true;  // Boolean | Filter: match by type isDepot flag. (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                PointOfInterestPage result = apiInstance.pois(tenantId, offset, limit, orderBy, attributes, typeName, name, address, isDepot, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.pois: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$attributes = attributes_example; // String | 
$typeName = ; // array[String] | Filter: list of type names to match.
$name = name_example; // String | Filter: match by POI name.
$address = address_example; // String | Filter: match by POI address.
$isDepot = true; // Boolean | Filter: match by type isDepot flag.
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->pois($tenantId, $offset, $limit, $orderBy, $attributes, $typeName, $name, $address, $isDepot, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PoisApi->pois: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PoisApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $attributes = attributes_example; # String | 
my $typeName = []; # array[String] | Filter: list of type names to match.
my $name = name_example; # String | Filter: match by POI name.
my $address = address_example; # String | Filter: match by POI address.
my $isDepot = true; # Boolean | Filter: match by type isDepot flag.
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->pois(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, attributes => $attributes, typeName => $typeName, name => $name, address => $address, isDepot => $isDepot, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PoisApi->pois: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
typeName =  # array[String] | Filter: list of type names to match. (optional) (default to null)
name = name_example # String | Filter: match by POI name. (optional) (default to null)
address = address_example # String | Filter: match by POI address. (optional) (default to null)
isDepot = true # Boolean | Filter: match by type isDepot flag. (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.pois(tenantId, offset=offset, limit=limit, orderBy=orderBy, attributes=attributes, typeName=typeName, name=name, address=address, isDepot=isDepot, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->pois: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let attributes = attributes_example; // String
    let typeName = ; // array[String]
    let name = name_example; // String
    let address = address_example; // String
    let isDepot = true; // Boolean
    let searchText = searchText_example; // String

    let mut context = PoisApi::Context::default();
    let result = client.pois(tenantId, offset, limit, orderBy, attributes, typeName, name, address, isDepot, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
attributes
String
typeName
array[String]
Filter: list of type names to match.
name
String
Filter: match by POI name.
address
String
Filter: match by POI address.
isDepot
Boolean
Filter: match by type isDepot flag.
searchText
String
Filter: match by name or address.

Responses


poisById

Get a batch of points of interest


/poi/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/poi/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PoisApi;

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

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

        // Create an instance of the API class
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poisById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poisById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PoisApi;

public class PoisApiExample {
    public static void main(String[] args) {
        PoisApi apiInstance = new PoisApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[PointOfInterestOrError] result = apiInstance.poisById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PoisApi#poisById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
PoisApi *apiInstance = [[PoisApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance poisByIdWith:tenantId
    allOrNothing:allOrNothing
    ids:ids
              completionHandler: ^(array[PointOfInterestOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.PoisApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new PoisApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[PointOfInterestOrError] result = apiInstance.poisById(tenantId, allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PoisApi.poisById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PoisApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PoisApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.PoisApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.pois_by_id(tenantId, allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoisApi->poisById: %s\n" % e)
extern crate PoisApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = PoisApi::Context::default();
    let result = client.poisById(tenantId, allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses


Profiles

profileBatchUpdate

Update a batch of routing optimisation profiles


/profile/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/profile/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "allOrNothing" : true,
  "profileArgs" : {
    "automaticWeekdays" : "123--6-",
    "durationMinutes" : 862,
    "automaticAheadMinutes" : 1737,
    "automaticConfirmation" : true,
    "startTime" : "08:00:00",
    "depotIds" : [ "depotIds", "depotIds" ]
  },
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileBatchUpdateRequest routingOptimisationProfileBatchUpdateRequest = ; // RoutingOptimisationProfileBatchUpdateRequest | 

        try {
            array[RoutingOptimisationProfileOrError] result = apiInstance.profileBatchUpdate(tenantId, routingOptimisationProfileBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileBatchUpdateRequest routingOptimisationProfileBatchUpdateRequest = ; // RoutingOptimisationProfileBatchUpdateRequest | 

        try {
            array[RoutingOptimisationProfileOrError] result = apiInstance.profileBatchUpdate(tenantId, routingOptimisationProfileBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingOptimisationProfileBatchUpdateRequest *routingOptimisationProfileBatchUpdateRequest = ; //  (optional)

[apiInstance profileBatchUpdateWith:tenantId
    routingOptimisationProfileBatchUpdateRequest:routingOptimisationProfileBatchUpdateRequest
              completionHandler: ^(array[RoutingOptimisationProfileOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingOptimisationProfileBatchUpdateRequest':  // {RoutingOptimisationProfileBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingOptimisationProfileBatchUpdateRequest = new RoutingOptimisationProfileBatchUpdateRequest(); // RoutingOptimisationProfileBatchUpdateRequest |  (optional) 

            try {
                array[RoutingOptimisationProfileOrError] result = apiInstance.profileBatchUpdate(tenantId, routingOptimisationProfileBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profileBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingOptimisationProfileBatchUpdateRequest = ; // RoutingOptimisationProfileBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingOptimisationProfileBatchUpdateRequest = WWW::OPenAPIClient::Object::RoutingOptimisationProfileBatchUpdateRequest->new(); # RoutingOptimisationProfileBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingOptimisationProfileBatchUpdateRequest =  # RoutingOptimisationProfileBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.profile_batch_update(tenantId, routingOptimisationProfileBatchUpdateRequest=routingOptimisationProfileBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profileBatchUpdate: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingOptimisationProfileBatchUpdateRequest = ; // RoutingOptimisationProfileBatchUpdateRequest

    let mut context = ProfilesApi::Context::default();
    let result = client.profileBatchUpdate(tenantId, routingOptimisationProfileBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingOptimisationProfileBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


profileById

Get routing optimisation profile object


/profile

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/profile?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingOptimisationProfile result = apiInstance.profileById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingOptimisationProfile result = apiInstance.profileById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance profileByIdWith:tenantId
    id:id
              completionHandler: ^(RoutingOptimisationProfile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.profile_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profileById: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProfilesApi::Context::default();
    let result = client.profileById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


profileCreate

Create a routing optimisation profile


/profile

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/profile?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "profile" : {
    "automaticWeekdays" : "123--6-",
    "durationMinutes" : 834,
    "automaticAheadMinutes" : 1737,
    "automaticConfirmation" : true,
    "name" : "name",
    "startTime" : "08:00:00",
    "depotIds" : [ "depotIds", "depotIds" ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileCreateRequest routingOptimisationProfileCreateRequest = ; // RoutingOptimisationProfileCreateRequest | 

        try {
            RoutingOptimisationProfile result = apiInstance.profileCreate(tenantId, routingOptimisationProfileCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileCreateRequest routingOptimisationProfileCreateRequest = ; // RoutingOptimisationProfileCreateRequest | 

        try {
            RoutingOptimisationProfile result = apiInstance.profileCreate(tenantId, routingOptimisationProfileCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingOptimisationProfileCreateRequest *routingOptimisationProfileCreateRequest = ; //  (optional)

[apiInstance profileCreateWith:tenantId
    routingOptimisationProfileCreateRequest:routingOptimisationProfileCreateRequest
              completionHandler: ^(RoutingOptimisationProfile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingOptimisationProfileCreateRequest':  // {RoutingOptimisationProfileCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingOptimisationProfileCreateRequest = new RoutingOptimisationProfileCreateRequest(); // RoutingOptimisationProfileCreateRequest |  (optional) 

            try {
                RoutingOptimisationProfile result = apiInstance.profileCreate(tenantId, routingOptimisationProfileCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profileCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingOptimisationProfileCreateRequest = ; // RoutingOptimisationProfileCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingOptimisationProfileCreateRequest = WWW::OPenAPIClient::Object::RoutingOptimisationProfileCreateRequest->new(); # RoutingOptimisationProfileCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingOptimisationProfileCreateRequest =  # RoutingOptimisationProfileCreateRequest |  (optional)

try:
    api_response = api_instance.profile_create(tenantId, routingOptimisationProfileCreateRequest=routingOptimisationProfileCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profileCreate: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingOptimisationProfileCreateRequest = ; // RoutingOptimisationProfileCreateRequest

    let mut context = ProfilesApi::Context::default();
    let result = client.profileCreate(tenantId, routingOptimisationProfileCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingOptimisationProfileCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


profileDelete

Delete a routing optimisation profile


/profile

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/profile?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.profileDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.profileDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance profileDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.profileDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profileDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.profile_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling ProfilesApi->profileDelete: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProfilesApi::Context::default();
    let result = client.profileDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


profileUpdate

Update a routing optimisation profile


/profile

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/profile?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "profile" : {
    "automaticWeekdays" : "123--6-",
    "durationMinutes" : 862,
    "automaticAheadMinutes" : 1737,
    "automaticConfirmation" : true,
    "name" : "name",
    "startTime" : "08:00:00",
    "id" : "id",
    "version" : "version",
    "depotIds" : [ "depotIds", "depotIds" ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileUpdateRequest routingOptimisationProfileUpdateRequest = ; // RoutingOptimisationProfileUpdateRequest | 

        try {
            RoutingOptimisationProfile result = apiInstance.profileUpdate(tenantId, routingOptimisationProfileUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingOptimisationProfileUpdateRequest routingOptimisationProfileUpdateRequest = ; // RoutingOptimisationProfileUpdateRequest | 

        try {
            RoutingOptimisationProfile result = apiInstance.profileUpdate(tenantId, routingOptimisationProfileUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profileUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingOptimisationProfileUpdateRequest *routingOptimisationProfileUpdateRequest = ; //  (optional)

[apiInstance profileUpdateWith:tenantId
    routingOptimisationProfileUpdateRequest:routingOptimisationProfileUpdateRequest
              completionHandler: ^(RoutingOptimisationProfile output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingOptimisationProfileUpdateRequest':  // {RoutingOptimisationProfileUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingOptimisationProfileUpdateRequest = new RoutingOptimisationProfileUpdateRequest(); // RoutingOptimisationProfileUpdateRequest |  (optional) 

            try {
                RoutingOptimisationProfile result = apiInstance.profileUpdate(tenantId, routingOptimisationProfileUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profileUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingOptimisationProfileUpdateRequest = ; // RoutingOptimisationProfileUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingOptimisationProfileUpdateRequest = WWW::OPenAPIClient::Object::RoutingOptimisationProfileUpdateRequest->new(); # RoutingOptimisationProfileUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingOptimisationProfileUpdateRequest =  # RoutingOptimisationProfileUpdateRequest |  (optional)

try:
    api_response = api_instance.profile_update(tenantId, routingOptimisationProfileUpdateRequest=routingOptimisationProfileUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profileUpdate: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingOptimisationProfileUpdateRequest = ; // RoutingOptimisationProfileUpdateRequest

    let mut context = ProfilesApi::Context::default();
    let result = client.profileUpdate(tenantId, routingOptimisationProfileUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingOptimisationProfileUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


profiles

List routing optimisation profiles with filtering/sorting options


/profile/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/profile/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&depots=&assignmentTypes=&name=name_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[String] depots = ; // array[String] | Filter: list of depot names to match.
        array[RoutingOptimisationProfileType] assignmentTypes = ; // array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes.
        String name = name_example; // String | Filter: match by name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingOptimisationProfilePage result = apiInstance.profiles(tenantId, offset, limit, orderBy, depots, assignmentTypes, name, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profiles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[String] depots = ; // array[String] | Filter: list of depot names to match.
        array[RoutingOptimisationProfileType] assignmentTypes = ; // array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes.
        String name = name_example; // String | Filter: match by name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingOptimisationProfilePage result = apiInstance.profiles(tenantId, offset, limit, orderBy, depots, assignmentTypes, name, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profiles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[String] *depots = ; // Filter: list of depot names to match. (optional) (default to null)
array[RoutingOptimisationProfileType] *assignmentTypes = ; // Filter: list of assignmentTypes. (optional) (default to null)
String *name = name_example; // Filter: match by name. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance profilesWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    depots:depots
    assignmentTypes:assignmentTypes
    name:name
    attributes:attributes
    searchText:searchText
              completionHandler: ^(RoutingOptimisationProfilePage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'depots': , // {array[String]} Filter: list of depot names to match.
  'assignmentTypes': , // {array[RoutingOptimisationProfileType]} Filter: list of assignmentTypes.
  'name': name_example, // {String} Filter: match by name.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var depots = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)
            var assignmentTypes = new array[RoutingOptimisationProfileType](); // array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by name. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                RoutingOptimisationProfilePage result = apiInstance.profiles(tenantId, offset, limit, orderBy, depots, assignmentTypes, name, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$depots = ; // array[String] | Filter: list of depot names to match.
$assignmentTypes = ; // array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes.
$name = name_example; // String | Filter: match by name.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->profiles($tenantId, $offset, $limit, $orderBy, $depots, $assignmentTypes, $name, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProfilesApi->profiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProfilesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $depots = []; # array[String] | Filter: list of depot names to match.
my $assignmentTypes = []; # array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes.
my $name = name_example; # String | Filter: match by name.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->profiles(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, depots => $depots, assignmentTypes => $assignmentTypes, name => $name, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfilesApi->profiles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
depots =  # array[String] | Filter: list of depot names to match. (optional) (default to null)
assignmentTypes =  # array[RoutingOptimisationProfileType] | Filter: list of assignmentTypes. (optional) (default to null)
name = name_example # String | Filter: match by name. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.profiles(tenantId, offset=offset, limit=limit, orderBy=orderBy, depots=depots, assignmentTypes=assignmentTypes, name=name, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profiles: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let depots = ; // array[String]
    let assignmentTypes = ; // array[RoutingOptimisationProfileType]
    let name = name_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.profiles(tenantId, offset, limit, orderBy, depots, assignmentTypes, name, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
depots
array[String]
Filter: list of depot names to match.
assignmentTypes
array[RoutingOptimisationProfileType]
Filter: list of assignmentTypes.
name
String
Filter: match by name.
attributes
String
searchText
String
Filter: match by name or address.

Responses


profilesById

Get a batch of routing optimisation profile objects


/profile/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/profile/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProfilesApi;

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

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

        // Create an instance of the API class
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[RoutingOptimisationProfileOrError] result = apiInstance.profilesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ProfilesApi;

public class ProfilesApiExample {
    public static void main(String[] args) {
        ProfilesApi apiInstance = new ProfilesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[RoutingOptimisationProfileOrError] result = apiInstance.profilesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfilesApi#profilesById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ProfilesApi *apiInstance = [[ProfilesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance profilesByIdWith:tenantId
    allOrNothing:allOrNothing
    ids:ids
              completionHandler: ^(array[RoutingOptimisationProfileOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.ProfilesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ProfilesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[RoutingOptimisationProfileOrError] result = apiInstance.profilesById(tenantId, allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProfilesApi.profilesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProfilesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProfilesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.ProfilesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.profiles_by_id(tenantId, allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfilesApi->profilesById: %s\n" % e)
extern crate ProfilesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = ProfilesApi::Context::default();
    let result = client.profilesById(tenantId, allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses


Routing

assignedBookings

List of assigned bookings matching given assignment.


/assignment/assignedBookings

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/assignedBookings?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&pickUpTimeWindow=&dropOffTimeWindow=&externalId=externalId_example&pickUpLocation=pickUpLocation_example&dropOffLocation=dropOffLocation_example&dateFrom=2013-10-20&dateTo=2013-10-20&attributes=attributes_example&searchText=searchText_example&driverName=driverName_example&plate=plate_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.

        try {
            AssignedBookingsPage result = apiInstance.assignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, driverName, plate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignedBookings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.

        try {
            AssignedBookingsPage result = apiInstance.assignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, driverName, plate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignedBookings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
RangeFilter *pickUpTimeWindow = ; // Filter: match pickup time window. (optional) (default to null)
RangeFilter *dropOffTimeWindow = ; // Filter: match drop off time window. (optional) (default to null)
String *externalId = externalId_example; // Filter: match by externalId (optional) (default to null)
String *pickUpLocation = pickUpLocation_example; // Filter: match by pickup location. (optional) (default to null)
String *dropOffLocation = dropOffLocation_example; // Filter: match by drop off location. (optional) (default to null)
date *dateFrom = 2013-10-20; // Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
date *dateTo = 2013-10-20; // Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)
String *driverName = driverName_example; // Filter: match by driver name. (optional) (default to null)
String *plate = plate_example; // Filter: match by vehicle registration plate. (optional) (default to null)

[apiInstance assignedBookingsWith:tenantId
    assignmentId:assignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    pickUpTimeWindow:pickUpTimeWindow
    dropOffTimeWindow:dropOffTimeWindow
    externalId:externalId
    pickUpLocation:pickUpLocation
    dropOffLocation:dropOffLocation
    dateFrom:dateFrom
    dateTo:dateTo
    attributes:attributes
    searchText:searchText
    driverName:driverName
    plate:plate
              completionHandler: ^(AssignedBookingsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'pickUpTimeWindow': , // {RangeFilter} Filter: match pickup time window.
  'dropOffTimeWindow': , // {RangeFilter} Filter: match drop off time window.
  'externalId': externalId_example, // {String} Filter: match by externalId
  'pickUpLocation': pickUpLocation_example, // {String} Filter: match by pickup location.
  'dropOffLocation': dropOffLocation_example, // {String} Filter: match by drop off location.
  'dateFrom': 2013-10-20, // {date} Filter: match bookings with pickup time window starting from given date (inclusive).
  'dateTo': 2013-10-20, // {date} Filter: match bookings with drop off time window ending at given date (inclusive).
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example, // {String} Filter: match by name or address.
  'driverName': driverName_example, // {String} Filter: match by driver name.
  'plate': plate_example // {String} Filter: match by vehicle registration plate.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var pickUpTimeWindow = new RangeFilter(); // RangeFilter | Filter: match pickup time window. (optional)  (default to null)
            var dropOffTimeWindow = new RangeFilter(); // RangeFilter | Filter: match drop off time window. (optional)  (default to null)
            var externalId = externalId_example;  // String | Filter: match by externalId (optional)  (default to null)
            var pickUpLocation = pickUpLocation_example;  // String | Filter: match by pickup location. (optional)  (default to null)
            var dropOffLocation = dropOffLocation_example;  // String | Filter: match by drop off location. (optional)  (default to null)
            var dateFrom = 2013-10-20;  // date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional)  (default to null)
            var dateTo = 2013-10-20;  // date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)
            var driverName = driverName_example;  // String | Filter: match by driver name. (optional)  (default to null)
            var plate = plate_example;  // String | Filter: match by vehicle registration plate. (optional)  (default to null)

            try {
                AssignedBookingsPage result = apiInstance.assignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, driverName, plate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignedBookings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
$dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
$externalId = externalId_example; // String | Filter: match by externalId
$pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
$dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
$dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
$dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.
$driverName = driverName_example; // String | Filter: match by driver name.
$plate = plate_example; // String | Filter: match by vehicle registration plate.

try {
    $result = $api_instance->assignedBookings($tenantId, $assignmentId, $offset, $limit, $orderBy, $pickUpTimeWindow, $dropOffTimeWindow, $externalId, $pickUpLocation, $dropOffLocation, $dateFrom, $dateTo, $attributes, $searchText, $driverName, $plate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->assignedBookings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $pickUpTimeWindow = ; # RangeFilter | Filter: match pickup time window.
my $dropOffTimeWindow = ; # RangeFilter | Filter: match drop off time window.
my $externalId = externalId_example; # String | Filter: match by externalId
my $pickUpLocation = pickUpLocation_example; # String | Filter: match by pickup location.
my $dropOffLocation = dropOffLocation_example; # String | Filter: match by drop off location.
my $dateFrom = 2013-10-20; # date | Filter: match bookings with pickup time window starting from given date (inclusive).
my $dateTo = 2013-10-20; # date | Filter: match bookings with drop off time window ending at given date (inclusive).
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.
my $driverName = driverName_example; # String | Filter: match by driver name.
my $plate = plate_example; # String | Filter: match by vehicle registration plate.

eval {
    my $result = $api_instance->assignedBookings(tenantId => $tenantId, assignmentId => $assignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, pickUpTimeWindow => $pickUpTimeWindow, dropOffTimeWindow => $dropOffTimeWindow, externalId => $externalId, pickUpLocation => $pickUpLocation, dropOffLocation => $dropOffLocation, dateFrom => $dateFrom, dateTo => $dateTo, attributes => $attributes, searchText => $searchText, driverName => $driverName, plate => $plate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->assignedBookings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
pickUpTimeWindow =  # RangeFilter | Filter: match pickup time window. (optional) (default to null)
dropOffTimeWindow =  # RangeFilter | Filter: match drop off time window. (optional) (default to null)
externalId = externalId_example # String | Filter: match by externalId (optional) (default to null)
pickUpLocation = pickUpLocation_example # String | Filter: match by pickup location. (optional) (default to null)
dropOffLocation = dropOffLocation_example # String | Filter: match by drop off location. (optional) (default to null)
dateFrom = 2013-10-20 # date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
dateTo = 2013-10-20 # date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)
driverName = driverName_example # String | Filter: match by driver name. (optional) (default to null)
plate = plate_example # String | Filter: match by vehicle registration plate. (optional) (default to null)

try:
    api_response = api_instance.assigned_bookings(tenantId, assignmentId, offset=offset, limit=limit, orderBy=orderBy, pickUpTimeWindow=pickUpTimeWindow, dropOffTimeWindow=dropOffTimeWindow, externalId=externalId, pickUpLocation=pickUpLocation, dropOffLocation=dropOffLocation, dateFrom=dateFrom, dateTo=dateTo, attributes=attributes, searchText=searchText, driverName=driverName, plate=plate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignedBookings: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let pickUpTimeWindow = ; // RangeFilter
    let dropOffTimeWindow = ; // RangeFilter
    let externalId = externalId_example; // String
    let pickUpLocation = pickUpLocation_example; // String
    let dropOffLocation = dropOffLocation_example; // String
    let dateFrom = 2013-10-20; // date
    let dateTo = 2013-10-20; // date
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String
    let driverName = driverName_example; // String
    let plate = plate_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.assignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, driverName, plate, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
pickUpTimeWindow
RangeFilter
Filter: match pickup time window.
dropOffTimeWindow
RangeFilter
Filter: match drop off time window.
externalId
String
Filter: match by externalId
pickUpLocation
String
Filter: match by pickup location.
dropOffLocation
String
Filter: match by drop off location.
dateFrom
date (date)
Filter: match bookings with pickup time window starting from given date (inclusive).
dateTo
date (date)
Filter: match bookings with drop off time window ending at given date (inclusive).
attributes
String
searchText
String
Filter: match by name or address.
driverName
String
Filter: match by driver name.
plate
String
Filter: match by vehicle registration plate.

Responses


assignedVehicles

List of assigned vehicles matching given assignment.


/assignment/assignedVehicles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/assignedVehicles?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&active=&depotName=&name=name_example&plate=plate_example&telematicsDeviceId=telematicsDeviceId_example&startingPointName=startingPointName_example&driverName=driverName_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.assignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignedVehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.assignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignedVehicles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)
String *name = name_example; // Filter: match by vehicle name. (optional) (default to null)
String *plate = plate_example; // Filter: match by vehicle registration plate. (optional) (default to null)
String *telematicsDeviceId = telematicsDeviceId_example; // Filter: match by telematics device ID. (optional) (default to null)
String *startingPointName = startingPointName_example; // Filter: match by starting point name. (optional) (default to null)
String *driverName = driverName_example; // Filter: match by driver name. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance assignedVehiclesWith:tenantId
    assignmentId:assignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    active:active
    depotName:depotName
    name:name
    plate:plate
    telematicsDeviceId:telematicsDeviceId
    startingPointName:startingPointName
    driverName:driverName
    attributes:attributes
    searchText:searchText
              completionHandler: ^(VehiclesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'depotName': , // {array[String]} Filter: list of depot names to match.
  'name': name_example, // {String} Filter: match by vehicle name.
  'plate': plate_example, // {String} Filter: match by vehicle registration plate.
  'telematicsDeviceId': telematicsDeviceId_example, // {String} Filter: match by telematics device ID.
  'startingPointName': startingPointName_example, // {String} Filter: match by starting point name.
  'driverName': driverName_example, // {String} Filter: match by driver name.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by vehicle name. (optional)  (default to null)
            var plate = plate_example;  // String | Filter: match by vehicle registration plate. (optional)  (default to null)
            var telematicsDeviceId = telematicsDeviceId_example;  // String | Filter: match by telematics device ID. (optional)  (default to null)
            var startingPointName = startingPointName_example;  // String | Filter: match by starting point name. (optional)  (default to null)
            var driverName = driverName_example;  // String | Filter: match by driver name. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                VehiclesPage result = apiInstance.assignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignedVehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$depotName = ; // array[String] | Filter: list of depot names to match.
$name = name_example; // String | Filter: match by vehicle name.
$plate = plate_example; // String | Filter: match by vehicle registration plate.
$telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
$startingPointName = startingPointName_example; // String | Filter: match by starting point name.
$driverName = driverName_example; // String | Filter: match by driver name.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->assignedVehicles($tenantId, $assignmentId, $offset, $limit, $orderBy, $active, $depotName, $name, $plate, $telematicsDeviceId, $startingPointName, $driverName, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->assignedVehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $depotName = []; # array[String] | Filter: list of depot names to match.
my $name = name_example; # String | Filter: match by vehicle name.
my $plate = plate_example; # String | Filter: match by vehicle registration plate.
my $telematicsDeviceId = telematicsDeviceId_example; # String | Filter: match by telematics device ID.
my $startingPointName = startingPointName_example; # String | Filter: match by starting point name.
my $driverName = driverName_example; # String | Filter: match by driver name.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->assignedVehicles(tenantId => $tenantId, assignmentId => $assignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, active => $active, depotName => $depotName, name => $name, plate => $plate, telematicsDeviceId => $telematicsDeviceId, startingPointName => $startingPointName, driverName => $driverName, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->assignedVehicles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)
name = name_example # String | Filter: match by vehicle name. (optional) (default to null)
plate = plate_example # String | Filter: match by vehicle registration plate. (optional) (default to null)
telematicsDeviceId = telematicsDeviceId_example # String | Filter: match by telematics device ID. (optional) (default to null)
startingPointName = startingPointName_example # String | Filter: match by starting point name. (optional) (default to null)
driverName = driverName_example # String | Filter: match by driver name. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.assigned_vehicles(tenantId, assignmentId, offset=offset, limit=limit, orderBy=orderBy, active=active, depotName=depotName, name=name, plate=plate, telematicsDeviceId=telematicsDeviceId, startingPointName=startingPointName, driverName=driverName, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignedVehicles: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let active = ; // array[VehicleActivityStatus]
    let depotName = ; // array[String]
    let name = name_example; // String
    let plate = plate_example; // String
    let telematicsDeviceId = telematicsDeviceId_example; // String
    let startingPointName = startingPointName_example; // String
    let driverName = driverName_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.assignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
depotName
array[String]
Filter: list of depot names to match.
name
String
Filter: match by vehicle name.
plate
String
Filter: match by vehicle registration plate.
telematicsDeviceId
String
Filter: match by telematics device ID.
startingPointName
String
Filter: match by starting point name.
driverName
String
Filter: match by driver name.
attributes
String
searchText
String
Filter: match by name or address.

Responses


assignmentById

Get single assignment.


/assignment

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingAssignment result = apiInstance.assignmentById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingAssignment result = apiInstance.assignmentById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance assignmentByIdWith:tenantId
    id:id
              completionHandler: ^(RoutingAssignment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.assignment_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentById: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


assignmentDelete

Delete assignment that is not in execution/


/assignment

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.assignmentDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.assignmentDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance assignmentDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.assignmentDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignmentDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.assignment_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentDelete: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


assignmentObjects

Get bookings and POIs used in given assignment - data complementary to routes that are using ids of those objects.


/assignment/objects

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/objects?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingAssignmentsObjects result = apiInstance.assignmentObjects(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentObjects");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingAssignmentsObjects result = apiInstance.assignmentObjects(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentObjects");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)

[apiInstance assignmentObjectsWith:tenantId
    assignmentId:assignmentId
              completionHandler: ^(RoutingAssignmentsObjects output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)

            try {
                RoutingAssignmentsObjects result = apiInstance.assignmentObjects(tenantId, assignmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignmentObjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)

try:
    api_response = api_instance.assignment_objects(tenantId, assignmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentObjects: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentObjects(tenantId, assignmentId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required

Responses


assignmentReport

Get an assignment report specified in tenant config.


/assignment/report

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/report?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingReport result = apiInstance.assignmentReport(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingReport result = apiInstance.assignmentReport(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentReport");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)

[apiInstance assignmentReportWith:tenantId
    assignmentId:assignmentId
              completionHandler: ^(RoutingReport output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)

            try {
                RoutingReport result = apiInstance.assignmentReport(tenantId, assignmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignmentReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)

try:
    api_response = api_instance.assignment_report(tenantId, assignmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentReport: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentReport(tenantId, assignmentId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required

Responses


assignmentStatus

Get assignment status and errors if any.


/assignment/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/status?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingAssignmentStatusWithErrors result = apiInstance.assignmentStatus(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

        try {
            RoutingAssignmentStatusWithErrors result = apiInstance.assignmentStatus(tenantId, assignmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)

[apiInstance assignmentStatusWith:tenantId
    assignmentId:assignmentId
              completionHandler: ^(RoutingAssignmentStatusWithErrors output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)

            try {
                RoutingAssignmentStatusWithErrors result = apiInstance.assignmentStatus(tenantId, assignmentId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignmentStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)

try:
    api_response = api_instance.assignment_status(tenantId, assignmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentStatus: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentStatus(tenantId, assignmentId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required

Responses


assignmentStatusUpdate

Change assignment status. Only specific transitions are allowed.


/assignment/status

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/assignment/status?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{ }'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        RoutingAssignmentStatusUpdateRequest routingAssignmentStatusUpdateRequest = ; // RoutingAssignmentStatusUpdateRequest | 

        try {
            RoutingAssignment result = apiInstance.assignmentStatusUpdate(tenantId, assignmentId, routingAssignmentStatusUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentStatusUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        RoutingAssignmentStatusUpdateRequest routingAssignmentStatusUpdateRequest = ; // RoutingAssignmentStatusUpdateRequest | 

        try {
            RoutingAssignment result = apiInstance.assignmentStatusUpdate(tenantId, assignmentId, routingAssignmentStatusUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignmentStatusUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
RoutingAssignmentStatusUpdateRequest *routingAssignmentStatusUpdateRequest = ; //  (optional)

[apiInstance assignmentStatusUpdateWith:tenantId
    assignmentId:assignmentId
    routingAssignmentStatusUpdateRequest:routingAssignmentStatusUpdateRequest
              completionHandler: ^(RoutingAssignment output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'routingAssignmentStatusUpdateRequest':  // {RoutingAssignmentStatusUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var routingAssignmentStatusUpdateRequest = new RoutingAssignmentStatusUpdateRequest(); // RoutingAssignmentStatusUpdateRequest |  (optional) 

            try {
                RoutingAssignment result = apiInstance.assignmentStatusUpdate(tenantId, assignmentId, routingAssignmentStatusUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignmentStatusUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$routingAssignmentStatusUpdateRequest = ; // RoutingAssignmentStatusUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $routingAssignmentStatusUpdateRequest = WWW::OPenAPIClient::Object::RoutingAssignmentStatusUpdateRequest->new(); # RoutingAssignmentStatusUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
routingAssignmentStatusUpdateRequest =  # RoutingAssignmentStatusUpdateRequest |  (optional)

try:
    api_response = api_instance.assignment_status_update(tenantId, assignmentId, routingAssignmentStatusUpdateRequest=routingAssignmentStatusUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignmentStatusUpdate: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingAssignmentStatusUpdateRequest = ; // RoutingAssignmentStatusUpdateRequest

    let mut context = RoutingApi::Context::default();
    let result = client.assignmentStatusUpdate(tenantId, assignmentId, routingAssignmentStatusUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingAssignmentStatusUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required

Responses


assignments

Get list of assignments.


/assignment/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&name=name_example&datetime=&dateFrom=2013-10-20&dateTo=2013-10-20&status=&type=&profile=profile_example&details=details_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String name = name_example; // String | Search text matching assignment name.
        RangeFilter datetime = ; // RangeFilter | Time of assignment creation.
        date dateFrom = 2013-10-20; // date | Start time of execution.
        date dateTo = 2013-10-20; // date | Finish time of execution.
        array[RoutingAssignmentStatus] status = ; // array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description.
        array[RoutingAssignmentType] type = ; // array[RoutingAssignmentType] | Type - see RoutingAssignmentType description.
        String profile = profile_example; // String | Search text matching assignment profile name.
        String details = details_example; // String | Search text matching assignment details.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingAssignmentsPage result = apiInstance.assignments(tenantId, offset, limit, orderBy, name, datetime, dateFrom, dateTo, status, type, profile, details, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String name = name_example; // String | Search text matching assignment name.
        RangeFilter datetime = ; // RangeFilter | Time of assignment creation.
        date dateFrom = 2013-10-20; // date | Start time of execution.
        date dateTo = 2013-10-20; // date | Finish time of execution.
        array[RoutingAssignmentStatus] status = ; // array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description.
        array[RoutingAssignmentType] type = ; // array[RoutingAssignmentType] | Type - see RoutingAssignmentType description.
        String profile = profile_example; // String | Search text matching assignment profile name.
        String details = details_example; // String | Search text matching assignment details.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingAssignmentsPage result = apiInstance.assignments(tenantId, offset, limit, orderBy, name, datetime, dateFrom, dateTo, status, type, profile, details, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#assignments");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *name = name_example; // Search text matching assignment name. (optional) (default to null)
RangeFilter *datetime = ; // Time of assignment creation. (optional) (default to null)
date *dateFrom = 2013-10-20; // Start time of execution. (optional) (default to null)
date *dateTo = 2013-10-20; // Finish time of execution. (optional) (default to null)
array[RoutingAssignmentStatus] *status = ; // Status - see RoutingAssignmentStatus description. (optional) (default to null)
array[RoutingAssignmentType] *type = ; // Type - see RoutingAssignmentType description. (optional) (default to null)
String *profile = profile_example; // Search text matching assignment profile name. (optional) (default to null)
String *details = details_example; // Search text matching assignment details. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance assignmentsWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    name:name
    datetime:datetime
    dateFrom:dateFrom
    dateTo:dateTo
    status:status
    type:type
    profile:profile
    details:details
    attributes:attributes
    searchText:searchText
              completionHandler: ^(RoutingAssignmentsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'name': name_example, // {String} Search text matching assignment name.
  'datetime': , // {RangeFilter} Time of assignment creation.
  'dateFrom': 2013-10-20, // {date} Start time of execution.
  'dateTo': 2013-10-20, // {date} Finish time of execution.
  'status': , // {array[RoutingAssignmentStatus]} Status - see RoutingAssignmentStatus description.
  'type': , // {array[RoutingAssignmentType]} Type - see RoutingAssignmentType description.
  'profile': profile_example, // {String} Search text matching assignment profile name.
  'details': details_example, // {String} Search text matching assignment details.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var name = name_example;  // String | Search text matching assignment name. (optional)  (default to null)
            var datetime = new RangeFilter(); // RangeFilter | Time of assignment creation. (optional)  (default to null)
            var dateFrom = 2013-10-20;  // date | Start time of execution. (optional)  (default to null)
            var dateTo = 2013-10-20;  // date | Finish time of execution. (optional)  (default to null)
            var status = new array[RoutingAssignmentStatus](); // array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description. (optional)  (default to null)
            var type = new array[RoutingAssignmentType](); // array[RoutingAssignmentType] | Type - see RoutingAssignmentType description. (optional)  (default to null)
            var profile = profile_example;  // String | Search text matching assignment profile name. (optional)  (default to null)
            var details = details_example;  // String | Search text matching assignment details. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                RoutingAssignmentsPage result = apiInstance.assignments(tenantId, offset, limit, orderBy, name, datetime, dateFrom, dateTo, status, type, profile, details, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.assignments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$name = name_example; // String | Search text matching assignment name.
$datetime = ; // RangeFilter | Time of assignment creation.
$dateFrom = 2013-10-20; // date | Start time of execution.
$dateTo = 2013-10-20; // date | Finish time of execution.
$status = ; // array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description.
$type = ; // array[RoutingAssignmentType] | Type - see RoutingAssignmentType description.
$profile = profile_example; // String | Search text matching assignment profile name.
$details = details_example; // String | Search text matching assignment details.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->assignments($tenantId, $offset, $limit, $orderBy, $name, $datetime, $dateFrom, $dateTo, $status, $type, $profile, $details, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->assignments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $name = name_example; # String | Search text matching assignment name.
my $datetime = ; # RangeFilter | Time of assignment creation.
my $dateFrom = 2013-10-20; # date | Start time of execution.
my $dateTo = 2013-10-20; # date | Finish time of execution.
my $status = []; # array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description.
my $type = []; # array[RoutingAssignmentType] | Type - see RoutingAssignmentType description.
my $profile = profile_example; # String | Search text matching assignment profile name.
my $details = details_example; # String | Search text matching assignment details.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->assignments(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, name => $name, datetime => $datetime, dateFrom => $dateFrom, dateTo => $dateTo, status => $status, type => $type, profile => $profile, details => $details, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->assignments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
name = name_example # String | Search text matching assignment name. (optional) (default to null)
datetime =  # RangeFilter | Time of assignment creation. (optional) (default to null)
dateFrom = 2013-10-20 # date | Start time of execution. (optional) (default to null)
dateTo = 2013-10-20 # date | Finish time of execution. (optional) (default to null)
status =  # array[RoutingAssignmentStatus] | Status - see RoutingAssignmentStatus description. (optional) (default to null)
type =  # array[RoutingAssignmentType] | Type - see RoutingAssignmentType description. (optional) (default to null)
profile = profile_example # String | Search text matching assignment profile name. (optional) (default to null)
details = details_example # String | Search text matching assignment details. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.assignments(tenantId, offset=offset, limit=limit, orderBy=orderBy, name=name, datetime=datetime, dateFrom=dateFrom, dateTo=dateTo, status=status, type=type, profile=profile, details=details, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->assignments: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let name = name_example; // String
    let datetime = ; // RangeFilter
    let dateFrom = 2013-10-20; // date
    let dateTo = 2013-10-20; // date
    let status = ; // array[RoutingAssignmentStatus]
    let type = ; // array[RoutingAssignmentType]
    let profile = profile_example; // String
    let details = details_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.assignments(tenantId, offset, limit, orderBy, name, datetime, dateFrom, dateTo, status, type, profile, details, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
name
String
Search text matching assignment name.
datetime
RangeFilter
Time of assignment creation.
dateFrom
date (date)
Start time of execution.
dateTo
date (date)
Finish time of execution.
status
array[RoutingAssignmentStatus]
Status - see RoutingAssignmentStatus description.
type
array[RoutingAssignmentType]
Type - see RoutingAssignmentType description.
profile
String
Search text matching assignment profile name.
details
String
Search text matching assignment details.
attributes
String
searchText
String
Filter: match by name or address.

Responses


preassignmentBookings

Get paginated list of vehicles to be used in creation of new assignment with given optimisation profile and execution date.


/assignment/preassignmentBookings

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/preassignmentBookings?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&optimisationProfileId=38400000-8cf0-11bd-b23e-10b96e4ef00d&executionDate=2013-10-20&reassignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
        date executionDate = 2013-10-20; // date | Date of execution.
        UUID reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

        try {
            BookingsPage result = apiInstance.preassignmentBookings(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#preassignmentBookings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
        date executionDate = 2013-10-20; // date | Date of execution.
        UUID reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

        try {
            BookingsPage result = apiInstance.preassignmentBookings(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#preassignmentBookings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the optimisation profile. (optional) (default to null)
date *executionDate = 2013-10-20; // Date of execution. (optional) (default to null)
UUID *reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of assignment to be reassigned. (optional) (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)

[apiInstance preassignmentBookingsWith:tenantId
    optimisationProfileId:optimisationProfileId
    executionDate:executionDate
    reassignmentId:reassignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
              completionHandler: ^(BookingsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'optimisationProfileId': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} The id of the optimisation profile.
  'executionDate': 2013-10-20, // {date} Date of execution.
  'reassignmentId': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} The id of assignment to be reassigned.
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example // {String} Name of the field to sort the list by. Default is empty - no sorting.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the optimisation profile. (optional)  (default to null)
            var executionDate = 2013-10-20;  // date | Date of execution. (optional)  (default to null)
            var reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of assignment to be reassigned. (optional)  (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)

            try {
                BookingsPage result = apiInstance.preassignmentBookings(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.preassignmentBookings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
$executionDate = 2013-10-20; // date | Date of execution.
$reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.

try {
    $result = $api_instance->preassignmentBookings($tenantId, $optimisationProfileId, $executionDate, $reassignmentId, $offset, $limit, $orderBy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->preassignmentBookings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the optimisation profile.
my $executionDate = 2013-10-20; # date | Date of execution.
my $reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of assignment to be reassigned.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.

eval {
    my $result = $api_instance->preassignmentBookings(tenantId => $tenantId, optimisationProfileId => $optimisationProfileId, executionDate => $executionDate, reassignmentId => $reassignmentId, offset => $offset, limit => $limit, orderBy => $orderBy);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->preassignmentBookings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the optimisation profile. (optional) (default to null)
executionDate = 2013-10-20 # date | Date of execution. (optional) (default to null)
reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of assignment to be reassigned. (optional) (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)

try:
    api_response = api_instance.preassignment_bookings(tenantId, optimisationProfileId=optimisationProfileId, executionDate=executionDate, reassignmentId=reassignmentId, offset=offset, limit=limit, orderBy=orderBy)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->preassignmentBookings: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let executionDate = 2013-10-20; // date
    let reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.preassignmentBookings(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
optimisationProfileId
UUID (uuid)
The id of the optimisation profile.
executionDate
date (date)
Date of execution.
reassignmentId
UUID (uuid)
The id of assignment to be reassigned.
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.

Responses


preassignmentVehicles

Get paginated list of vehicles to be used in creation of new assignment with given optimisation profile.


/assignment/preassignmentVehicles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/preassignmentVehicles?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&optimisationProfileId=38400000-8cf0-11bd-b23e-10b96e4ef00d&executionDate=2013-10-20&reassignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&active=&depotName="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
        date executionDate = 2013-10-20; // date | Date of execution.
        UUID reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.

        try {
            VehiclesPage result = apiInstance.preassignmentVehicles(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy, active, depotName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#preassignmentVehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
        date executionDate = 2013-10-20; // date | Date of execution.
        UUID reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.

        try {
            VehiclesPage result = apiInstance.preassignmentVehicles(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy, active, depotName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#preassignmentVehicles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the optimisation profile. (optional) (default to null)
date *executionDate = 2013-10-20; // Date of execution. (optional) (default to null)
UUID *reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of assignment to be reassigned. (optional) (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)

[apiInstance preassignmentVehiclesWith:tenantId
    optimisationProfileId:optimisationProfileId
    executionDate:executionDate
    reassignmentId:reassignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    active:active
    depotName:depotName
              completionHandler: ^(VehiclesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'optimisationProfileId': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} The id of the optimisation profile.
  'executionDate': 2013-10-20, // {date} Date of execution.
  'reassignmentId': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} The id of assignment to be reassigned.
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'depotName':  // {array[String]} Filter: list of depot names to match.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the optimisation profile. (optional)  (default to null)
            var executionDate = 2013-10-20;  // date | Date of execution. (optional)  (default to null)
            var reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of assignment to be reassigned. (optional)  (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)

            try {
                VehiclesPage result = apiInstance.preassignmentVehicles(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy, active, depotName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.preassignmentVehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the optimisation profile.
$executionDate = 2013-10-20; // date | Date of execution.
$reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of assignment to be reassigned.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$depotName = ; // array[String] | Filter: list of depot names to match.

try {
    $result = $api_instance->preassignmentVehicles($tenantId, $optimisationProfileId, $executionDate, $reassignmentId, $offset, $limit, $orderBy, $active, $depotName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->preassignmentVehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the optimisation profile.
my $executionDate = 2013-10-20; # date | Date of execution.
my $reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of assignment to be reassigned.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $depotName = []; # array[String] | Filter: list of depot names to match.

eval {
    my $result = $api_instance->preassignmentVehicles(tenantId => $tenantId, optimisationProfileId => $optimisationProfileId, executionDate => $executionDate, reassignmentId => $reassignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, active => $active, depotName => $depotName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->preassignmentVehicles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the optimisation profile. (optional) (default to null)
executionDate = 2013-10-20 # date | Date of execution. (optional) (default to null)
reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of assignment to be reassigned. (optional) (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)

try:
    api_response = api_instance.preassignment_vehicles(tenantId, optimisationProfileId=optimisationProfileId, executionDate=executionDate, reassignmentId=reassignmentId, offset=offset, limit=limit, orderBy=orderBy, active=active, depotName=depotName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->preassignmentVehicles: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let optimisationProfileId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let executionDate = 2013-10-20; // date
    let reassignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let active = ; // array[VehicleActivityStatus]
    let depotName = ; // array[String]

    let mut context = RoutingApi::Context::default();
    let result = client.preassignmentVehicles(tenantId, optimisationProfileId, executionDate, reassignmentId, offset, limit, orderBy, active, depotName, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
optimisationProfileId
UUID (uuid)
The id of the optimisation profile.
executionDate
date (date)
Date of execution.
reassignmentId
UUID (uuid)
The id of assignment to be reassigned.
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
depotName
array[String]
Filter: list of depot names to match.

Responses


routeById

Get a single route by id.


/assignment/route

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/route?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingRoute result = apiInstance.routeById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingRoute result = apiInstance.routeById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance routeByIdWith:tenantId
    id:id
              completionHandler: ^(RoutingRoute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.route_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routeById: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.routeById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


routeCreate

Create a route.


/assignment/route

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/assignment/route?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "route" : {
    "vehicleId" : "vehicleId",
    "assignmentId" : "assignmentId",
    "tasks" : [ {
      "eta" : "2024-01-15T15:00:00.000+0000",
      "etd" : "2024-01-15T15:00:00.000+0000",
      "refId" : "refId"
    }, {
      "eta" : "2024-01-15T15:00:00.000+0000",
      "etd" : "2024-01-15T15:00:00.000+0000",
      "refId" : "refId"
    } ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingAssignmentRouteCreateRequest routingAssignmentRouteCreateRequest = ; // RoutingAssignmentRouteCreateRequest | 

        try {
            RoutingRoute result = apiInstance.routeCreate(tenantId, routingAssignmentRouteCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingAssignmentRouteCreateRequest routingAssignmentRouteCreateRequest = ; // RoutingAssignmentRouteCreateRequest | 

        try {
            RoutingRoute result = apiInstance.routeCreate(tenantId, routingAssignmentRouteCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingAssignmentRouteCreateRequest *routingAssignmentRouteCreateRequest = ; //  (optional)

[apiInstance routeCreateWith:tenantId
    routingAssignmentRouteCreateRequest:routingAssignmentRouteCreateRequest
              completionHandler: ^(RoutingRoute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingAssignmentRouteCreateRequest':  // {RoutingAssignmentRouteCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingAssignmentRouteCreateRequest = new RoutingAssignmentRouteCreateRequest(); // RoutingAssignmentRouteCreateRequest |  (optional) 

            try {
                RoutingRoute result = apiInstance.routeCreate(tenantId, routingAssignmentRouteCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.routeCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingAssignmentRouteCreateRequest = ; // RoutingAssignmentRouteCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingAssignmentRouteCreateRequest = WWW::OPenAPIClient::Object::RoutingAssignmentRouteCreateRequest->new(); # RoutingAssignmentRouteCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingAssignmentRouteCreateRequest =  # RoutingAssignmentRouteCreateRequest |  (optional)

try:
    api_response = api_instance.route_create(tenantId, routingAssignmentRouteCreateRequest=routingAssignmentRouteCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routeCreate: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingAssignmentRouteCreateRequest = ; // RoutingAssignmentRouteCreateRequest

    let mut context = RoutingApi::Context::default();
    let result = client.routeCreate(tenantId, routingAssignmentRouteCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingAssignmentRouteCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


routeDelete

Delete a route.


/assignment/route

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/route?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.routeDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.routeDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance routeDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.routeDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.routeDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.route_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling RoutingApi->routeDelete: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.routeDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


routeExtended

Get a route and related objects at once.


/assignment/route/extended

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/route/extended?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingRouteExtended result = apiInstance.routeExtended(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeExtended");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            RoutingRouteExtended result = apiInstance.routeExtended(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeExtended");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance routeExtendedWith:tenantId
    id:id
              completionHandler: ^(RoutingRouteExtended output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.route_extended(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routeExtended: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.routeExtended(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


routeInExecution

Get a single route which is currently being executed by specified vehicle. Query can return result with empty "route" field if the vehicle is not busy right now.


/assignment/route/inExecution

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/route/inExecution?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&vehicleId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the vehicle.

        try {
            RoutingRouteAndBusy result = apiInstance.routeInExecution(tenantId, vehicleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeInExecution");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the vehicle.

        try {
            RoutingRouteAndBusy result = apiInstance.routeInExecution(tenantId, vehicleId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeInExecution");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the vehicle. (default to null)

[apiInstance routeInExecutionWith:tenantId
    vehicleId:vehicleId
              completionHandler: ^(RoutingRouteAndBusy output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the vehicle.

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the vehicle. (default to null)

            try {
                RoutingRouteAndBusy result = apiInstance.routeInExecution(tenantId, vehicleId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.routeInExecution: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the vehicle.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the vehicle.

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the vehicle. (default to null)

try:
    api_response = api_instance.route_in_execution(tenantId, vehicleId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routeInExecution: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vehicleId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = RoutingApi::Context::default();
    let result = client.routeInExecution(tenantId, vehicleId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
vehicleId*
UUID (uuid)
The id of the vehicle.
Required

Responses


routeUpdate

Update a single route in assignment.


/assignment/route

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/assignment/route?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "route" : {
    "id" : "id",
    "version" : "version",
    "tasks" : [ {
      "eta" : "2024-01-15T15:00:00.000+0000",
      "etd" : "2024-01-15T15:00:00.000+0000",
      "refId" : "refId"
    }, {
      "eta" : "2024-01-15T15:00:00.000+0000",
      "etd" : "2024-01-15T15:00:00.000+0000",
      "refId" : "refId"
    } ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingAssignmentRouteUpdateRequest routingAssignmentRouteUpdateRequest = ; // RoutingAssignmentRouteUpdateRequest | 

        try {
            RoutingRoute result = apiInstance.routeUpdate(tenantId, routingAssignmentRouteUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingAssignmentRouteUpdateRequest routingAssignmentRouteUpdateRequest = ; // RoutingAssignmentRouteUpdateRequest | 

        try {
            RoutingRoute result = apiInstance.routeUpdate(tenantId, routingAssignmentRouteUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routeUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingAssignmentRouteUpdateRequest *routingAssignmentRouteUpdateRequest = ; //  (optional)

[apiInstance routeUpdateWith:tenantId
    routingAssignmentRouteUpdateRequest:routingAssignmentRouteUpdateRequest
              completionHandler: ^(RoutingRoute output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingAssignmentRouteUpdateRequest':  // {RoutingAssignmentRouteUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingAssignmentRouteUpdateRequest = new RoutingAssignmentRouteUpdateRequest(); // RoutingAssignmentRouteUpdateRequest |  (optional) 

            try {
                RoutingRoute result = apiInstance.routeUpdate(tenantId, routingAssignmentRouteUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.routeUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingAssignmentRouteUpdateRequest = ; // RoutingAssignmentRouteUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingAssignmentRouteUpdateRequest = WWW::OPenAPIClient::Object::RoutingAssignmentRouteUpdateRequest->new(); # RoutingAssignmentRouteUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingAssignmentRouteUpdateRequest =  # RoutingAssignmentRouteUpdateRequest |  (optional)

try:
    api_response = api_instance.route_update(tenantId, routingAssignmentRouteUpdateRequest=routingAssignmentRouteUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routeUpdate: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingAssignmentRouteUpdateRequest = ; // RoutingAssignmentRouteUpdateRequest

    let mut context = RoutingApi::Context::default();
    let result = client.routeUpdate(tenantId, routingAssignmentRouteUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingAssignmentRouteUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


routes

Get a list of routes in given assignment.


/assignment/route/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/route/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&details=details_example&start=start_example&finish=finish_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String details = details_example; // String | Search text matching route vehicle plates.
        String start = start_example; // String | Search text matching route start address.
        String finish = finish_example; // String | Search text matching route finish address.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingRoutesPage result = apiInstance.routes(tenantId, assignmentId, offset, limit, orderBy, details, start, finish, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String details = details_example; // String | Search text matching route vehicle plates.
        String start = start_example; // String | Search text matching route start address.
        String finish = finish_example; // String | Search text matching route finish address.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            RoutingRoutesPage result = apiInstance.routes(tenantId, assignmentId, offset, limit, orderBy, details, start, finish, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#routes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *details = details_example; // Search text matching route vehicle plates. (optional) (default to null)
String *start = start_example; // Search text matching route start address. (optional) (default to null)
String *finish = finish_example; // Search text matching route finish address. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance routesWith:tenantId
    assignmentId:assignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    details:details
    start:start
    finish:finish
    attributes:attributes
    searchText:searchText
              completionHandler: ^(RoutingRoutesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'details': details_example, // {String} Search text matching route vehicle plates.
  'start': start_example, // {String} Search text matching route start address.
  'finish': finish_example, // {String} Search text matching route finish address.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var details = details_example;  // String | Search text matching route vehicle plates. (optional)  (default to null)
            var start = start_example;  // String | Search text matching route start address. (optional)  (default to null)
            var finish = finish_example;  // String | Search text matching route finish address. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                RoutingRoutesPage result = apiInstance.routes(tenantId, assignmentId, offset, limit, orderBy, details, start, finish, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.routes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$details = details_example; // String | Search text matching route vehicle plates.
$start = start_example; // String | Search text matching route start address.
$finish = finish_example; // String | Search text matching route finish address.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->routes($tenantId, $assignmentId, $offset, $limit, $orderBy, $details, $start, $finish, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->routes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $details = details_example; # String | Search text matching route vehicle plates.
my $start = start_example; # String | Search text matching route start address.
my $finish = finish_example; # String | Search text matching route finish address.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->routes(tenantId => $tenantId, assignmentId => $assignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, details => $details, start => $start, finish => $finish, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->routes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
details = details_example # String | Search text matching route vehicle plates. (optional) (default to null)
start = start_example # String | Search text matching route start address. (optional) (default to null)
finish = finish_example # String | Search text matching route finish address. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.routes(tenantId, assignmentId, offset=offset, limit=limit, orderBy=orderBy, details=details, start=start, finish=finish, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->routes: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let details = details_example; // String
    let start = start_example; // String
    let finish = finish_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.routes(tenantId, assignmentId, offset, limit, orderBy, details, start, finish, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
details
String
Search text matching route vehicle plates.
start
String
Search text matching route start address.
finish
String
Search text matching route finish address.
attributes
String
searchText
String
Filter: match by name or address.

Responses


sendRequest

Starts assignment process and returns new assignment id.


/assignment/request

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/assignment/request?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "request" : {
    "reassignmentId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "deselectedBookings" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "optimisationProfileId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "selectedBookings" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "executionDate" : "2000-01-23",
    "name" : "name",
    "selectedVehicles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "details" : "details",
    "deselectedVehicles" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingRequestRequest routingRequestRequest = ; // RoutingRequestRequest | 

        try {
            'String' result = apiInstance.sendRequest(tenantId, routingRequestRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#sendRequest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        RoutingRequestRequest routingRequestRequest = ; // RoutingRequestRequest | 

        try {
            'String' result = apiInstance.sendRequest(tenantId, routingRequestRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#sendRequest");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
RoutingRequestRequest *routingRequestRequest = ; //  (optional)

[apiInstance sendRequestWith:tenantId
    routingRequestRequest:routingRequestRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'routingRequestRequest':  // {RoutingRequestRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var routingRequestRequest = new RoutingRequestRequest(); // RoutingRequestRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$routingRequestRequest = ; // RoutingRequestRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $routingRequestRequest = WWW::OPenAPIClient::Object::RoutingRequestRequest->new(); # RoutingRequestRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
routingRequestRequest =  # RoutingRequestRequest |  (optional)

try:
    api_response = api_instance.send_request(tenantId, routingRequestRequest=routingRequestRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->sendRequest: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let routingRequestRequest = ; // RoutingRequestRequest

    let mut context = RoutingApi::Context::default();
    let result = client.sendRequest(tenantId, routingRequestRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
routingRequestRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


unassignedBookings

List of unassigned bookings matching given assignment.


/assignment/unassignedBookings

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/unassignedBookings?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&pickUpTimeWindow=&dropOffTimeWindow=&externalId=externalId_example&pickUpLocation=pickUpLocation_example&dropOffLocation=dropOffLocation_example&dateFrom=2013-10-20&dateTo=2013-10-20&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            UnassignedBookingsPage result = apiInstance.unassignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#unassignedBookings");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        RangeFilter pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
        RangeFilter dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
        String externalId = externalId_example; // String | Filter: match by externalId
        String pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
        String dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
        date dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
        date dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            UnassignedBookingsPage result = apiInstance.unassignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#unassignedBookings");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
RangeFilter *pickUpTimeWindow = ; // Filter: match pickup time window. (optional) (default to null)
RangeFilter *dropOffTimeWindow = ; // Filter: match drop off time window. (optional) (default to null)
String *externalId = externalId_example; // Filter: match by externalId (optional) (default to null)
String *pickUpLocation = pickUpLocation_example; // Filter: match by pickup location. (optional) (default to null)
String *dropOffLocation = dropOffLocation_example; // Filter: match by drop off location. (optional) (default to null)
date *dateFrom = 2013-10-20; // Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
date *dateTo = 2013-10-20; // Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance unassignedBookingsWith:tenantId
    assignmentId:assignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    pickUpTimeWindow:pickUpTimeWindow
    dropOffTimeWindow:dropOffTimeWindow
    externalId:externalId
    pickUpLocation:pickUpLocation
    dropOffLocation:dropOffLocation
    dateFrom:dateFrom
    dateTo:dateTo
    attributes:attributes
    searchText:searchText
              completionHandler: ^(UnassignedBookingsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'pickUpTimeWindow': , // {RangeFilter} Filter: match pickup time window.
  'dropOffTimeWindow': , // {RangeFilter} Filter: match drop off time window.
  'externalId': externalId_example, // {String} Filter: match by externalId
  'pickUpLocation': pickUpLocation_example, // {String} Filter: match by pickup location.
  'dropOffLocation': dropOffLocation_example, // {String} Filter: match by drop off location.
  'dateFrom': 2013-10-20, // {date} Filter: match bookings with pickup time window starting from given date (inclusive).
  'dateTo': 2013-10-20, // {date} Filter: match bookings with drop off time window ending at given date (inclusive).
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var pickUpTimeWindow = new RangeFilter(); // RangeFilter | Filter: match pickup time window. (optional)  (default to null)
            var dropOffTimeWindow = new RangeFilter(); // RangeFilter | Filter: match drop off time window. (optional)  (default to null)
            var externalId = externalId_example;  // String | Filter: match by externalId (optional)  (default to null)
            var pickUpLocation = pickUpLocation_example;  // String | Filter: match by pickup location. (optional)  (default to null)
            var dropOffLocation = dropOffLocation_example;  // String | Filter: match by drop off location. (optional)  (default to null)
            var dateFrom = 2013-10-20;  // date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional)  (default to null)
            var dateTo = 2013-10-20;  // date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                UnassignedBookingsPage result = apiInstance.unassignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.unassignedBookings: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$pickUpTimeWindow = ; // RangeFilter | Filter: match pickup time window.
$dropOffTimeWindow = ; // RangeFilter | Filter: match drop off time window.
$externalId = externalId_example; // String | Filter: match by externalId
$pickUpLocation = pickUpLocation_example; // String | Filter: match by pickup location.
$dropOffLocation = dropOffLocation_example; // String | Filter: match by drop off location.
$dateFrom = 2013-10-20; // date | Filter: match bookings with pickup time window starting from given date (inclusive).
$dateTo = 2013-10-20; // date | Filter: match bookings with drop off time window ending at given date (inclusive).
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->unassignedBookings($tenantId, $assignmentId, $offset, $limit, $orderBy, $pickUpTimeWindow, $dropOffTimeWindow, $externalId, $pickUpLocation, $dropOffLocation, $dateFrom, $dateTo, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->unassignedBookings: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $pickUpTimeWindow = ; # RangeFilter | Filter: match pickup time window.
my $dropOffTimeWindow = ; # RangeFilter | Filter: match drop off time window.
my $externalId = externalId_example; # String | Filter: match by externalId
my $pickUpLocation = pickUpLocation_example; # String | Filter: match by pickup location.
my $dropOffLocation = dropOffLocation_example; # String | Filter: match by drop off location.
my $dateFrom = 2013-10-20; # date | Filter: match bookings with pickup time window starting from given date (inclusive).
my $dateTo = 2013-10-20; # date | Filter: match bookings with drop off time window ending at given date (inclusive).
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->unassignedBookings(tenantId => $tenantId, assignmentId => $assignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, pickUpTimeWindow => $pickUpTimeWindow, dropOffTimeWindow => $dropOffTimeWindow, externalId => $externalId, pickUpLocation => $pickUpLocation, dropOffLocation => $dropOffLocation, dateFrom => $dateFrom, dateTo => $dateTo, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->unassignedBookings: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
pickUpTimeWindow =  # RangeFilter | Filter: match pickup time window. (optional) (default to null)
dropOffTimeWindow =  # RangeFilter | Filter: match drop off time window. (optional) (default to null)
externalId = externalId_example # String | Filter: match by externalId (optional) (default to null)
pickUpLocation = pickUpLocation_example # String | Filter: match by pickup location. (optional) (default to null)
dropOffLocation = dropOffLocation_example # String | Filter: match by drop off location. (optional) (default to null)
dateFrom = 2013-10-20 # date | Filter: match bookings with pickup time window starting from given date (inclusive). (optional) (default to null)
dateTo = 2013-10-20 # date | Filter: match bookings with drop off time window ending at given date (inclusive). (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.unassigned_bookings(tenantId, assignmentId, offset=offset, limit=limit, orderBy=orderBy, pickUpTimeWindow=pickUpTimeWindow, dropOffTimeWindow=dropOffTimeWindow, externalId=externalId, pickUpLocation=pickUpLocation, dropOffLocation=dropOffLocation, dateFrom=dateFrom, dateTo=dateTo, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->unassignedBookings: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let pickUpTimeWindow = ; // RangeFilter
    let dropOffTimeWindow = ; // RangeFilter
    let externalId = externalId_example; // String
    let pickUpLocation = pickUpLocation_example; // String
    let dropOffLocation = dropOffLocation_example; // String
    let dateFrom = 2013-10-20; // date
    let dateTo = 2013-10-20; // date
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.unassignedBookings(tenantId, assignmentId, offset, limit, orderBy, pickUpTimeWindow, dropOffTimeWindow, externalId, pickUpLocation, dropOffLocation, dateFrom, dateTo, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
pickUpTimeWindow
RangeFilter
Filter: match pickup time window.
dropOffTimeWindow
RangeFilter
Filter: match drop off time window.
externalId
String
Filter: match by externalId
pickUpLocation
String
Filter: match by pickup location.
dropOffLocation
String
Filter: match by drop off location.
dateFrom
date (date)
Filter: match bookings with pickup time window starting from given date (inclusive).
dateTo
date (date)
Filter: match bookings with drop off time window ending at given date (inclusive).
attributes
String
searchText
String
Filter: match by name or address.

Responses


unassignedVehicles

List of unassigned vehicles matching given assignment.


/assignment/unassignedVehicles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/assignment/unassignedVehicles?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&assignmentId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&active=&depotName=&name=name_example&plate=plate_example&telematicsDeviceId=telematicsDeviceId_example&startingPointName=startingPointName_example&driverName=driverName_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RoutingApi;

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

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

        // Create an instance of the API class
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.unassignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#unassignedVehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RoutingApi;

public class RoutingApiExample {
    public static void main(String[] args) {
        RoutingApi apiInstance = new RoutingApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.unassignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RoutingApi#unassignedVehicles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RoutingApi *apiInstance = [[RoutingApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the assignment. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)
String *name = name_example; // Filter: match by vehicle name. (optional) (default to null)
String *plate = plate_example; // Filter: match by vehicle registration plate. (optional) (default to null)
String *telematicsDeviceId = telematicsDeviceId_example; // Filter: match by telematics device ID. (optional) (default to null)
String *startingPointName = startingPointName_example; // Filter: match by starting point name. (optional) (default to null)
String *driverName = driverName_example; // Filter: match by driver name. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance unassignedVehiclesWith:tenantId
    assignmentId:assignmentId
    offset:offset
    limit:limit
    orderBy:orderBy
    active:active
    depotName:depotName
    name:name
    plate:plate
    telematicsDeviceId:telematicsDeviceId
    startingPointName:startingPointName
    driverName:driverName
    attributes:attributes
    searchText:searchText
              completionHandler: ^(VehiclesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.RoutingApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the assignment.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'depotName': , // {array[String]} Filter: list of depot names to match.
  'name': name_example, // {String} Filter: match by vehicle name.
  'plate': plate_example, // {String} Filter: match by vehicle registration plate.
  'telematicsDeviceId': telematicsDeviceId_example, // {String} Filter: match by telematics device ID.
  'startingPointName': startingPointName_example, // {String} Filter: match by starting point name.
  'driverName': driverName_example, // {String} Filter: match by driver name.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new RoutingApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the assignment. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by vehicle name. (optional)  (default to null)
            var plate = plate_example;  // String | Filter: match by vehicle registration plate. (optional)  (default to null)
            var telematicsDeviceId = telematicsDeviceId_example;  // String | Filter: match by telematics device ID. (optional)  (default to null)
            var startingPointName = startingPointName_example;  // String | Filter: match by starting point name. (optional)  (default to null)
            var driverName = driverName_example;  // String | Filter: match by driver name. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                VehiclesPage result = apiInstance.unassignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RoutingApi.unassignedVehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RoutingApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the assignment.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$depotName = ; // array[String] | Filter: list of depot names to match.
$name = name_example; // String | Filter: match by vehicle name.
$plate = plate_example; // String | Filter: match by vehicle registration plate.
$telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
$startingPointName = startingPointName_example; // String | Filter: match by starting point name.
$driverName = driverName_example; // String | Filter: match by driver name.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->unassignedVehicles($tenantId, $assignmentId, $offset, $limit, $orderBy, $active, $depotName, $name, $plate, $telematicsDeviceId, $startingPointName, $driverName, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->unassignedVehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RoutingApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RoutingApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the assignment.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $depotName = []; # array[String] | Filter: list of depot names to match.
my $name = name_example; # String | Filter: match by vehicle name.
my $plate = plate_example; # String | Filter: match by vehicle registration plate.
my $telematicsDeviceId = telematicsDeviceId_example; # String | Filter: match by telematics device ID.
my $startingPointName = startingPointName_example; # String | Filter: match by starting point name.
my $driverName = driverName_example; # String | Filter: match by driver name.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->unassignedVehicles(tenantId => $tenantId, assignmentId => $assignmentId, offset => $offset, limit => $limit, orderBy => $orderBy, active => $active, depotName => $depotName, name => $name, plate => $plate, telematicsDeviceId => $telematicsDeviceId, startingPointName => $startingPointName, driverName => $driverName, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RoutingApi->unassignedVehicles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.RoutingApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the assignment. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)
name = name_example # String | Filter: match by vehicle name. (optional) (default to null)
plate = plate_example # String | Filter: match by vehicle registration plate. (optional) (default to null)
telematicsDeviceId = telematicsDeviceId_example # String | Filter: match by telematics device ID. (optional) (default to null)
startingPointName = startingPointName_example # String | Filter: match by starting point name. (optional) (default to null)
driverName = driverName_example # String | Filter: match by driver name. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.unassigned_vehicles(tenantId, assignmentId, offset=offset, limit=limit, orderBy=orderBy, active=active, depotName=depotName, name=name, plate=plate, telematicsDeviceId=telematicsDeviceId, startingPointName=startingPointName, driverName=driverName, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoutingApi->unassignedVehicles: %s\n" % e)
extern crate RoutingApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let assignmentId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let active = ; // array[VehicleActivityStatus]
    let depotName = ; // array[String]
    let name = name_example; // String
    let plate = plate_example; // String
    let telematicsDeviceId = telematicsDeviceId_example; // String
    let startingPointName = startingPointName_example; // String
    let driverName = driverName_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = RoutingApi::Context::default();
    let result = client.unassignedVehicles(tenantId, assignmentId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
assignmentId*
UUID (uuid)
The id of the assignment.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
depotName
array[String]
Filter: list of depot names to match.
name
String
Filter: match by vehicle name.
plate
String
Filter: match by vehicle registration plate.
telematicsDeviceId
String
Filter: match by telematics device ID.
startingPointName
String
Filter: match by starting point name.
driverName
String
Filter: match by driver name.
attributes
String
searchText
String
Filter: match by name or address.

Responses


Statistics

statistics

Statistics for a given period.


/statistics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/statistics?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&fromDate=fromDate_example&toDate=toDate_example&window="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatisticsApi;

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

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

        // Create an instance of the API class
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.
        StatisticsAggregationWindow window = ; // StatisticsAggregationWindow | Time span to group statistics by.

        try {
            StatisticsData result = apiInstance.statistics(tenantId, fromDate, toDate, window);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statistics");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StatisticsApi;

public class StatisticsApiExample {
    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.
        StatisticsAggregationWindow window = ; // StatisticsAggregationWindow | Time span to group statistics by.

        try {
            StatisticsData result = apiInstance.statistics(tenantId, fromDate, toDate, window);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statistics");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StatisticsApi *apiInstance = [[StatisticsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
String *fromDate = fromDate_example; // Fetch statistics since that day. (default to null)
String *toDate = toDate_example; // Fetch statistics until that day. (default to null)
StatisticsAggregationWindow *window = ; // Time span to group statistics by. (default to null)

[apiInstance statisticsWith:tenantId
    fromDate:fromDate
    toDate:toDate
    window:window
              completionHandler: ^(StatisticsData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.StatisticsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var fromDate = fromDate_example; // {String} Fetch statistics since that day.
var toDate = toDate_example; // {String} Fetch statistics until that day.
var window = ; // {StatisticsAggregationWindow} Time span to group statistics by.

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

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

            // Create an instance of the API class
            var apiInstance = new StatisticsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var fromDate = fromDate_example;  // String | Fetch statistics since that day. (default to null)
            var toDate = toDate_example;  // String | Fetch statistics until that day. (default to null)
            var window = new StatisticsAggregationWindow(); // StatisticsAggregationWindow | Time span to group statistics by. (default to null)

            try {
                StatisticsData result = apiInstance.statistics(tenantId, fromDate, toDate, window);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StatisticsApi.statistics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatisticsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$fromDate = fromDate_example; // String | Fetch statistics since that day.
$toDate = toDate_example; // String | Fetch statistics until that day.
$window = ; // StatisticsAggregationWindow | Time span to group statistics by.

try {
    $result = $api_instance->statistics($tenantId, $fromDate, $toDate, $window);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatisticsApi->statistics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::StatisticsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatisticsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $fromDate = fromDate_example; # String | Fetch statistics since that day.
my $toDate = toDate_example; # String | Fetch statistics until that day.
my $window = ; # StatisticsAggregationWindow | Time span to group statistics by.

eval {
    my $result = $api_instance->statistics(tenantId => $tenantId, fromDate => $fromDate, toDate => $toDate, window => $window);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatisticsApi->statistics: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.StatisticsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
fromDate = fromDate_example # String | Fetch statistics since that day. (default to null)
toDate = toDate_example # String | Fetch statistics until that day. (default to null)
window =  # StatisticsAggregationWindow | Time span to group statistics by. (default to null)

try:
    api_response = api_instance.statistics(tenantId, fromDate, toDate, window)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->statistics: %s\n" % e)
extern crate StatisticsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = fromDate_example; // String
    let toDate = toDate_example; // String
    let window = ; // StatisticsAggregationWindow

    let mut context = StatisticsApi::Context::default();
    let result = client.statistics(tenantId, fromDate, toDate, window, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
fromDate*
String
Fetch statistics since that day.
Required
toDate*
String
Fetch statistics until that day.
Required
window*
StatisticsAggregationWindow
Time span to group statistics by.
Required

Responses


statisticsOrders

Collection of order statistics for given period of time.


/statistics/orders

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/statistics/orders?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&fromDate=fromDate_example&toDate=toDate_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatisticsApi;

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

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

        // Create an instance of the API class
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.

        try {
            StatisticsOrdersData result = apiInstance.statisticsOrders(tenantId, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statisticsOrders");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StatisticsApi;

public class StatisticsApiExample {
    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.

        try {
            StatisticsOrdersData result = apiInstance.statisticsOrders(tenantId, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statisticsOrders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StatisticsApi *apiInstance = [[StatisticsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
String *fromDate = fromDate_example; // Fetch statistics since that day. (default to null)
String *toDate = toDate_example; // Fetch statistics until that day. (default to null)

[apiInstance statisticsOrdersWith:tenantId
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(StatisticsOrdersData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.StatisticsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var fromDate = fromDate_example; // {String} Fetch statistics since that day.
var toDate = toDate_example; // {String} Fetch statistics until that day.

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

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

            // Create an instance of the API class
            var apiInstance = new StatisticsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var fromDate = fromDate_example;  // String | Fetch statistics since that day. (default to null)
            var toDate = toDate_example;  // String | Fetch statistics until that day. (default to null)

            try {
                StatisticsOrdersData result = apiInstance.statisticsOrders(tenantId, fromDate, toDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StatisticsApi.statisticsOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatisticsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$fromDate = fromDate_example; // String | Fetch statistics since that day.
$toDate = toDate_example; // String | Fetch statistics until that day.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatisticsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $fromDate = fromDate_example; # String | Fetch statistics since that day.
my $toDate = toDate_example; # String | Fetch statistics until that day.

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

# Create an instance of the API class
api_instance = openapi_client.StatisticsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
fromDate = fromDate_example # String | Fetch statistics since that day. (default to null)
toDate = toDate_example # String | Fetch statistics until that day. (default to null)

try:
    api_response = api_instance.statistics_orders(tenantId, fromDate, toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->statisticsOrders: %s\n" % e)
extern crate StatisticsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = fromDate_example; // String
    let toDate = toDate_example; // String

    let mut context = StatisticsApi::Context::default();
    let result = client.statisticsOrders(tenantId, fromDate, toDate, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
fromDate*
String
Fetch statistics since that day.
Required
toDate*
String
Fetch statistics until that day.
Required

Responses


statisticsPlanned

Collection of statistics of planned deliveries for given period of time.


/statistics/planned

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/statistics/planned?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&fromDate=fromDate_example&toDate=toDate_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatisticsApi;

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

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

        // Create an instance of the API class
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.

        try {
            StatisticsPlannedData result = apiInstance.statisticsPlanned(tenantId, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statisticsPlanned");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.StatisticsApi;

public class StatisticsApiExample {
    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        String fromDate = fromDate_example; // String | Fetch statistics since that day.
        String toDate = toDate_example; // String | Fetch statistics until that day.

        try {
            StatisticsPlannedData result = apiInstance.statisticsPlanned(tenantId, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statisticsPlanned");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StatisticsApi *apiInstance = [[StatisticsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
String *fromDate = fromDate_example; // Fetch statistics since that day. (default to null)
String *toDate = toDate_example; // Fetch statistics until that day. (default to null)

[apiInstance statisticsPlannedWith:tenantId
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(StatisticsPlannedData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.StatisticsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var fromDate = fromDate_example; // {String} Fetch statistics since that day.
var toDate = toDate_example; // {String} Fetch statistics until that day.

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

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

            // Create an instance of the API class
            var apiInstance = new StatisticsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var fromDate = fromDate_example;  // String | Fetch statistics since that day. (default to null)
            var toDate = toDate_example;  // String | Fetch statistics until that day. (default to null)

            try {
                StatisticsPlannedData result = apiInstance.statisticsPlanned(tenantId, fromDate, toDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling StatisticsApi.statisticsPlanned: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatisticsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$fromDate = fromDate_example; // String | Fetch statistics since that day.
$toDate = toDate_example; // String | Fetch statistics until that day.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatisticsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $fromDate = fromDate_example; # String | Fetch statistics since that day.
my $toDate = toDate_example; # String | Fetch statistics until that day.

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

# Create an instance of the API class
api_instance = openapi_client.StatisticsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
fromDate = fromDate_example # String | Fetch statistics since that day. (default to null)
toDate = toDate_example # String | Fetch statistics until that day. (default to null)

try:
    api_response = api_instance.statistics_planned(tenantId, fromDate, toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->statisticsPlanned: %s\n" % e)
extern crate StatisticsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let fromDate = fromDate_example; // String
    let toDate = toDate_example; // String

    let mut context = StatisticsApi::Context::default();
    let result = client.statisticsPlanned(tenantId, fromDate, toDate, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
fromDate*
String
Fetch statistics since that day.
Required
toDate*
String
Fetch statistics until that day.
Required

Responses


statisticsToday

A daily summary of the fleet operational data - vehicles at the given moment and orders with a delivery date today.


/statistics/today

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/statistics/today?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.StatisticsApi;

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

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

        // Create an instance of the API class
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

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

public class StatisticsApiExample {
    public static void main(String[] args) {
        StatisticsApi apiInstance = new StatisticsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

        try {
            StatisticsToday result = apiInstance.statisticsToday(tenantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatisticsApi#statisticsToday");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
StatisticsApi *apiInstance = [[StatisticsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)

[apiInstance statisticsTodayWith:tenantId
              completionHandler: ^(StatisticsToday output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.StatisticsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new StatisticsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\StatisticsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::StatisticsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.StatisticsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)

try:
    api_response = api_instance.statistics_today(tenantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatisticsApi->statisticsToday: %s\n" % e)
extern crate StatisticsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = StatisticsApi::Context::default();
    let result = client.statisticsToday(tenantId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


Telematics

telematicsAlerts

List vehicle alerts.


/telematics/alert/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/alert/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&vehicle=38400000-8cf0-11bd-b23e-10b96e4ef00d&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        UUID vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filters by one single vehicle identifier
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TelematicsAlertsPage result = apiInstance.telematicsAlerts(tenantId, offset, limit, orderBy, vehicle, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsAlerts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        UUID vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filters by one single vehicle identifier
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TelematicsAlertsPage result = apiInstance.telematicsAlerts(tenantId, offset, limit, orderBy, vehicle, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsAlerts");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
UUID *vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Filters by one single vehicle identifier (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance telematicsAlertsWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    vehicle:vehicle
    searchText:searchText
              completionHandler: ^(TelematicsAlertsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'vehicle': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Filters by one single vehicle identifier
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Filters by one single vehicle identifier (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                TelematicsAlertsPage result = apiInstance.telematicsAlerts(tenantId, offset, limit, orderBy, vehicle, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TelematicsApi.telematicsAlerts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filters by one single vehicle identifier
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->telematicsAlerts($tenantId, $offset, $limit, $orderBy, $vehicle, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TelematicsApi->telematicsAlerts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TelematicsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Filters by one single vehicle identifier
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->telematicsAlerts(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, vehicle => $vehicle, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TelematicsApi->telematicsAlerts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Filters by one single vehicle identifier (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.telematics_alerts(tenantId, offset=offset, limit=limit, orderBy=orderBy, vehicle=vehicle, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsAlerts: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let vehicle = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let searchText = searchText_example; // String

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsAlerts(tenantId, offset, limit, orderBy, vehicle, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
vehicle
UUID (uuid)
Filters by one single vehicle identifier
searchText
String
Filter: match by name or address.

Responses


telematicsDevice

Get data of a telematic device.


/telematics/device

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/device?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d&lastDatetime=2024-01-15T15:00:00.000+0000"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        String lastDatetime = 2024-01-15T15:00:00.000+0000; // String | Filter response data to include only timeseries after provided datetime.

        try {
            TelematicsDeviceData result = apiInstance.telematicsDevice(tenantId, id, lastDatetime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsDevice");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
        String lastDatetime = 2024-01-15T15:00:00.000+0000; // String | Filter response data to include only timeseries after provided datetime.

        try {
            TelematicsDeviceData result = apiInstance.telematicsDevice(tenantId, id, lastDatetime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsDevice");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)
String *lastDatetime = 2024-01-15T15:00:00.000+0000; // Filter response data to include only timeseries after provided datetime. (optional) (default to null)

[apiInstance telematicsDeviceWith:tenantId
    id:id
    lastDatetime:lastDatetime
              completionHandler: ^(TelematicsDeviceData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.
var opts = {
  'lastDatetime': 2024-01-15T15:00:00.000+0000 // {String} Filter response data to include only timeseries after provided datetime.
};

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)
            var lastDatetime = 2024-01-15T15:00:00.000+0000;  // String | Filter response data to include only timeseries after provided datetime. (optional)  (default to null)

            try {
                TelematicsDeviceData result = apiInstance.telematicsDevice(tenantId, id, lastDatetime);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TelematicsApi.telematicsDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.
$lastDatetime = 2024-01-15T15:00:00.000+0000; // String | Filter response data to include only timeseries after provided datetime.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.
my $lastDatetime = 2024-01-15T15:00:00.000+0000; # String | Filter response data to include only timeseries after provided datetime.

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

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)
lastDatetime = 2024-01-15T15:00:00.000+0000 # String | Filter response data to include only timeseries after provided datetime. (optional) (default to null)

try:
    api_response = api_instance.telematics_device(tenantId, id, lastDatetime=lastDatetime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsDevice: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let lastDatetime = 2024-01-15T15:00:00.000+0000; // String

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsDevice(tenantId, id, lastDatetime, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required
lastDatetime
String
Filter response data to include only timeseries after provided datetime.

Responses


telematicsFleet

Get live fleet data. Aggregated telematics data for the fleet - from midnight to current time (in tenant's time zone).


/telematics/fleet

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/fleet?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

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

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

        try {
            TelematicsLiveFleetData result = apiInstance.telematicsFleet(tenantId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsFleet");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)

[apiInstance telematicsFleetWith:tenantId
              completionHandler: ^(TelematicsLiveFleetData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)

try:
    api_response = api_instance.telematics_fleet(tenantId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsFleet: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsFleet(tenantId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


telematicsPositions

Get positions (last known) of selected vehicles.


/telematics/positions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/positions?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&active=&ignitionOn=true&depotName="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        Boolean ignitionOn = true; // Boolean | Filter: is ignition on.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.

        try {
            array[TelematicsVehiclePosition] result = apiInstance.telematicsPositions(tenantId, offset, limit, orderBy, active, ignitionOn, depotName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsPositions");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        Boolean ignitionOn = true; // Boolean | Filter: is ignition on.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.

        try {
            array[TelematicsVehiclePosition] result = apiInstance.telematicsPositions(tenantId, offset, limit, orderBy, active, ignitionOn, depotName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsPositions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
Boolean *ignitionOn = true; // Filter: is ignition on. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)

[apiInstance telematicsPositionsWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    active:active
    ignitionOn:ignitionOn
    depotName:depotName
              completionHandler: ^(array[TelematicsVehiclePosition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'ignitionOn': true, // {Boolean} Filter: is ignition on.
  'depotName':  // {array[String]} Filter: list of depot names to match.
};

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var ignitionOn = true;  // Boolean | Filter: is ignition on. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)

            try {
                array[TelematicsVehiclePosition] result = apiInstance.telematicsPositions(tenantId, offset, limit, orderBy, active, ignitionOn, depotName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TelematicsApi.telematicsPositions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$ignitionOn = true; // Boolean | Filter: is ignition on.
$depotName = ; // array[String] | Filter: list of depot names to match.

try {
    $result = $api_instance->telematicsPositions($tenantId, $offset, $limit, $orderBy, $active, $ignitionOn, $depotName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TelematicsApi->telematicsPositions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TelematicsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $ignitionOn = true; # Boolean | Filter: is ignition on.
my $depotName = []; # array[String] | Filter: list of depot names to match.

eval {
    my $result = $api_instance->telematicsPositions(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, active => $active, ignitionOn => $ignitionOn, depotName => $depotName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TelematicsApi->telematicsPositions: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
ignitionOn = true # Boolean | Filter: is ignition on. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)

try:
    api_response = api_instance.telematics_positions(tenantId, offset=offset, limit=limit, orderBy=orderBy, active=active, ignitionOn=ignitionOn, depotName=depotName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsPositions: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let active = ; // array[VehicleActivityStatus]
    let ignitionOn = true; // Boolean
    let depotName = ; // array[String]

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsPositions(tenantId, offset, limit, orderBy, active, ignitionOn, depotName, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
ignitionOn
Boolean
Filter: is ignition on.
depotName
array[String]
Filter: list of depot names to match.

Responses


telematicsPositionsPost

Posts vehicle positions


/telematics/positions

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/telematics/positions?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "records" : [ {
    "lon" : 0.8008282,
    "lat" : 6.0274563,
    "timestamp" : 0
  }, {
    "lon" : 0.8008282,
    "lat" : 6.0274563,
    "timestamp" : 0
  } ],
  "deviceId" : "deviceId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        TelematicsVehiclePositionsRequest telematicsVehiclePositionsRequest = ; // TelematicsVehiclePositionsRequest | 

        try {
            array[TelematicsVehiclePosition] result = apiInstance.telematicsPositionsPost(tenantId, telematicsVehiclePositionsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsPositionsPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        TelematicsVehiclePositionsRequest telematicsVehiclePositionsRequest = ; // TelematicsVehiclePositionsRequest | 

        try {
            array[TelematicsVehiclePosition] result = apiInstance.telematicsPositionsPost(tenantId, telematicsVehiclePositionsRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsPositionsPost");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
TelematicsVehiclePositionsRequest *telematicsVehiclePositionsRequest = ; //  (optional)

[apiInstance telematicsPositionsPostWith:tenantId
    telematicsVehiclePositionsRequest:telematicsVehiclePositionsRequest
              completionHandler: ^(array[TelematicsVehiclePosition] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'telematicsVehiclePositionsRequest':  // {TelematicsVehiclePositionsRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var telematicsVehiclePositionsRequest = new TelematicsVehiclePositionsRequest(); // TelematicsVehiclePositionsRequest |  (optional) 

            try {
                array[TelematicsVehiclePosition] result = apiInstance.telematicsPositionsPost(tenantId, telematicsVehiclePositionsRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TelematicsApi.telematicsPositionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$telematicsVehiclePositionsRequest = ; // TelematicsVehiclePositionsRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $telematicsVehiclePositionsRequest = WWW::OPenAPIClient::Object::TelematicsVehiclePositionsRequest->new(); # TelematicsVehiclePositionsRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
telematicsVehiclePositionsRequest =  # TelematicsVehiclePositionsRequest |  (optional)

try:
    api_response = api_instance.telematics_positions_post(tenantId, telematicsVehiclePositionsRequest=telematicsVehiclePositionsRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsPositionsPost: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let telematicsVehiclePositionsRequest = ; // TelematicsVehiclePositionsRequest

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsPositionsPost(tenantId, telematicsVehiclePositionsRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
telematicsVehiclePositionsRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


telematicsVehicle

Get single vehicle with extended telematics data.


/telematics/vehicle

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/vehicle?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            TelematicsVehicle result = apiInstance.telematicsVehicle(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsVehicle");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            TelematicsVehicle result = apiInstance.telematicsVehicle(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsVehicle");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance telematicsVehicleWith:tenantId
    id:id
              completionHandler: ^(TelematicsVehicle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.telematics_vehicle(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsVehicle: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsVehicle(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


telematicsVehicles

List vehicles with extended data.


/telematics/vehicle/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/telematics/vehicle/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&depotName=&name=name_example&plate=plate_example&active=&occupancy=&ignitionOn=true&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TelematicsApi;

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

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

        // Create an instance of the API class
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        VehicleOccupancyStatus occupancy = ; // VehicleOccupancyStatus | 
        Boolean ignitionOn = true; // Boolean | Filter: is ignition on.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TelematicsVehiclesPage result = apiInstance.telematicsVehicles(tenantId, offset, limit, orderBy, depotName, name, plate, active, occupancy, ignitionOn, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsVehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TelematicsApi;

public class TelematicsApiExample {
    public static void main(String[] args) {
        TelematicsApi apiInstance = new TelematicsApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        VehicleOccupancyStatus occupancy = ; // VehicleOccupancyStatus | 
        Boolean ignitionOn = true; // Boolean | Filter: is ignition on.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TelematicsVehiclesPage result = apiInstance.telematicsVehicles(tenantId, offset, limit, orderBy, depotName, name, plate, active, occupancy, ignitionOn, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TelematicsApi#telematicsVehicles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TelematicsApi *apiInstance = [[TelematicsApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)
String *name = name_example; // Filter: match by vehicle name. (optional) (default to null)
String *plate = plate_example; // Filter: match by vehicle registration plate. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
VehicleOccupancyStatus *occupancy = ; //  (optional) (default to null)
Boolean *ignitionOn = true; // Filter: is ignition on. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance telematicsVehiclesWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    depotName:depotName
    name:name
    plate:plate
    active:active
    occupancy:occupancy
    ignitionOn:ignitionOn
    attributes:attributes
    searchText:searchText
              completionHandler: ^(TelematicsVehiclesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TelematicsApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'depotName': , // {array[String]} Filter: list of depot names to match.
  'name': name_example, // {String} Filter: match by vehicle name.
  'plate': plate_example, // {String} Filter: match by vehicle registration plate.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'occupancy': , // {VehicleOccupancyStatus} 
  'ignitionOn': true, // {Boolean} Filter: is ignition on.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new TelematicsApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by vehicle name. (optional)  (default to null)
            var plate = plate_example;  // String | Filter: match by vehicle registration plate. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var occupancy = new VehicleOccupancyStatus(); // VehicleOccupancyStatus |  (optional)  (default to null)
            var ignitionOn = true;  // Boolean | Filter: is ignition on. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                TelematicsVehiclesPage result = apiInstance.telematicsVehicles(tenantId, offset, limit, orderBy, depotName, name, plate, active, occupancy, ignitionOn, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TelematicsApi.telematicsVehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TelematicsApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$depotName = ; // array[String] | Filter: list of depot names to match.
$name = name_example; // String | Filter: match by vehicle name.
$plate = plate_example; // String | Filter: match by vehicle registration plate.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$occupancy = ; // VehicleOccupancyStatus | 
$ignitionOn = true; // Boolean | Filter: is ignition on.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->telematicsVehicles($tenantId, $offset, $limit, $orderBy, $depotName, $name, $plate, $active, $occupancy, $ignitionOn, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TelematicsApi->telematicsVehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TelematicsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TelematicsApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $depotName = []; # array[String] | Filter: list of depot names to match.
my $name = name_example; # String | Filter: match by vehicle name.
my $plate = plate_example; # String | Filter: match by vehicle registration plate.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $occupancy = ; # VehicleOccupancyStatus | 
my $ignitionOn = true; # Boolean | Filter: is ignition on.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->telematicsVehicles(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, depotName => $depotName, name => $name, plate => $plate, active => $active, occupancy => $occupancy, ignitionOn => $ignitionOn, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TelematicsApi->telematicsVehicles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TelematicsApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)
name = name_example # String | Filter: match by vehicle name. (optional) (default to null)
plate = plate_example # String | Filter: match by vehicle registration plate. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
occupancy =  # VehicleOccupancyStatus |  (optional) (default to null)
ignitionOn = true # Boolean | Filter: is ignition on. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.telematics_vehicles(tenantId, offset=offset, limit=limit, orderBy=orderBy, depotName=depotName, name=name, plate=plate, active=active, occupancy=occupancy, ignitionOn=ignitionOn, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TelematicsApi->telematicsVehicles: %s\n" % e)
extern crate TelematicsApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let depotName = ; // array[String]
    let name = name_example; // String
    let plate = plate_example; // String
    let active = ; // array[VehicleActivityStatus]
    let occupancy = ; // VehicleOccupancyStatus
    let ignitionOn = true; // Boolean
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = TelematicsApi::Context::default();
    let result = client.telematicsVehicles(tenantId, offset, limit, orderBy, depotName, name, plate, active, occupancy, ignitionOn, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
depotName
array[String]
Filter: list of depot names to match.
name
String
Filter: match by vehicle name.
plate
String
Filter: match by vehicle registration plate.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
occupancy
VehicleOccupancyStatus
ignitionOn
Boolean
Filter: is ignition on.
attributes
String
searchText
String
Filter: match by name or address.

Responses


Tenants

getUploadData

Get data for uploading objects to s3


/getUploadData

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/getUploadData" \
 -d '{
  "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "key" : "key"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        GetJsonUploadDataRequest getJsonUploadDataRequest = ; // GetJsonUploadDataRequest | 

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

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        GetJsonUploadDataRequest getJsonUploadDataRequest = ; // GetJsonUploadDataRequest | 

        try {
            GetJsonUploadData result = apiInstance.getUploadData(getJsonUploadDataRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#getUploadData");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
GetJsonUploadDataRequest *getJsonUploadDataRequest = ; //  (optional)

[apiInstance getUploadDataWith:getJsonUploadDataRequest
              completionHandler: ^(GetJsonUploadData output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var opts = {
  'getJsonUploadDataRequest':  // {GetJsonUploadDataRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var getJsonUploadDataRequest = new GetJsonUploadDataRequest(); // GetJsonUploadDataRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$getJsonUploadDataRequest = ; // GetJsonUploadDataRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $getJsonUploadDataRequest = WWW::OPenAPIClient::Object::GetJsonUploadDataRequest->new(); # GetJsonUploadDataRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
getJsonUploadDataRequest =  # GetJsonUploadDataRequest |  (optional)

try:
    api_response = api_instance.get_upload_data(getJsonUploadDataRequest=getJsonUploadDataRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->getUploadData: %s\n" % e)
extern crate TenantsApi;

pub fn main() {
    let getJsonUploadDataRequest = ; // GetJsonUploadDataRequest

    let mut context = TenantsApi::Context::default();
    let result = client.getUploadData(getJsonUploadDataRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
getJsonUploadDataRequest

Responses


tenantById

Get tenant object


/tenant

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/tenant?id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance tenantByIdWith:id
              completionHandler: ^(Tenant output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

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

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

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

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

Scopes

Parameters

Query parameters
Name Description
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


tenantCreate

Create a tenant


/tenant

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/tenant" \
 -d '{
  "tenant" : {
    "displayed_name" : "displayed_name",
    "timezone" : "timezone",
    "reportConfig" : "reportConfig",
    "name" : "name",
    "connectionConfig" : "connectionConfig",
    "notificationConfig" : "notificationConfig",
    "config" : "config",
    "attributeConfig" : "attributeConfig"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        TenantCreateRequest tenantCreateRequest = ; // TenantCreateRequest | 

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

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        TenantCreateRequest tenantCreateRequest = ; // TenantCreateRequest | 

        try {
            Tenant result = apiInstance.tenantCreate(tenantCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#tenantCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
TenantCreateRequest *tenantCreateRequest = ; //  (optional)

[apiInstance tenantCreateWith:tenantCreateRequest
              completionHandler: ^(Tenant output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var opts = {
  'tenantCreateRequest':  // {TenantCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var tenantCreateRequest = new TenantCreateRequest(); // TenantCreateRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$tenantCreateRequest = ; // TenantCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $tenantCreateRequest = WWW::OPenAPIClient::Object::TenantCreateRequest->new(); # TenantCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
tenantCreateRequest =  # TenantCreateRequest |  (optional)

try:
    api_response = api_instance.tenant_create(tenantCreateRequest=tenantCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->tenantCreate: %s\n" % e)
extern crate TenantsApi;

pub fn main() {
    let tenantCreateRequest = ; // TenantCreateRequest

    let mut context = TenantsApi::Context::default();
    let result = client.tenantCreate(tenantCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
tenantCreateRequest

Responses


tenantDelete

Delete a tenant


/tenant

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/tenant?id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.tenantDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#tenantDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance tenantDeleteWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.tenant_delete(id)
except ApiException as e:
    print("Exception when calling TenantsApi->tenantDelete: %s\n" % e)
extern crate TenantsApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

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

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

Scopes

Parameters

Query parameters
Name Description
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


tenantUpdate

Update a tenant


/tenant

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/tenant" \
 -d '{
  "tenant" : {
    "displayed_name" : "displayed_name",
    "reportConfig" : "reportConfig",
    "connectionConfig" : "connectionConfig",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "notificationConfig" : "notificationConfig",
    "config" : "config",
    "attributeConfig" : "attributeConfig"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        TenantUpdateRequest tenantUpdateRequest = ; // TenantUpdateRequest | 

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

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        TenantUpdateRequest tenantUpdateRequest = ; // TenantUpdateRequest | 

        try {
            Tenant result = apiInstance.tenantUpdate(tenantUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#tenantUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
TenantUpdateRequest *tenantUpdateRequest = ; //  (optional)

[apiInstance tenantUpdateWith:tenantUpdateRequest
              completionHandler: ^(Tenant output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var opts = {
  'tenantUpdateRequest':  // {TenantUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var tenantUpdateRequest = new TenantUpdateRequest(); // TenantUpdateRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$tenantUpdateRequest = ; // TenantUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $tenantUpdateRequest = WWW::OPenAPIClient::Object::TenantUpdateRequest->new(); # TenantUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
tenantUpdateRequest =  # TenantUpdateRequest |  (optional)

try:
    api_response = api_instance.tenant_update(tenantUpdateRequest=tenantUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->tenantUpdate: %s\n" % e)
extern crate TenantsApi;

pub fn main() {
    let tenantUpdateRequest = ; // TenantUpdateRequest

    let mut context = TenantsApi::Context::default();
    let result = client.tenantUpdate(tenantUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
tenantUpdateRequest

Responses


tenants

List tenants with filtering/sorting options


/tenant/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/tenant/list?offset=56&limit=56&orderBy=orderBy_example&name=name_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TenantsApi;

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

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

        // Create an instance of the API class
        TenantsApi apiInstance = new TenantsApi();
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String name = name_example; // String | Filter: match by name.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TenantsPage result = apiInstance.tenants(offset, limit, orderBy, name, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#tenants");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.TenantsApi;

public class TenantsApiExample {
    public static void main(String[] args) {
        TenantsApi apiInstance = new TenantsApi();
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        String name = name_example; // String | Filter: match by name.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            TenantsPage result = apiInstance.tenants(offset, limit, orderBy, name, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TenantsApi#tenants");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TenantsApi *apiInstance = [[TenantsApi alloc] init];
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
String *name = name_example; // Filter: match by name. (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance tenantsWith:offset
    limit:limit
    orderBy:orderBy
    name:name
    searchText:searchText
              completionHandler: ^(TenantsPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.TenantsApi()
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'name': name_example, // {String} Filter: match by name.
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new TenantsApi();
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by name. (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                TenantsPage result = apiInstance.tenants(offset, limit, orderBy, name, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling TenantsApi.tenants: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TenantsApi();
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$name = name_example; // String | Filter: match by name.
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->tenants($offset, $limit, $orderBy, $name, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TenantsApi->tenants: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TenantsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TenantsApi->new();
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $name = name_example; # String | Filter: match by name.
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->tenants(offset => $offset, limit => $limit, orderBy => $orderBy, name => $name, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TenantsApi->tenants: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.TenantsApi()
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
name = name_example # String | Filter: match by name. (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.tenants(offset=offset, limit=limit, orderBy=orderBy, name=name, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->tenants: %s\n" % e)
extern crate TenantsApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let name = name_example; // String
    let searchText = searchText_example; // String

    let mut context = TenantsApi::Context::default();
    let result = client.tenants(offset, limit, orderBy, name, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
name
String
Filter: match by name.
searchText
String
Filter: match by name or address.

Responses


Users

userBatchUpdate

Update a batch users


/user/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/user/batch" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "allOrNothing" : true,
  "ids" : [ "ids", "ids" ],
  "userArgs" : {
    "roles" : [ {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "attributes" : "attributes"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserBatchUpdateRequest userBatchUpdateRequest = ; // UserBatchUpdateRequest | 

        try {
            array[UserOrError] result = apiInstance.userBatchUpdate(userBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserBatchUpdateRequest userBatchUpdateRequest = ; // UserBatchUpdateRequest | 

        try {
            array[UserOrError] result = apiInstance.userBatchUpdate(userBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserBatchUpdateRequest *userBatchUpdateRequest = ; //  (optional)

[apiInstance userBatchUpdateWith:userBatchUpdateRequest
              completionHandler: ^(array[UserOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var opts = {
  'userBatchUpdateRequest':  // {UserBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userBatchUpdateRequest = new UserBatchUpdateRequest(); // UserBatchUpdateRequest |  (optional) 

            try {
                array[UserOrError] result = apiInstance.userBatchUpdate(userBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.userBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userBatchUpdateRequest = ; // UserBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userBatchUpdateRequest = WWW::OPenAPIClient::Object::UserBatchUpdateRequest->new(); # UserBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
userBatchUpdateRequest =  # UserBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.user_batch_update(userBatchUpdateRequest=userBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userBatchUpdate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userBatchUpdateRequest = ; // UserBatchUpdateRequest

    let mut context = UsersApi::Context::default();
    let result = client.userBatchUpdate(userBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userBatchUpdateRequest

Responses


userById

Get user object


/user

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user?id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance userByIdWith:id
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

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

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

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

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

Scopes

Parameters

Query parameters
Name Description
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


userCreate

Create a user


/user

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/user" \
 -d '{
  "user" : {
    "phone" : "phone",
    "roles" : [ {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "name" : "name",
    "attributes" : "attributes",
    "email" : "email"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserCreateRequest userCreateRequest = ; // UserCreateRequest | 

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

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserCreateRequest userCreateRequest = ; // UserCreateRequest | 

        try {
            User result = apiInstance.userCreate(userCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserCreateRequest *userCreateRequest = ; //  (optional)

[apiInstance userCreateWith:userCreateRequest
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var opts = {
  'userCreateRequest':  // {UserCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userCreateRequest = new UserCreateRequest(); // UserCreateRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userCreateRequest = ; // UserCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userCreateRequest = WWW::OPenAPIClient::Object::UserCreateRequest->new(); # UserCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
userCreateRequest =  # UserCreateRequest |  (optional)

try:
    api_response = api_instance.user_create(userCreateRequest=userCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userCreate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userCreateRequest = ; // UserCreateRequest

    let mut context = UsersApi::Context::default();
    let result = client.userCreate(userCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userCreateRequest

Responses


userDelete

Delete a user


/user

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user?id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.userDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance userDeleteWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.user_delete(id)
except ApiException as e:
    print("Exception when calling UsersApi->userDelete: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

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

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

Scopes

Parameters

Query parameters
Name Description
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


userResetPassword

Reset user's password and MFA device


/user/resetPassword

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user/resetPassword?id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.userResetPassword(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userResetPassword");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance userResetPasswordWith:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.user_reset_password(id)
except ApiException as e:
    print("Exception when calling UsersApi->userResetPassword: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

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

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

Scopes

Parameters

Query parameters
Name Description
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


userRoles

Fetch tenants and roles attached to a logged user.


/user/roles

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user/roles?lang=lang_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        String lang = lang_example; // String | Language of the custom attributes translations.

        try {
            array[TenantRole] result = apiInstance.userRoles(lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userRoles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String lang = lang_example; // String | Language of the custom attributes translations.

        try {
            array[TenantRole] result = apiInstance.userRoles(lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userRoles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
String *lang = lang_example; // Language of the custom attributes translations. (optional) (default to null)

[apiInstance userRolesWith:lang
              completionHandler: ^(array[TenantRole] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var opts = {
  'lang': lang_example // {String} Language of the custom attributes translations.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var lang = lang_example;  // String | Language of the custom attributes translations. (optional)  (default to null)

            try {
                array[TenantRole] result = apiInstance.userRoles(lang);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.userRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$lang = lang_example; // String | Language of the custom attributes translations.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $lang = lang_example; # String | Language of the custom attributes translations.

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
lang = lang_example # String | Language of the custom attributes translations. (optional) (default to null)

try:
    api_response = api_instance.user_roles(lang=lang)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userRoles: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let lang = lang_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.userRoles(lang, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
lang
String
Language of the custom attributes translations.

Responses


userUpdate

Update a user


/user

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/user" \
 -d '{
  "user" : {
    "phone" : "phone",
    "roles" : [ {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    }, {
      "role" : "role",
      "tenantId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
    } ],
    "name" : "name",
    "attributes" : "attributes",
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "version" : "version"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        UserUpdateRequest userUpdateRequest = ; // UserUpdateRequest | 

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

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        UserUpdateRequest userUpdateRequest = ; // UserUpdateRequest | 

        try {
            User result = apiInstance.userUpdate(userUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#userUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
UserUpdateRequest *userUpdateRequest = ; //  (optional)

[apiInstance userUpdateWith:userUpdateRequest
              completionHandler: ^(User output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var opts = {
  'userUpdateRequest':  // {UserUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var userUpdateRequest = new UserUpdateRequest(); // UserUpdateRequest |  (optional) 

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$userUpdateRequest = ; // UserUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $userUpdateRequest = WWW::OPenAPIClient::Object::UserUpdateRequest->new(); # UserUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
userUpdateRequest =  # UserUpdateRequest |  (optional)

try:
    api_response = api_instance.user_update(userUpdateRequest=userUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->userUpdate: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let userUpdateRequest = ; // UserUpdateRequest

    let mut context = UsersApi::Context::default();
    let result = client.userUpdate(userUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
userUpdateRequest

Responses


users

List users with filtering/sorting options


/user/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user/list?offset=56&limit=56&orderBy=orderBy_example&role=&name=name_example&email=email_example&phone=phone_example&tenant=38400000-8cf0-11bd-b23e-10b96e4ef00d&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[Role] role = ; // array[Role] | Filter by role(s).
        String name = name_example; // String | Filter by user name.
        String email = email_example; // String | Filter by user email address.
        String phone = phone_example; // String | Filter by user phone number.
        UUID tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            UsersPage result = apiInstance.users(offset, limit, orderBy, role, name, email, phone, tenant, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#users");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[Role] role = ; // array[Role] | Filter by role(s).
        String name = name_example; // String | Filter by user name.
        String email = email_example; // String | Filter by user email address.
        String phone = phone_example; // String | Filter by user phone number.
        UUID tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            UsersPage result = apiInstance.users(offset, limit, orderBy, role, name, email, phone, tenant, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#users");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[Role] *role = ; // Filter by role(s). (optional) (default to null)
String *name = name_example; // Filter by user name. (optional) (default to null)
String *email = email_example; // Filter by user email address. (optional) (default to null)
String *phone = phone_example; // Filter by user phone number. (optional) (default to null)
UUID *tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant. (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance usersWith:offset
    limit:limit
    orderBy:orderBy
    role:role
    name:name
    email:email
    phone:phone
    tenant:tenant
    searchText:searchText
              completionHandler: ^(UsersPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'role': , // {array[Role]} Filter by role(s).
  'name': name_example, // {String} Filter by user name.
  'email': email_example, // {String} Filter by user email address.
  'phone': phone_example, // {String} Filter by user phone number.
  'tenant': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {UUID} Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var role = new array[Role](); // array[Role] | Filter by role(s). (optional)  (default to null)
            var name = name_example;  // String | Filter by user name. (optional)  (default to null)
            var email = email_example;  // String | Filter by user email address. (optional)  (default to null)
            var phone = phone_example;  // String | Filter by user phone number. (optional)  (default to null)
            var tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant. (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                UsersPage result = apiInstance.users(offset, limit, orderBy, role, name, email, phone, tenant, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.users: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$role = ; // array[Role] | Filter by role(s).
$name = name_example; // String | Filter by user name.
$email = email_example; // String | Filter by user email address.
$phone = phone_example; // String | Filter by user phone number.
$tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->users($offset, $limit, $orderBy, $role, $name, $email, $phone, $tenant, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->users: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UsersApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $role = []; # array[Role] | Filter by role(s).
my $name = name_example; # String | Filter by user name.
my $email = email_example; # String | Filter by user email address.
my $phone = phone_example; # String | Filter by user phone number.
my $tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->users(offset => $offset, limit => $limit, orderBy => $orderBy, role => $role, name => $name, email => $email, phone => $phone, tenant => $tenant, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->users: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
role =  # array[Role] | Filter by role(s). (optional) (default to null)
name = name_example # String | Filter by user name. (optional) (default to null)
email = email_example # String | Filter by user email address. (optional) (default to null)
phone = phone_example # String | Filter by user phone number. (optional) (default to null)
tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant. (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.users(offset=offset, limit=limit, orderBy=orderBy, role=role, name=name, email=email, phone=phone, tenant=tenant, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->users: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let role = ; // array[Role]
    let name = name_example; // String
    let email = email_example; // String
    let phone = phone_example; // String
    let tenant = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let searchText = searchText_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.users(offset, limit, orderBy, role, name, email, phone, tenant, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
role
array[Role]
Filter by role(s).
name
String
Filter by user name.
email
String
Filter by user email address.
phone
String
Filter by user phone number.
tenant
UUID (uuid)
Filter by tenant's UUID. It will filter out users that doesn't have any role associated with given tenant.
searchText
String
Filter: match by name or address.

Responses


usersById

Get a batch of user objects


/user/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/user/batch?allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

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

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

        // Create an instance of the API class
        UsersApi apiInstance = new UsersApi();
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[UserOrError] result = apiInstance.usersById(allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UsersApi;

public class UsersApiExample {
    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[UserOrError] result = apiInstance.usersById(allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#usersById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
UsersApi *apiInstance = [[UsersApi alloc] init];
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance usersByIdWith:allOrNothing
    ids:ids
              completionHandler: ^(array[UserOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.UsersApi()
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new UsersApi();
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[UserOrError] result = apiInstance.usersById(allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UsersApi.usersById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UsersApi();
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UsersApi->new();
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.UsersApi()
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.users_by_id(allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->usersById: %s\n" % e)
extern crate UsersApi;

pub fn main() {
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = UsersApi::Context::default();
    let result = client.usersById(allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses


Vehicles

vehicleBatchDelete

Delete a batch of vehicles


/vehicle/batch

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/vehicle/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.vehicleBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleBatchDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        BatchDeleteRequest batchDeleteRequest = ; // BatchDeleteRequest | 

        try {
            apiInstance.vehicleBatchDelete(tenantId, batchDeleteRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleBatchDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
BatchDeleteRequest *batchDeleteRequest = ; //  (optional)

[apiInstance vehicleBatchDeleteWith:tenantId
    batchDeleteRequest:batchDeleteRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'batchDeleteRequest':  // {BatchDeleteRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var batchDeleteRequest = new BatchDeleteRequest(); // BatchDeleteRequest |  (optional) 

            try {
                apiInstance.vehicleBatchDelete(tenantId, batchDeleteRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleBatchDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$batchDeleteRequest = ; // BatchDeleteRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $batchDeleteRequest = WWW::OPenAPIClient::Object::BatchDeleteRequest->new(); # BatchDeleteRequest | 

eval {
    $api_instance->vehicleBatchDelete(tenantId => $tenantId, batchDeleteRequest => $batchDeleteRequest);
};
if ($@) {
    warn "Exception when calling VehiclesApi->vehicleBatchDelete: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
batchDeleteRequest =  # BatchDeleteRequest |  (optional)

try:
    api_instance.vehicle_batch_delete(tenantId, batchDeleteRequest=batchDeleteRequest)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleBatchDelete: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let batchDeleteRequest = ; // BatchDeleteRequest

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleBatchDelete(tenantId, batchDeleteRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
batchDeleteRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


vehicleBatchUpdate

Update a batch of vehicles


/vehicle/batch

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/vehicle/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "versions" : [ "versions", "versions" ],
  "vehicleArgs" : {
    "startingPointId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "driverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "depotId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "attributes" : "attributes",
    "workingTimeStart" : "workingTimeStart",
    "workingTimeEnd" : "workingTimeEnd"
  },
  "allOrNothing" : true,
  "ids" : [ "ids", "ids" ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleBatchUpdateRequest vehicleBatchUpdateRequest = ; // VehicleBatchUpdateRequest | 

        try {
            array[VehicleOrError] result = apiInstance.vehicleBatchUpdate(tenantId, vehicleBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleBatchUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleBatchUpdateRequest vehicleBatchUpdateRequest = ; // VehicleBatchUpdateRequest | 

        try {
            array[VehicleOrError] result = apiInstance.vehicleBatchUpdate(tenantId, vehicleBatchUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleBatchUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
VehicleBatchUpdateRequest *vehicleBatchUpdateRequest = ; //  (optional)

[apiInstance vehicleBatchUpdateWith:tenantId
    vehicleBatchUpdateRequest:vehicleBatchUpdateRequest
              completionHandler: ^(array[VehicleOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'vehicleBatchUpdateRequest':  // {VehicleBatchUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var vehicleBatchUpdateRequest = new VehicleBatchUpdateRequest(); // VehicleBatchUpdateRequest |  (optional) 

            try {
                array[VehicleOrError] result = apiInstance.vehicleBatchUpdate(tenantId, vehicleBatchUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleBatchUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$vehicleBatchUpdateRequest = ; // VehicleBatchUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $vehicleBatchUpdateRequest = WWW::OPenAPIClient::Object::VehicleBatchUpdateRequest->new(); # VehicleBatchUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
vehicleBatchUpdateRequest =  # VehicleBatchUpdateRequest |  (optional)

try:
    api_response = api_instance.vehicle_batch_update(tenantId, vehicleBatchUpdateRequest=vehicleBatchUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleBatchUpdate: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vehicleBatchUpdateRequest = ; // VehicleBatchUpdateRequest

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleBatchUpdate(tenantId, vehicleBatchUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
vehicleBatchUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


vehicleById

Get vehicle object


/vehicle

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/vehicle?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Vehicle result = apiInstance.vehicleById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            Vehicle result = apiInstance.vehicleById(tenantId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance vehicleByIdWith:tenantId
    id:id
              completionHandler: ^(Vehicle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_response = api_instance.vehicle_by_id(tenantId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleById: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleById(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


vehicleCreate

Create a vehicle


/vehicle

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/vehicle?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "vehicle" : {
    "startingPointId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "telematicsDeviceId" : "telematicsDeviceId",
    "driverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "depotId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "plate" : "plate",
    "attributes" : "attributes",
    "workingTimeStart" : "workingTimeStart",
    "workingTimeEnd" : "workingTimeEnd"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleCreateRequest vehicleCreateRequest = ; // VehicleCreateRequest | 

        try {
            Vehicle result = apiInstance.vehicleCreate(tenantId, vehicleCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleCreate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleCreateRequest vehicleCreateRequest = ; // VehicleCreateRequest | 

        try {
            Vehicle result = apiInstance.vehicleCreate(tenantId, vehicleCreateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleCreate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
VehicleCreateRequest *vehicleCreateRequest = ; //  (optional)

[apiInstance vehicleCreateWith:tenantId
    vehicleCreateRequest:vehicleCreateRequest
              completionHandler: ^(Vehicle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'vehicleCreateRequest':  // {VehicleCreateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var vehicleCreateRequest = new VehicleCreateRequest(); // VehicleCreateRequest |  (optional) 

            try {
                Vehicle result = apiInstance.vehicleCreate(tenantId, vehicleCreateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$vehicleCreateRequest = ; // VehicleCreateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $vehicleCreateRequest = WWW::OPenAPIClient::Object::VehicleCreateRequest->new(); # VehicleCreateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
vehicleCreateRequest =  # VehicleCreateRequest |  (optional)

try:
    api_response = api_instance.vehicle_create(tenantId, vehicleCreateRequest=vehicleCreateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleCreate: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vehicleCreateRequest = ; // VehicleCreateRequest

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleCreate(tenantId, vehicleCreateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
vehicleCreateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


vehicleCreateBatch

Create a batch of vehicles


/vehicle/batch

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/vehicle/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true" \
 -d '{
  "vehicles" : [ {
    "startingPointId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "telematicsDeviceId" : "telematicsDeviceId",
    "driverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "depotId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "plate" : "plate",
    "attributes" : "attributes",
    "workingTimeStart" : "workingTimeStart",
    "workingTimeEnd" : "workingTimeEnd"
  }, {
    "startingPointId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "telematicsDeviceId" : "telematicsDeviceId",
    "driverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "depotId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "plate" : "plate",
    "attributes" : "attributes",
    "workingTimeStart" : "workingTimeStart",
    "workingTimeEnd" : "workingTimeEnd"
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        VehicleCreateBatchRequest vehicleCreateBatchRequest = ; // VehicleCreateBatchRequest | 

        try {
            array[VehicleOrError] result = apiInstance.vehicleCreateBatch(tenantId, allOrNothing, vehicleCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleCreateBatch");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        VehicleCreateBatchRequest vehicleCreateBatchRequest = ; // VehicleCreateBatchRequest | 

        try {
            array[VehicleOrError] result = apiInstance.vehicleCreateBatch(tenantId, allOrNothing, vehicleCreateBatchRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleCreateBatch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
VehicleCreateBatchRequest *vehicleCreateBatchRequest = ; //  (optional)

[apiInstance vehicleCreateBatchWith:tenantId
    allOrNothing:allOrNothing
    vehicleCreateBatchRequest:vehicleCreateBatchRequest
              completionHandler: ^(array[VehicleOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var opts = {
  'vehicleCreateBatchRequest':  // {VehicleCreateBatchRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var vehicleCreateBatchRequest = new VehicleCreateBatchRequest(); // VehicleCreateBatchRequest |  (optional) 

            try {
                array[VehicleOrError] result = apiInstance.vehicleCreateBatch(tenantId, allOrNothing, vehicleCreateBatchRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleCreateBatch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$vehicleCreateBatchRequest = ; // VehicleCreateBatchRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $vehicleCreateBatchRequest = WWW::OPenAPIClient::Object::VehicleCreateBatchRequest->new(); # VehicleCreateBatchRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
vehicleCreateBatchRequest =  # VehicleCreateBatchRequest |  (optional)

try:
    api_response = api_instance.vehicle_create_batch(tenantId, allOrNothing, vehicleCreateBatchRequest=vehicleCreateBatchRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleCreateBatch: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let vehicleCreateBatchRequest = ; // VehicleCreateBatchRequest

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleCreateBatch(tenantId, allOrNothing, vehicleCreateBatchRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
vehicleCreateBatchRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required

Responses


vehicleDelete

Delete a vehicle


/vehicle

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/vehicle?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&id=38400000-8cf0-11bd-b23e-10b96e4ef00d"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.vehicleDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleDelete");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        UUID id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

        try {
            apiInstance.vehicleDelete(tenantId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleDelete");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
UUID *id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of an object this request is related to. (default to null)

[apiInstance vehicleDeleteWith:tenantId
    id:id
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of an object this request is related to.

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var id = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of an object this request is related to. (default to null)

            try {
                apiInstance.vehicleDelete(tenantId, id);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of an object this request is related to.

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of an object this request is related to.

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
id = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of an object this request is related to. (default to null)

try:
    api_instance.vehicle_delete(tenantId, id)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleDelete: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleDelete(tenantId, id, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
id*
UUID (uuid)
The id of an object this request is related to.
Required

Responses


vehicleUpdate

Update a vehicle


/vehicle

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "https://rest.route2.aleet.co/vehicle?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d" \
 -d '{
  "vehicle" : {
    "startingPointId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "telematicsDeviceId" : "telematicsDeviceId",
    "depotId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "plate" : "plate",
    "version" : "version",
    "driverId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "name" : "name",
    "attributes" : "attributes",
    "id" : "id",
    "workingTimeStart" : "workingTimeStart",
    "workingTimeEnd" : "workingTimeEnd"
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleUpdateRequest vehicleUpdateRequest = ; // VehicleUpdateRequest | 

        try {
            Vehicle result = apiInstance.vehicleUpdate(tenantId, vehicleUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleUpdate");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        VehicleUpdateRequest vehicleUpdateRequest = ; // VehicleUpdateRequest | 

        try {
            Vehicle result = apiInstance.vehicleUpdate(tenantId, vehicleUpdateRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicleUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
VehicleUpdateRequest *vehicleUpdateRequest = ; //  (optional)

[apiInstance vehicleUpdateWith:tenantId
    vehicleUpdateRequest:vehicleUpdateRequest
              completionHandler: ^(Vehicle output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'vehicleUpdateRequest':  // {VehicleUpdateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var vehicleUpdateRequest = new VehicleUpdateRequest(); // VehicleUpdateRequest |  (optional) 

            try {
                Vehicle result = apiInstance.vehicleUpdate(tenantId, vehicleUpdateRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicleUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$vehicleUpdateRequest = ; // VehicleUpdateRequest | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $vehicleUpdateRequest = WWW::OPenAPIClient::Object::VehicleUpdateRequest->new(); # VehicleUpdateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
vehicleUpdateRequest =  # VehicleUpdateRequest |  (optional)

try:
    api_response = api_instance.vehicle_update(tenantId, vehicleUpdateRequest=vehicleUpdateRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicleUpdate: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let vehicleUpdateRequest = ; // VehicleUpdateRequest

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicleUpdate(tenantId, vehicleUpdateRequest, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
vehicleUpdateRequest

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required

Responses


vehicles

List vehicles with filtering/sorting options


/vehicle/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/vehicle/list?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&offset=56&limit=56&orderBy=orderBy_example&active=&depotName=&name=name_example&plate=plate_example&telematicsDeviceId=telematicsDeviceId_example&startingPointName=startingPointName_example&driverName=driverName_example&attributes=attributes_example&searchText=searchText_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.vehicles(tenantId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicles");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Integer offset = 56; // Integer | Index on the list to start with. Default 0.
        Integer limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
        String orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
        array[VehicleActivityStatus] active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
        array[String] depotName = ; // array[String] | Filter: list of depot names to match.
        String name = name_example; // String | Filter: match by vehicle name.
        String plate = plate_example; // String | Filter: match by vehicle registration plate.
        String telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
        String startingPointName = startingPointName_example; // String | Filter: match by starting point name.
        String driverName = driverName_example; // String | Filter: match by driver name.
        String attributes = attributes_example; // String | 
        String searchText = searchText_example; // String | Filter: match by name or address.

        try {
            VehiclesPage result = apiInstance.vehicles(tenantId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehicles");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Integer *offset = 56; // Index on the list to start with. Default 0. (optional) (default to null)
Integer *limit = 56; // Number of objects to return in a single list page. Default 10. (optional) (default to null)
String *orderBy = orderBy_example; // Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
array[VehicleActivityStatus] *active = ; // Filter: list of activity statuses to match. (optional) (default to null)
array[String] *depotName = ; // Filter: list of depot names to match. (optional) (default to null)
String *name = name_example; // Filter: match by vehicle name. (optional) (default to null)
String *plate = plate_example; // Filter: match by vehicle registration plate. (optional) (default to null)
String *telematicsDeviceId = telematicsDeviceId_example; // Filter: match by telematics device ID. (optional) (default to null)
String *startingPointName = startingPointName_example; // Filter: match by starting point name. (optional) (default to null)
String *driverName = driverName_example; // Filter: match by driver name. (optional) (default to null)
String *attributes = attributes_example; //  (optional) (default to null)
String *searchText = searchText_example; // Filter: match by name or address. (optional) (default to null)

[apiInstance vehiclesWith:tenantId
    offset:offset
    limit:limit
    orderBy:orderBy
    active:active
    depotName:depotName
    name:name
    plate:plate
    telematicsDeviceId:telematicsDeviceId
    startingPointName:startingPointName
    driverName:driverName
    attributes:attributes
    searchText:searchText
              completionHandler: ^(VehiclesPage output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var opts = {
  'offset': 56, // {Integer} Index on the list to start with. Default 0.
  'limit': 56, // {Integer} Number of objects to return in a single list page. Default 10.
  'orderBy': orderBy_example, // {String} Name of the field to sort the list by. Default is empty - no sorting.
  'active': , // {array[VehicleActivityStatus]} Filter: list of activity statuses to match.
  'depotName': , // {array[String]} Filter: list of depot names to match.
  'name': name_example, // {String} Filter: match by vehicle name.
  'plate': plate_example, // {String} Filter: match by vehicle registration plate.
  'telematicsDeviceId': telematicsDeviceId_example, // {String} Filter: match by telematics device ID.
  'startingPointName': startingPointName_example, // {String} Filter: match by starting point name.
  'driverName': driverName_example, // {String} Filter: match by driver name.
  'attributes': attributes_example, // {String} 
  'searchText': searchText_example // {String} Filter: match by name or address.
};

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var offset = 56;  // Integer | Index on the list to start with. Default 0. (optional)  (default to null)
            var limit = 56;  // Integer | Number of objects to return in a single list page. Default 10. (optional)  (default to null)
            var orderBy = orderBy_example;  // String | Name of the field to sort the list by. Default is empty - no sorting. (optional)  (default to null)
            var active = new array[VehicleActivityStatus](); // array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional)  (default to null)
            var depotName = new array[String](); // array[String] | Filter: list of depot names to match. (optional)  (default to null)
            var name = name_example;  // String | Filter: match by vehicle name. (optional)  (default to null)
            var plate = plate_example;  // String | Filter: match by vehicle registration plate. (optional)  (default to null)
            var telematicsDeviceId = telematicsDeviceId_example;  // String | Filter: match by telematics device ID. (optional)  (default to null)
            var startingPointName = startingPointName_example;  // String | Filter: match by starting point name. (optional)  (default to null)
            var driverName = driverName_example;  // String | Filter: match by driver name. (optional)  (default to null)
            var attributes = attributes_example;  // String |  (optional)  (default to null)
            var searchText = searchText_example;  // String | Filter: match by name or address. (optional)  (default to null)

            try {
                VehiclesPage result = apiInstance.vehicles(tenantId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehicles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$offset = 56; // Integer | Index on the list to start with. Default 0.
$limit = 56; // Integer | Number of objects to return in a single list page. Default 10.
$orderBy = orderBy_example; // String | Name of the field to sort the list by. Default is empty - no sorting.
$active = ; // array[VehicleActivityStatus] | Filter: list of activity statuses to match.
$depotName = ; // array[String] | Filter: list of depot names to match.
$name = name_example; // String | Filter: match by vehicle name.
$plate = plate_example; // String | Filter: match by vehicle registration plate.
$telematicsDeviceId = telematicsDeviceId_example; // String | Filter: match by telematics device ID.
$startingPointName = startingPointName_example; // String | Filter: match by starting point name.
$driverName = driverName_example; // String | Filter: match by driver name.
$attributes = attributes_example; // String | 
$searchText = searchText_example; // String | Filter: match by name or address.

try {
    $result = $api_instance->vehicles($tenantId, $offset, $limit, $orderBy, $active, $depotName, $name, $plate, $telematicsDeviceId, $startingPointName, $driverName, $attributes, $searchText);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VehiclesApi->vehicles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::VehiclesApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $offset = 56; # Integer | Index on the list to start with. Default 0.
my $limit = 56; # Integer | Number of objects to return in a single list page. Default 10.
my $orderBy = orderBy_example; # String | Name of the field to sort the list by. Default is empty - no sorting.
my $active = []; # array[VehicleActivityStatus] | Filter: list of activity statuses to match.
my $depotName = []; # array[String] | Filter: list of depot names to match.
my $name = name_example; # String | Filter: match by vehicle name.
my $plate = plate_example; # String | Filter: match by vehicle registration plate.
my $telematicsDeviceId = telematicsDeviceId_example; # String | Filter: match by telematics device ID.
my $startingPointName = startingPointName_example; # String | Filter: match by starting point name.
my $driverName = driverName_example; # String | Filter: match by driver name.
my $attributes = attributes_example; # String | 
my $searchText = searchText_example; # String | Filter: match by name or address.

eval {
    my $result = $api_instance->vehicles(tenantId => $tenantId, offset => $offset, limit => $limit, orderBy => $orderBy, active => $active, depotName => $depotName, name => $name, plate => $plate, telematicsDeviceId => $telematicsDeviceId, startingPointName => $startingPointName, driverName => $driverName, attributes => $attributes, searchText => $searchText);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VehiclesApi->vehicles: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
offset = 56 # Integer | Index on the list to start with. Default 0. (optional) (default to null)
limit = 56 # Integer | Number of objects to return in a single list page. Default 10. (optional) (default to null)
orderBy = orderBy_example # String | Name of the field to sort the list by. Default is empty - no sorting. (optional) (default to null)
active =  # array[VehicleActivityStatus] | Filter: list of activity statuses to match. (optional) (default to null)
depotName =  # array[String] | Filter: list of depot names to match. (optional) (default to null)
name = name_example # String | Filter: match by vehicle name. (optional) (default to null)
plate = plate_example # String | Filter: match by vehicle registration plate. (optional) (default to null)
telematicsDeviceId = telematicsDeviceId_example # String | Filter: match by telematics device ID. (optional) (default to null)
startingPointName = startingPointName_example # String | Filter: match by starting point name. (optional) (default to null)
driverName = driverName_example # String | Filter: match by driver name. (optional) (default to null)
attributes = attributes_example # String |  (optional) (default to null)
searchText = searchText_example # String | Filter: match by name or address. (optional) (default to null)

try:
    api_response = api_instance.vehicles(tenantId, offset=offset, limit=limit, orderBy=orderBy, active=active, depotName=depotName, name=name, plate=plate, telematicsDeviceId=telematicsDeviceId, startingPointName=startingPointName, driverName=driverName, attributes=attributes, searchText=searchText)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehicles: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let offset = 56; // Integer
    let limit = 56; // Integer
    let orderBy = orderBy_example; // String
    let active = ; // array[VehicleActivityStatus]
    let depotName = ; // array[String]
    let name = name_example; // String
    let plate = plate_example; // String
    let telematicsDeviceId = telematicsDeviceId_example; // String
    let startingPointName = startingPointName_example; // String
    let driverName = driverName_example; // String
    let attributes = attributes_example; // String
    let searchText = searchText_example; // String

    let mut context = VehiclesApi::Context::default();
    let result = client.vehicles(tenantId, offset, limit, orderBy, active, depotName, name, plate, telematicsDeviceId, startingPointName, driverName, attributes, searchText, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
offset
Integer
Index on the list to start with. Default 0.
limit
Integer
Number of objects to return in a single list page. Default 10.
orderBy
String
Name of the field to sort the list by. Default is empty - no sorting.
active
array[VehicleActivityStatus]
Filter: list of activity statuses to match.
depotName
array[String]
Filter: list of depot names to match.
name
String
Filter: match by vehicle name.
plate
String
Filter: match by vehicle registration plate.
telematicsDeviceId
String
Filter: match by telematics device ID.
startingPointName
String
Filter: match by starting point name.
driverName
String
Filter: match by driver name.
attributes
String
searchText
String
Filter: match by name or address.

Responses


vehiclesById

Get a batch of vehicle objects


/vehicle/batch

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://rest.route2.aleet.co/vehicle/batch?tenantId=38400000-8cf0-11bd-b23e-10b96e4ef00d&allOrNothing=true&ids=ids_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.VehiclesApi;

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

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

        // Create an instance of the API class
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[VehicleOrError] result = apiInstance.vehiclesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehiclesById");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.VehiclesApi;

public class VehiclesApiExample {
    public static void main(String[] args) {
        VehiclesApi apiInstance = new VehiclesApi();
        UUID tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
        Boolean allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
        String ids = ids_example; // String | 

        try {
            array[VehicleOrError] result = apiInstance.vehiclesById(tenantId, allOrNothing, ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VehiclesApi#vehiclesById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
VehiclesApi *apiInstance = [[VehiclesApi alloc] init];
UUID *tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // The id of the tenant this request is related to. (default to null)
Boolean *allOrNothing = true; // Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
String *ids = ids_example; //  (default to null)

[apiInstance vehiclesByIdWith:tenantId
    allOrNothing:allOrNothing
    ids:ids
              completionHandler: ^(array[VehicleOrError] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var Route2RestApi = require('route2_rest_api');

// Create an instance of the API class
var api = new Route2RestApi.VehiclesApi()
var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} The id of the tenant this request is related to.
var allOrNothing = true; // {Boolean} Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
var ids = ids_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new VehiclesApi();
            var tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d;  // UUID | The id of the tenant this request is related to. (default to null)
            var allOrNothing = true;  // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
            var ids = ids_example;  // String |  (default to null)

            try {
                array[VehicleOrError] result = apiInstance.vehiclesById(tenantId, allOrNothing, ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling VehiclesApi.vehiclesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\VehiclesApi();
$tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | The id of the tenant this request is related to.
$allOrNothing = true; // Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
$ids = ids_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::VehiclesApi->new();
my $tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | The id of the tenant this request is related to.
my $allOrNothing = true; # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
my $ids = ids_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.VehiclesApi()
tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | The id of the tenant this request is related to. (default to null)
allOrNothing = true # Boolean | Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result. (default to null)
ids = ids_example # String |  (default to null)

try:
    api_response = api_instance.vehicles_by_id(tenantId, allOrNothing, ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VehiclesApi->vehiclesById: %s\n" % e)
extern crate VehiclesApi;

pub fn main() {
    let tenantId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID
    let allOrNothing = true; // Boolean
    let ids = ids_example; // String

    let mut context = VehiclesApi::Context::default();
    let result = client.vehiclesById(tenantId, allOrNothing, ids, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
tenantId*
UUID (uuid)
The id of the tenant this request is related to.
Required
allOrNothing*
Boolean
Indicates what should happen on the first error during batch processing. True - processing is stopped, no changes are persisted. False - processing continues, persisting all possible changes, returning errors for each rejected entity in the result.
Required
ids*
String
Required

Responses