AVMG Public API

Developers

getInspections

Get the inspections list

Get the inspections list within a date range (e.g., ?startdate=2024-08-28T22:07:17.0284430Z&enddate=2024-09-28T22:07:17.0284430Z). 


/inspections

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/i1196/AVMG_Public_API/1.0.0/inspections?startdate=&enddate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevelopersApi;

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

public class DevelopersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DevelopersApi apiInstance = new DevelopersApi();
        Date startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
        Date enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)
        try {
            array[InspectionsResponse] result = apiInstance.getInspections(startdate, enddate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevelopersApi#getInspections");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevelopersApi;

public class DevelopersApiExample {

    public static void main(String[] args) {
        DevelopersApi apiInstance = new DevelopersApi();
        Date startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
        Date enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)
        try {
            array[InspectionsResponse] result = apiInstance.getInspections(startdate, enddate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevelopersApi#getInspections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Date *startdate = 2013-10-20T19:20:30+01:00; // Pass the initial date (ISO 8601 format)
Date *enddate = 2013-10-20T19:20:30+01:00; // Pass the final date (ISO 8601 format)

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

// Get the inspections list
[apiInstance getInspectionsWith:startdate
    enddate:enddate
              completionHandler: ^(array[InspectionsResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AvmgPublicApi = require('avmg_public_api');
var defaultClient = AvmgPublicApi.ApiClient.instance;


var api = new AvmgPublicApi.DevelopersApi()
var startdate = 2013-10-20T19:20:30+01:00; // {{Date}} Pass the initial date (ISO 8601 format)
var enddate = 2013-10-20T19:20:30+01:00; // {{Date}} Pass the final date (ISO 8601 format)

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

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

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


            var apiInstance = new DevelopersApi();
            var startdate = 2013-10-20T19:20:30+01:00;  // Date | Pass the initial date (ISO 8601 format)
            var enddate = 2013-10-20T19:20:30+01:00;  // Date | Pass the final date (ISO 8601 format)

            try
            {
                // Get the inspections list
                array[InspectionsResponse] result = apiInstance.getInspections(startdate, enddate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevelopersApi.getInspections: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiDevelopersApi();
$startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
$enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)

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


my $api_instance = WWW::SwaggerClient::DevelopersApi->new();
my $startdate = 2013-10-20T19:20:30+01:00; # Date | Pass the initial date (ISO 8601 format)
my $enddate = 2013-10-20T19:20:30+01:00; # Date | Pass the final date (ISO 8601 format)

eval { 
    my $result = $api_instance->getInspections(startdate => $startdate, enddate => $enddate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevelopersApi->getInspections: $@\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.DevelopersApi()
startdate = 2013-10-20T19:20:30+01:00 # Date | Pass the initial date (ISO 8601 format)
enddate = 2013-10-20T19:20:30+01:00 # Date | Pass the final date (ISO 8601 format)

try: 
    # Get the inspections list
    api_response = api_instance.get_inspections(startdate, enddate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevelopersApi->getInspections: %s\n" % e)

Parameters

Query parameters
Name Description
startdate*
Date (date-time)
Pass the initial date (ISO 8601 format)
Required
enddate*
Date (date-time)
Pass the final date (ISO 8601 format)
Required

Responses

Status: 200 - Successful response

Status: 400 - bad input parameter

getTests

Get the inspections list

Get inspection test results within a date range (e.g., ?startdate=2024-08-28T22:07:17.0284430Z&enddate=2024-08-29T22:07:17.0284430Z&workorder=30640592). 


/inspections/tests

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"https://virtserver.swaggerhub.com/i1196/AVMG_Public_API/1.0.0/inspections/tests?startdate=&enddate=&workorder="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevelopersApi;

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

public class DevelopersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DevelopersApi apiInstance = new DevelopersApi();
        Date startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
        Date enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)
        String workorder = workorder_example; // String | Pass the work order id or number
        try {
            array[TestDetails] result = apiInstance.getTests(startdate, enddate, workorder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevelopersApi#getTests");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevelopersApi;

public class DevelopersApiExample {

    public static void main(String[] args) {
        DevelopersApi apiInstance = new DevelopersApi();
        Date startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
        Date enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)
        String workorder = workorder_example; // String | Pass the work order id or number
        try {
            array[TestDetails] result = apiInstance.getTests(startdate, enddate, workorder);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevelopersApi#getTests");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
Date *startdate = 2013-10-20T19:20:30+01:00; // Pass the initial date (ISO 8601 format)
Date *enddate = 2013-10-20T19:20:30+01:00; // Pass the final date (ISO 8601 format)
String *workorder = workorder_example; // Pass the work order id or number

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

// Get the inspections list
[apiInstance getTestsWith:startdate
    enddate:enddate
    workorder:workorder
              completionHandler: ^(array[TestDetails] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AvmgPublicApi = require('avmg_public_api');
var defaultClient = AvmgPublicApi.ApiClient.instance;


var api = new AvmgPublicApi.DevelopersApi()
var startdate = 2013-10-20T19:20:30+01:00; // {{Date}} Pass the initial date (ISO 8601 format)
var enddate = 2013-10-20T19:20:30+01:00; // {{Date}} Pass the final date (ISO 8601 format)
var workorder = workorder_example; // {{String}} Pass the work order id or number

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

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

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


            var apiInstance = new DevelopersApi();
            var startdate = 2013-10-20T19:20:30+01:00;  // Date | Pass the initial date (ISO 8601 format)
            var enddate = 2013-10-20T19:20:30+01:00;  // Date | Pass the final date (ISO 8601 format)
            var workorder = workorder_example;  // String | Pass the work order id or number

            try
            {
                // Get the inspections list
                array[TestDetails] result = apiInstance.getTests(startdate, enddate, workorder);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevelopersApi.getTests: " + e.Message );
            }
        }
    }
}

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


$api_instance = new Swagger\Client\ApiDevelopersApi();
$startdate = 2013-10-20T19:20:30+01:00; // Date | Pass the initial date (ISO 8601 format)
$enddate = 2013-10-20T19:20:30+01:00; // Date | Pass the final date (ISO 8601 format)
$workorder = workorder_example; // String | Pass the work order id or number

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


my $api_instance = WWW::SwaggerClient::DevelopersApi->new();
my $startdate = 2013-10-20T19:20:30+01:00; # Date | Pass the initial date (ISO 8601 format)
my $enddate = 2013-10-20T19:20:30+01:00; # Date | Pass the final date (ISO 8601 format)
my $workorder = workorder_example; # String | Pass the work order id or number

eval { 
    my $result = $api_instance->getTests(startdate => $startdate, enddate => $enddate, workorder => $workorder);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevelopersApi->getTests: $@\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.DevelopersApi()
startdate = 2013-10-20T19:20:30+01:00 # Date | Pass the initial date (ISO 8601 format)
enddate = 2013-10-20T19:20:30+01:00 # Date | Pass the final date (ISO 8601 format)
workorder = workorder_example # String | Pass the work order id or number

try: 
    # Get the inspections list
    api_response = api_instance.get_tests(startdate, enddate, workorder)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DevelopersApi->getTests: %s\n" % e)

Parameters

Query parameters
Name Description
startdate*
Date (date-time)
Pass the initial date (ISO 8601 format)
Required
enddate*
Date (date-time)
Pass the final date (ISO 8601 format)
Required
workorder*
String
Pass the work order id or number
Required

Responses

Status: 200 - Successful response

Status: 400 - bad input parameter