ODE REST API

Default

getVersion

Get ODE version info

Get ODE Version info


/version

Usage and SDK Samples

curl -X GET "https://yourhostname/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            versionResponse result = apiInstance.getVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            versionResponse result = apiInstance.getVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getVersion");
            e.printStackTrace();
        }
    }
}

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

// Get ODE version info
[apiInstance getVersionWithCompletionHandler: 
              ^(versionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVersion(callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVersionExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // Get ODE version info
                versionResponse result = apiInstance.getVersion();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getVersion: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();

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

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

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

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try: 
    # Get ODE version info
    api_response = api_instance.get_version()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->getVersion: %s\n" % e)

Parameters

Responses

Status: 200 - ODE version information returned

LogFile

uploadObulog

File upload interface

Uploads an OBU log file to ODE upload folder to be processed and propaged


/upload/obulog

Usage and SDK Samples

curl -X POST "https://yourhostname/upload/obulog"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LogFileApi;

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

public class LogFileApiExample {

    public static void main(String[] args) {
        
        LogFileApi apiInstance = new LogFileApi();
        File file = /path/to/file.txt; // File | The file to upload.
        try {
            array[Status] result = apiInstance.uploadObulog(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogFileApi#uploadObulog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LogFileApi;

public class LogFileApiExample {

    public static void main(String[] args) {
        LogFileApi apiInstance = new LogFileApi();
        File file = /path/to/file.txt; // File | The file to upload.
        try {
            array[Status] result = apiInstance.uploadObulog(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LogFileApi#uploadObulog");
            e.printStackTrace();
        }
    }
}
File *file = /path/to/file.txt; // The file to upload. (optional)

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

// File upload interface
[apiInstance uploadObulogWith:file
              completionHandler: ^(array[Status] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.LogFileApi()

var opts = { 
  'file': /path/to/file.txt // {File} The file to upload.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadObulog(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadObulogExample
    {
        public void main()
        {
            
            var apiInstance = new LogFileApi();
            var file = new File(); // File | The file to upload. (optional) 

            try
            {
                // File upload interface
                array[Status] result = apiInstance.uploadObulog(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LogFileApi.uploadObulog: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LogFileApi();
$file = /path/to/file.txt; // File | The file to upload.

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

my $api_instance = WWW::SwaggerClient::LogFileApi->new();
my $file = /path/to/file.txt; # File | The file to upload.

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

# create an instance of the API class
api_instance = swagger_client.LogFileApi()
file = /path/to/file.txt # File | The file to upload. (optional)

try: 
    # File upload interface
    api_response = api_instance.upload_obulog(file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LogFileApi->uploadObulog: %s\n" % e)

Parameters

Form parameters
Name Description
file
File
The file to upload.

Responses

Status: 200 - File uploaded successfully

Status: 400 - Bad Request. Issued if request is invalid or failed to be executed. See the response body or ODE User Guide for details.

Status: 500 - Internal Server Error. See the response body or ODE User Guide for details.

PDM

pdmPost

PDM Interface

Submits a Probe Data Management message to ODE for distribution to the specified RSUs.


/pdm

Usage and SDK Samples

curl -X POST "https://yourhostname/pdm"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PDMApi;

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

public class PDMApiExample {

    public static void main(String[] args) {
        
        PDMApi apiInstance = new PDMApi();
        ProbeDataManagement probeDataManagement = ; // ProbeDataManagement | PDM Message
        try {
            array[Status] result = apiInstance.pdmPost(probeDataManagement);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PDMApi#pdmPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PDMApi;

public class PDMApiExample {

    public static void main(String[] args) {
        PDMApi apiInstance = new PDMApi();
        ProbeDataManagement probeDataManagement = ; // ProbeDataManagement | PDM Message
        try {
            array[Status] result = apiInstance.pdmPost(probeDataManagement);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PDMApi#pdmPost");
            e.printStackTrace();
        }
    }
}
ProbeDataManagement *probeDataManagement = ; // PDM Message

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

// PDM Interface
[apiInstance pdmPostWith:probeDataManagement
              completionHandler: ^(array[Status] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.PDMApi()

var probeDataManagement = ; // {ProbeDataManagement} PDM Message


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdmPost(probeDataManagement, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pdmPostExample
    {
        public void main()
        {
            
            var apiInstance = new PDMApi();
            var probeDataManagement = new ProbeDataManagement(); // ProbeDataManagement | PDM Message

            try
            {
                // PDM Interface
                array[Status] result = apiInstance.pdmPost(probeDataManagement);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PDMApi.pdmPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\PDMApi();
$probeDataManagement = ; // ProbeDataManagement | PDM Message

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

my $api_instance = WWW::SwaggerClient::PDMApi->new();
my $probeDataManagement = WWW::SwaggerClient::Object::ProbeDataManagement->new(); # ProbeDataManagement | PDM Message

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

# create an instance of the API class
api_instance = swagger_client.PDMApi()
probeDataManagement =  # ProbeDataManagement | PDM Message

try: 
    # PDM Interface
    api_response = api_instance.pdm_post(probeDataManagement)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PDMApi->pdmPost: %s\n" % e)

Parameters

Body parameters
Name Description
probeDataManagement *

Responses

Status: 200 - Probe Data Management message was submitted successfully. See the response body or ODE User Guide for details.

Status: 400 - Bad Request. Issued if request is invalid or failed to be executed. See the response body or ODE User Guide for details.

Status: 500 - Internal Server Error. See the response body or ODE User Guide for details.

SNMP

snmpGet

RSU SNMP Query

Check the health and status of RSU devices through SNMP communication. You should receive a detailed plain text response that looks like the following example. If the device is off, a 4 second timeout will occur and the ODE will indicate this with an "[ERROR] Empty response" message. (This specific OID returns the amount of time since the device was last powered on) "[1.3.6.1.2.1.1.3.0 = 0:05:12.59]"


/rsuHeartbeat

Usage and SDK Samples

curl -X GET "https://yourhostname/rsuHeartbeat?ip=&oid="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SNMPApi;

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

public class SNMPApiExample {

    public static void main(String[] args) {
        
        SNMPApi apiInstance = new SNMPApi();
        BigDecimal ip = 8.14; // BigDecimal | IP address of an RSU
        BigDecimal oid = 8.14; // BigDecimal | OID of the attribute you wish to check on
        try {
            Status result = apiInstance.snmpGet(ip, oid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SNMPApi#snmpGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SNMPApi;

public class SNMPApiExample {

    public static void main(String[] args) {
        SNMPApi apiInstance = new SNMPApi();
        BigDecimal ip = 8.14; // BigDecimal | IP address of an RSU
        BigDecimal oid = 8.14; // BigDecimal | OID of the attribute you wish to check on
        try {
            Status result = apiInstance.snmpGet(ip, oid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SNMPApi#snmpGet");
            e.printStackTrace();
        }
    }
}
BigDecimal *ip = 8.14; // IP address of an RSU
BigDecimal *oid = 8.14; // OID of the attribute you wish to check on

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

// RSU SNMP Query
[apiInstance snmpGetWith:ip
    oid:oid
              completionHandler: ^(Status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.SNMPApi()

var ip = 8.14; // {BigDecimal} IP address of an RSU

var oid = 8.14; // {BigDecimal} OID of the attribute you wish to check on


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.snmpGet(ip, oid, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class snmpGetExample
    {
        public void main()
        {
            
            var apiInstance = new SNMPApi();
            var ip = 8.14;  // BigDecimal | IP address of an RSU
            var oid = 8.14;  // BigDecimal | OID of the attribute you wish to check on

            try
            {
                // RSU SNMP Query
                Status result = apiInstance.snmpGet(ip, oid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SNMPApi.snmpGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SNMPApi();
$ip = 8.14; // BigDecimal | IP address of an RSU
$oid = 8.14; // BigDecimal | OID of the attribute you wish to check on

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

my $api_instance = WWW::SwaggerClient::SNMPApi->new();
my $ip = 8.14; # BigDecimal | IP address of an RSU
my $oid = 8.14; # BigDecimal | OID of the attribute you wish to check on

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

# create an instance of the API class
api_instance = swagger_client.SNMPApi()
ip = 8.14 # BigDecimal | IP address of an RSU
oid = 8.14 # BigDecimal | OID of the attribute you wish to check on

try: 
    # RSU SNMP Query
    api_response = api_instance.snmp_get(ip, oid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SNMPApi->snmpGet: %s\n" % e)

Parameters

Query parameters
Name Description
ip*
BigDecimal (string)
IP address of an RSU
Required
oid*
BigDecimal (string)
OID of the attribute you wish to check on
Required

Responses

Status: 200 - OID responses

Status: 400 - Value input error

TIM

timDelete

Delete a TIM message on an RSU.

Sets the status of a designated message index on an RSU to 6.


/tim

Usage and SDK Samples

curl -X DELETE "https://yourhostname/tim?index="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TIMApi;

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

public class TIMApiExample {

    public static void main(String[] args) {
        
        TIMApi apiInstance = new TIMApi();
        BigDecimal index = 8.14; // BigDecimal | Index of message to be deleted
        try {
            Status result = apiInstance.timDelete(index);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TIMApi;

public class TIMApiExample {

    public static void main(String[] args) {
        TIMApi apiInstance = new TIMApi();
        BigDecimal index = 8.14; // BigDecimal | Index of message to be deleted
        try {
            Status result = apiInstance.timDelete(index);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timDelete");
            e.printStackTrace();
        }
    }
}
BigDecimal *index = 8.14; // Index of message to be deleted

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

// Delete a TIM message on an RSU.
[apiInstance timDeleteWith:index
              completionHandler: ^(Status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.TIMApi()

var index = 8.14; // {BigDecimal} Index of message to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.timDelete(index, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class timDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new TIMApi();
            var index = 8.14;  // BigDecimal | Index of message to be deleted

            try
            {
                // Delete a TIM message on an RSU.
                Status result = apiInstance.timDelete(index);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TIMApi.timDelete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TIMApi();
$index = 8.14; // BigDecimal | Index of message to be deleted

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

my $api_instance = WWW::SwaggerClient::TIMApi->new();
my $index = 8.14; # BigDecimal | Index of message to be deleted

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

# create an instance of the API class
api_instance = swagger_client.TIMApi()
index = 8.14 # BigDecimal | Index of message to be deleted

try: 
    # Delete a TIM message on an RSU.
    api_response = api_instance.tim_delete(index)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TIMApi->timDelete: %s\n" % e)

Parameters

Query parameters
Name Description
index*
BigDecimal (integer)
Index of message to be deleted
Required

Responses

Status: 200 - Deleted index

Status: 400 - Error in body request

Status: 408 - Timeout

Status: 500 - Misc error

timPost

Submit Traveler Information Message (TIM) for broadcast to Connected Vehicles.

Submits a TIM message to ODE for distribution to the specified RSUs and SDW.


/tim

Usage and SDK Samples

curl -X POST "https://yourhostname/tim"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TIMApi;

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

public class TIMApiExample {

    public static void main(String[] args) {
        
        TIMApi apiInstance = new TIMApi();
        TravelerInputData travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.
        try {
            array[Status] result = apiInstance.timPost(travelerInputData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TIMApi;

public class TIMApiExample {

    public static void main(String[] args) {
        TIMApi apiInstance = new TIMApi();
        TravelerInputData travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.
        try {
            array[Status] result = apiInstance.timPost(travelerInputData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timPost");
            e.printStackTrace();
        }
    }
}
TravelerInputData *travelerInputData = ; // Message containing the parameters for a Traveler Information Message including delivery information.

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

// Submit Traveler Information Message (TIM) for broadcast to Connected Vehicles.
[apiInstance timPostWith:travelerInputData
              completionHandler: ^(array[Status] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.TIMApi()

var travelerInputData = ; // {TravelerInputData} Message containing the parameters for a Traveler Information Message including delivery information.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.timPost(travelerInputData, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class timPostExample
    {
        public void main()
        {
            
            var apiInstance = new TIMApi();
            var travelerInputData = new TravelerInputData(); // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

            try
            {
                // Submit Traveler Information Message (TIM) for broadcast to Connected Vehicles.
                array[Status] result = apiInstance.timPost(travelerInputData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TIMApi.timPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TIMApi();
$travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

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

my $api_instance = WWW::SwaggerClient::TIMApi->new();
my $travelerInputData = WWW::SwaggerClient::Object::TravelerInputData->new(); # TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

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

# create an instance of the API class
api_instance = swagger_client.TIMApi()
travelerInputData =  # TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

try: 
    # Submit Traveler Information Message (TIM) for broadcast to Connected Vehicles.
    api_response = api_instance.tim_post(travelerInputData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TIMApi->timPost: %s\n" % e)

Parameters

Body parameters
Name Description
travelerInputData *

Responses

Status: 200 - Traveleer Information Message was submitted successfully. See the response body or ODE User Guide for details.

Status: 400 - Bad Request. Issued if request is invalid or failed to be executed. See the response body or ODE User Guide for details.

Status: 500 - Internal Server Error. See the response body or ODE User Guide for details.

timPut

Used to update an existing TIM already present on an RSU.

Update a Traveler Information Message (TIM) that has already been deposited to an RSU. Parameters and response codes are identical to the POST request. Will also deposit the new message to the SDW, if the SDW field is present.


/tim

Usage and SDK Samples

curl -X PUT "https://yourhostname/tim"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TIMApi;

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

public class TIMApiExample {

    public static void main(String[] args) {
        
        TIMApi apiInstance = new TIMApi();
        TravelerInputData travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.
        try {
            array[Status] result = apiInstance.timPut(travelerInputData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timPut");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TIMApi;

public class TIMApiExample {

    public static void main(String[] args) {
        TIMApi apiInstance = new TIMApi();
        TravelerInputData travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.
        try {
            array[Status] result = apiInstance.timPut(travelerInputData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timPut");
            e.printStackTrace();
        }
    }
}
TravelerInputData *travelerInputData = ; // Message containing the parameters for a Traveler Information Message including delivery information.

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

// Used to update an existing TIM already present on an RSU.
[apiInstance timPutWith:travelerInputData
              completionHandler: ^(array[Status] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.TIMApi()

var travelerInputData = ; // {TravelerInputData} Message containing the parameters for a Traveler Information Message including delivery information.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.timPut(travelerInputData, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class timPutExample
    {
        public void main()
        {
            
            var apiInstance = new TIMApi();
            var travelerInputData = new TravelerInputData(); // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

            try
            {
                // Used to update an existing TIM already present on an RSU.
                array[Status] result = apiInstance.timPut(travelerInputData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TIMApi.timPut: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TIMApi();
$travelerInputData = ; // TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

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

my $api_instance = WWW::SwaggerClient::TIMApi->new();
my $travelerInputData = WWW::SwaggerClient::Object::TravelerInputData->new(); # TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

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

# create an instance of the API class
api_instance = swagger_client.TIMApi()
travelerInputData =  # TravelerInputData | Message containing the parameters for a Traveler Information Message including delivery information.

try: 
    # Used to update an existing TIM already present on an RSU.
    api_response = api_instance.tim_put(travelerInputData)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TIMApi->timPut: %s\n" % e)

Parameters

Body parameters
Name Description
travelerInputData *

Responses

Status: 200 - Traveleer Information Message was submitted successfully. See the response body or ODE User Guide for details.

Status: 400 - Bad Request. Issued if request is invalid or failed to be executed. See the response body or ODE User Guide for details.

Status: 500 - Internal Server Error. See the response body or ODE User Guide for details.

timQuery

Query an RSU for set TIMs

Query an RSU for set TIMs


/tim/query

Usage and SDK Samples

curl -X POST "https://yourhostname/tim/query"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TIMApi;

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

public class TIMApiExample {

    public static void main(String[] args) {
        
        TIMApi apiInstance = new TIMApi();
        RSU rSU = ; // RSU | 
        try {
            Status result = apiInstance.timQuery(rSU);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timQuery");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TIMApi;

public class TIMApiExample {

    public static void main(String[] args) {
        TIMApi apiInstance = new TIMApi();
        RSU rSU = ; // RSU | 
        try {
            Status result = apiInstance.timQuery(rSU);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TIMApi#timQuery");
            e.printStackTrace();
        }
    }
}
RSU *rSU = ; // 

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

// Query an RSU for set TIMs
[apiInstance timQueryWith:rSU
              completionHandler: ^(Status output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var OdeRestApi = require('ode_rest_api');

var api = new OdeRestApi.TIMApi()

var rSU = ; // {RSU} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.timQuery(rSU, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class timQueryExample
    {
        public void main()
        {
            
            var apiInstance = new TIMApi();
            var rSU = new RSU(); // RSU | 

            try
            {
                // Query an RSU for set TIMs
                Status result = apiInstance.timQuery(rSU);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TIMApi.timQuery: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TIMApi();
$rSU = ; // RSU | 

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

my $api_instance = WWW::SwaggerClient::TIMApi->new();
my $rSU = WWW::SwaggerClient::Object::RSU->new(); # RSU | 

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

# create an instance of the API class
api_instance = swagger_client.TIMApi()
rSU =  # RSU | 

try: 
    # Query an RSU for set TIMs
    api_response = api_instance.tim_query(rSU)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TIMApi->timQuery: %s\n" % e)

Parameters

Body parameters
Name Description
rSU *

Responses

Status: 200 - List of messages in JSON form

Status: 400 - Error in body request

Status: 408 - Timeout

Status: 500 - Misc error