EVHC-CoWo API

Admins

Add Device

adds a device

Adds an item to the system


/device

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/device"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        DeviceItem body = ; // DeviceItem | Device to add
        try {
            apiInstance.addDevice(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#addDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        DeviceItem body = ; // DeviceItem | Device to add
        try {
            apiInstance.addDevice(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#addDevice");
            e.printStackTrace();
        }
    }
}
DeviceItem *body = ; // Device to add (optional)

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

// adds a device
[apiInstance addDeviceWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.AdminsApi()
var opts = { 
  'body':  // {{DeviceItem}} Device to add
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addDevice(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminsApi();
            var body = new DeviceItem(); // DeviceItem | Device to add (optional) 

            try
            {
                // adds a device
                apiInstance.addDevice(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.addDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminsApi();
$body = ; // DeviceItem | Device to add

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $body = WWW::SwaggerClient::Object::DeviceItem->new(); # DeviceItem | Device to add

eval { 
    $api_instance->addDevice(body => $body);
};
if ($@) {
    warn "Exception when calling AdminsApi->addDevice: $@\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.AdminsApi()
body =  # DeviceItem | Device to add (optional)

try: 
    # adds a device
    api_instance.add_device(body=body)
except ApiException as e:
    print("Exception when calling AdminsApi->addDevice: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 201 - device created

Status: 400 - invalid input, object invalid

Status: 409 - an existing device already exists


Delete Device

deletes a device

Deletes a device from the system


/device

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/device?deleteID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        String deleteID = deleteID_example; // String | pass a required ID string for deleting a device
        try {
            array[PosBaseResponse] result = apiInstance.deleteDevice(deleteID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#deleteDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        String deleteID = deleteID_example; // String | pass a required ID string for deleting a device
        try {
            array[PosBaseResponse] result = apiInstance.deleteDevice(deleteID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#deleteDevice");
            e.printStackTrace();
        }
    }
}
String *deleteID = deleteID_example; // pass a required ID string for deleting a device

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

// deletes a device
[apiInstance deleteDeviceWith:deleteID
              completionHandler: ^(array[PosBaseResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.AdminsApi()
var deleteID = deleteID_example; // {{String}} pass a required ID string for deleting a device

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

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

            var apiInstance = new AdminsApi();
            var deleteID = deleteID_example;  // String | pass a required ID string for deleting a device

            try
            {
                // deletes a device
                array[PosBaseResponse] result = apiInstance.deleteDevice(deleteID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.deleteDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminsApi();
$deleteID = deleteID_example; // String | pass a required ID string for deleting a device

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $deleteID = deleteID_example; # String | pass a required ID string for deleting a device

eval { 
    my $result = $api_instance->deleteDevice(deleteID => $deleteID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminsApi->deleteDevice: $@\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.AdminsApi()
deleteID = deleteID_example # String | pass a required ID string for deleting a device

try: 
    # deletes a device
    api_response = api_instance.delete_device(deleteID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->deleteDevice: %s\n" % e)

Parameters

Query parameters
Name Description
deleteID*
String
pass a required ID string for deleting a device
Required

Responses

Status: 200 - device deleted

Status: 401 - Unauthorised

Status: 404 - device ID not found


Update Device

updates a device

Updates a device in the system


/device

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/device"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminsApi;

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

public class AdminsApiExample {

    public static void main(String[] args) {
        
        AdminsApi apiInstance = new AdminsApi();
        DeviceItem body = ; // DeviceItem | Device to update
        try {
            array[PosBaseResponse] result = apiInstance.updateDevice(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AdminsApi;

public class AdminsApiExample {

    public static void main(String[] args) {
        AdminsApi apiInstance = new AdminsApi();
        DeviceItem body = ; // DeviceItem | Device to update
        try {
            array[PosBaseResponse] result = apiInstance.updateDevice(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminsApi#updateDevice");
            e.printStackTrace();
        }
    }
}
DeviceItem *body = ; // Device to update (optional)

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

// updates a device
[apiInstance updateDeviceWith:body
              completionHandler: ^(array[PosBaseResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.AdminsApi()
var opts = { 
  'body':  // {{DeviceItem}} Device to update
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDevice(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new AdminsApi();
            var body = new DeviceItem(); // DeviceItem | Device to update (optional) 

            try
            {
                // updates a device
                array[PosBaseResponse] result = apiInstance.updateDevice(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AdminsApi.updateDevice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAdminsApi();
$body = ; // DeviceItem | Device to update

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

my $api_instance = WWW::SwaggerClient::AdminsApi->new();
my $body = WWW::SwaggerClient::Object::DeviceItem->new(); # DeviceItem | Device to update

eval { 
    my $result = $api_instance->updateDevice(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AdminsApi->updateDevice: $@\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.AdminsApi()
body =  # DeviceItem | Device to update (optional)

try: 
    # updates a device
    api_response = api_instance.update_device(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdminsApi->updateDevice: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - device updated

Status: 400 - error updating device


Users

checkForAction

Called with the equipment ID to see if any vehicle needs to be serviced. If Yes, the VIN and equipment session ID is returned, equipment status is set to “In Use”. If No, the Success flag is set to true and VIN and equipment session ID are set to null.

Checks for the presence of a task


/checkForAction

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/checkForAction"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-in process
        try {
            array[PosCheckForActionResonse] result = apiInstance.checkForAction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#checkForAction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-in process
        try {
            array[PosCheckForActionResonse] result = apiInstance.checkForAction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#checkForAction");
            e.printStackTrace();
        }
    }
}
EquipmentBaseRequest *body = ; // Device sign-in process (optional)

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

// Called with the equipment ID to see if any vehicle needs to be serviced. If Yes, the VIN and equipment session ID is returned, equipment status is set to “In Use”. If No, the Success flag is set to true and VIN and equipment session ID are set to null.
[apiInstance checkForActionWith:body
              completionHandler: ^(array[PosCheckForActionResonse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.UsersApi()
var opts = { 
  'body':  // {{EquipmentBaseRequest}} Device sign-in process
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkForAction(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UsersApi();
            var body = new EquipmentBaseRequest(); // EquipmentBaseRequest | Device sign-in process (optional) 

            try
            {
                // Called with the equipment ID to see if any vehicle needs to be serviced. If Yes, the VIN and equipment session ID is returned, equipment status is set to “In Use”. If No, the Success flag is set to true and VIN and equipment session ID are set to null.
                array[PosCheckForActionResonse] result = apiInstance.checkForAction(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.checkForAction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // EquipmentBaseRequest | Device sign-in process

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::EquipmentBaseRequest->new(); # EquipmentBaseRequest | Device sign-in process

eval { 
    my $result = $api_instance->checkForAction(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->checkForAction: $@\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.UsersApi()
body =  # EquipmentBaseRequest | Device sign-in process (optional)

try: 
    # Called with the equipment ID to see if any vehicle needs to be serviced. If Yes, the VIN and equipment session ID is returned, equipment status is set to “In Use”. If No, the Success flag is set to true and VIN and equipment session ID are set to null.
    api_response = api_instance.check_for_action(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->checkForAction: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - good checkForAction response

Status: 400 - bad checkForAction response


device

lists available devices

By passing in the appropriate device ID, you can retrieve the device data


/device

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/device/[deviceId]"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String searchString = searchString_example; // String | pass an optional search string for looking up devices
        try {
            array[DeviceItem] result = apiInstance.searchDevices(searchString);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchDevices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String searchString = searchString_example; // String | pass an optional pass an optional device ID to retrieve device details
        try {
            array[DeviceItem] result = apiInstance.searchDevices(searchString);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#searchDevices");
            e.printStackTrace();
        }
    }
}
String *deviceId = searchString_example; // pass an optional device ID to retrieve device details (optional)

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

// lists available devices
[apiInstance searchDevicesWith:searchString
              completionHandler: ^(array[DeviceItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.UsersApi()
var opts = { 
  'searchString': searchString_example // {{String}} pass an optional search string for looking up devices
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchDevices(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UsersApi();
            var searchString = searchString_example;  // String | pass an optional search string for looking up devices (optional) 

            try
            {
                // lists available devices
                array[DeviceItem] result = apiInstance.searchDevices(searchString);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.searchDevices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUsersApi();
$searchString = searchString_example; // String | pass an optional search string for looking up devices

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $searchString = searchString_example; # String | pass an optional search string for looking up devices

eval { 
    my $result = $api_instance->searchDevices(searchString => $searchString);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->searchDevices: $@\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.UsersApi()
searchString = searchString_example # String | pass an optional search string for looking up devices (optional)

try: 
    # lists available devices
    api_response = api_instance.search_devices(searchString=searchString)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->searchDevices: %s\n" % e)

Parameters

Query parameters
Name Description
deviceId
String
pass an optional device ID to retrieve device specific details.

Responses

Status: 200 - search results matching criteria

Status: 400 - bad input parameter


sendFinalResults

performs the main equipment results return process

sends the equipment results data back to the system


/sendFinalResults

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/sendFinalResults"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        SendResultsRequest body = ; // SendResultsRequest | send final results process
        try {
            array[PosBaseResponse] result = apiInstance.sendFinalResults(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#sendFinalResults");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        SendResultsRequest body = ; // SendResultsRequest | send final results process
        try {
            array[PosBaseResponse] result = apiInstance.sendFinalResults(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#sendFinalResults");
            e.printStackTrace();
        }
    }
}
SendResultsRequest *body = ; // send final results process (optional)

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

// performs the main equipment results return process
[apiInstance sendFinalResultsWith:body
              completionHandler: ^(array[PosBaseResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.UsersApi()
var opts = { 
  'body':  // {{SendResultsRequest}} send final results process
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.sendFinalResults(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UsersApi();
            var body = new SendResultsRequest(); // SendResultsRequest | send final results process (optional) 

            try
            {
                // performs the main equipment results return process
                array[PosBaseResponse] result = apiInstance.sendFinalResults(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.sendFinalResults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // SendResultsRequest | send final results process

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::SendResultsRequest->new(); # SendResultsRequest | send final results process

eval { 
    my $result = $api_instance->sendFinalResults(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->sendFinalResults: $@\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.UsersApi()
body =  # SendResultsRequest | send final results process (optional)

try: 
    # performs the main equipment results return process
    api_response = api_instance.send_final_results(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->sendFinalResults: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - good results response

Status: 400 - bad results response


signIn

performs a device sign-in process

Signs a device in to the system


/signIn

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/signIn"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-in process
        try {
            array[PosBaseResponse] result = apiInstance.signIn(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#signIn");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-in process
        try {
            array[PosBaseResponse] result = apiInstance.signIn(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#signIn");
            e.printStackTrace();
        }
    }
}
EquipmentBaseRequest *body = ; // Device sign-in process (optional)

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

// performs a device sign-in process
[apiInstance signInWith:body
              completionHandler: ^(array[PosBaseResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.UsersApi()
var opts = { 
  'body':  // {{EquipmentBaseRequest}} Device sign-in process
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signIn(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UsersApi();
            var body = new EquipmentBaseRequest(); // EquipmentBaseRequest | Device sign-in process (optional) 

            try
            {
                // performs a device sign-in process
                array[PosBaseResponse] result = apiInstance.signIn(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.signIn: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // EquipmentBaseRequest | Device sign-in process

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::EquipmentBaseRequest->new(); # EquipmentBaseRequest | Device sign-in process

eval { 
    my $result = $api_instance->signIn(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->signIn: $@\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.UsersApi()
body =  # EquipmentBaseRequest | Device sign-in process (optional)

try: 
    # performs a device sign-in process
    api_response = api_instance.sign_in(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->signIn: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - good sign-in response

Status: 400 - bad sign-in response


signOff

performs a device sign-off process

Signs a device off from the system


/signOff

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"https://virtserver.swaggerhub.com/jdraper/EVHC_CoWo/1.0.0/signOff"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-off process
        try {
            array[PosBaseResponse] result = apiInstance.signOff(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#signOff");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        EquipmentBaseRequest body = ; // EquipmentBaseRequest | Device sign-off process
        try {
            array[PosBaseResponse] result = apiInstance.signOff(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#signOff");
            e.printStackTrace();
        }
    }
}
EquipmentBaseRequest *body = ; // Device sign-off process (optional)

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

// performs a device sign-off process
[apiInstance signOffWith:body
              completionHandler: ^(array[PosBaseResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EvhcCoWoApi = require('evhc_co_wo_api');

var api = new EvhcCoWoApi.UsersApi()
var opts = { 
  'body':  // {{EquipmentBaseRequest}} Device sign-off process
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.signOff(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new UsersApi();
            var body = new EquipmentBaseRequest(); // EquipmentBaseRequest | Device sign-off process (optional) 

            try
            {
                // performs a device sign-off process
                array[PosBaseResponse] result = apiInstance.signOff(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.signOff: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiUsersApi();
$body = ; // EquipmentBaseRequest | Device sign-off process

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

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $body = WWW::SwaggerClient::Object::EquipmentBaseRequest->new(); # EquipmentBaseRequest | Device sign-off process

eval { 
    my $result = $api_instance->signOff(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->signOff: $@\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.UsersApi()
body =  # EquipmentBaseRequest | Device sign-off process (optional)

try: 
    # performs a device sign-off process
    api_response = api_instance.sign_off(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->signOff: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - good sign-off response

Status: 400 - bad sign-off response