PFABO API

CheckinContainer

checkinContainer

Pfandbox zurückgeben


/checkinContainer

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://apidev.pfabo.de/checkinContainer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckinContainerApi;

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

public class CheckinContainerApiExample {

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

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CheckinContainerApi apiInstance = new CheckinContainerApi();
        Object body = ; // Object | Checkout info
        try {
            apiInstance.checkinContainer(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckinContainerApi#checkinContainer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckinContainerApi;

public class CheckinContainerApiExample {

    public static void main(String[] args) {
        CheckinContainerApi apiInstance = new CheckinContainerApi();
        Object body = ; // Object | Checkout info
        try {
            apiInstance.checkinContainer(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckinContainerApi#checkinContainer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
Object *body = ; // Checkout info

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

[apiInstance checkinContainerWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PfaboApi = require('pfabo_api');
var defaultClient = PfaboApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new PfaboApi.CheckinContainerApi()
var body = ; // {{Object}} Checkout info

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

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

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new CheckinContainerApi();
            var body = new Object(); // Object | Checkout info

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

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiCheckinContainerApi();
$body = ; // Object | Checkout info

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckinContainerApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | Checkout info

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckinContainerApi()
body =  # Object | Checkout info

try: 
    api_instance.checkin_container(body)
except ApiException as e:
    print("Exception when calling CheckinContainerApi->checkinContainer: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Pfandbox erfolgreich zurückgeben

Status: 400 - Ungültige Seriennummer angegeben

Status: 404 - Pfandbox nicht gefunden

Status: 405 - Ungültige Eingabe


CheckoutContainer

checkoutContainer

Pfandbox verleihen


/checkoutContainer

Usage and SDK Samples

curl -X POST\
-H "x-api-key: [[apiKey]]"\
-H "Content-Type: application/json"\
"https://apidev.pfabo.de/checkoutContainer"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckoutContainerApi;

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

public class CheckoutContainerApiExample {

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

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        CheckoutContainerApi apiInstance = new CheckoutContainerApi();
        Object body = ; // Object | Checkout info
        try {
            apiInstance.checkoutContainer(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutContainerApi#checkoutContainer");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckoutContainerApi;

public class CheckoutContainerApiExample {

    public static void main(String[] args) {
        CheckoutContainerApi apiInstance = new CheckoutContainerApi();
        Object body = ; // Object | Checkout info
        try {
            apiInstance.checkoutContainer(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckoutContainerApi#checkoutContainer");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
Object *body = ; // Checkout info

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

[apiInstance checkoutContainerWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PfaboApi = require('pfabo_api');
var defaultClient = PfaboApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new PfaboApi.CheckoutContainerApi()
var body = ; // {{Object}} Checkout info

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

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

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new CheckoutContainerApi();
            var body = new Object(); // Object | Checkout info

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

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiCheckoutContainerApi();
$body = ; // Object | Checkout info

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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckoutContainerApi->new();
my $body = WWW::SwaggerClient::Object::Object->new(); # Object | Checkout info

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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckoutContainerApi()
body =  # Object | Checkout info

try: 
    api_instance.checkout_container(body)
except ApiException as e:
    print("Exception when calling CheckoutContainerApi->checkoutContainer: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Pfandbox erfolgreich verliehen

Status: 400 - Ungültige Seriennummer angegeben

Status: 404 - Pfandbox nicht gefunden

Status: 405 - Ungültige Eingabe


ContainerStatus

getContainerStatus

Abfrage des Ausleihstatus einer Pfandbox anhand der Seriennummer


/containers/{serialnumber}/status

Usage and SDK Samples

curl -X GET\
-H "x-api-key: [[apiKey]]"\
-H "Accept: application/json"\
"https://apidev.pfabo.de/containers/{serialnumber}/status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContainerStatusApi;

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

public class ContainerStatusApiExample {

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

        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        ContainerStatusApi apiInstance = new ContainerStatusApi();
        String serialnumber = serialnumber_example; // String | Seriennummer der Pfandbox

        try {
            ContainerStatus result = apiInstance.getContainerStatus(serialnumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainerStatusApi#getContainerStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContainerStatusApi;

public class ContainerStatusApiExample {

    public static void main(String[] args) {
        ContainerStatusApi apiInstance = new ContainerStatusApi();
        String serialnumber = serialnumber_example; // String | Seriennummer der Pfandbox

        try {
            ContainerStatus result = apiInstance.getContainerStatus(serialnumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContainerStatusApi#getContainerStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];
String *serialnumber = serialnumber_example; // Seriennummer der Pfandbox


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

[apiInstance getContainerStatusWith:serialnumber
              completionHandler: ^(ContainerStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PfaboApi = require('pfabo_api');
var defaultClient = PfaboApi.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new PfaboApi.ContainerStatusApi()
var serialnumber = serialnumber_example; // {{String}} Seriennummer der Pfandbox


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

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

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new ContainerStatusApi();
            var serialnumber = serialnumber_example;  // String | Seriennummer der Pfandbox


            try
            {
                ContainerStatus result = apiInstance.getContainerStatus(serialnumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContainerStatusApi.getContainerStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Swagger\Client\ApiContainerStatusApi();
$serialnumber = serialnumber_example; // String | Seriennummer der Pfandbox


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

# Configure API key authorization: api_key
$WWW::SwaggerClient::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContainerStatusApi->new();
my $serialnumber = serialnumber_example; # String | Seriennummer der Pfandbox


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

# Configure API key authorization: api_key
swagger_client.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContainerStatusApi()
serialnumber = serialnumber_example # String | Seriennummer der Pfandbox


try: 
    api_response = api_instance.get_container_status(serialnumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContainerStatusApi->getContainerStatus: %s\n" % e)

Parameters

Path parameters
Name Description
serialnumber*
String
Seriennummer der Pfandbox
Required

Responses

Status: 200 - Der angefragte Ausleihstatus

Status: 400 - Ungültige Seriennummer angegeben

Status: 403 - Berechtigung fehlt oder ist nicht ausreichend

Status: 404 - Pfandbox nicht gefunden