Skip to content

TripsApi.md

Latest commit

 

History

History
139 lines (96 loc) · 5.46 KB

TripsApi.md

File metadata and controls

139 lines (96 loc) · 5.46 KB

BeLenka\Deposco\TripsApi

All URIs are relative to https://api.deposco.com/latest, except if the operation defines another base path.

Method HTTP request Description
getTripById() GET /trips/{tripId} Get a trip
getTrips() GET /trips Get a list of trips

getTripById()

getTripById($trip_id): \BeLenka\Deposco\Model\TripDTO

Get a trip

Retrieves the details of an existing trip. Provide the unique identifier that was returned when the trip was created.

Example

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


// Configure OAuth2 access token for authorization: oauth2
$config = BeLenka\Deposco\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\Deposco\Api\TripsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$trip_id = 'trip_id_example'; // string | ID of the requested trip.

try {
    $result = $apiInstance->getTripById($trip_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TripsApi->getTripById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
trip_id string ID of the requested trip.

Return type

\BeLenka\Deposco\Model\TripDTO

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTrips()

getTrips($business_unit, $search_id, $page_size, $number, $created_after, $updated_after): \BeLenka\Deposco\Model\TripCollectionDTO

Get a list of trips

Retrieves a list of trips, paginated and sorted by ID in descending order.

Example

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


// Configure OAuth2 access token for authorization: oauth2
$config = BeLenka\Deposco\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\Deposco\Api\TripsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_unit = 'business_unit_example'; // string | Code for the company (business unit) to which the resource is assigned. Optional if the application is restricted to one company.
$search_id = 'search_id_example'; // string | ID that is returned in the links section of incomplete search results. Specify the search ID in this parameter to continue retrieving search results. Other search-related parameters are overridden by this parameter.
$page_size = 50; // int | Number of records returned on each page of the search results. The default page size is 50.
$number = 'number_example'; // string | Number of the requested trip.
$created_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Search field for finding records created after the specified date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
$updated_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Search field for finding records updated after the specified date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

try {
    $result = $apiInstance->getTrips($business_unit, $search_id, $page_size, $number, $created_after, $updated_after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TripsApi->getTrips: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_unit string Code for the company (business unit) to which the resource is assigned. Optional if the application is restricted to one company. [optional]
search_id string ID that is returned in the links section of incomplete search results. Specify the search ID in this parameter to continue retrieving search results. Other search-related parameters are overridden by this parameter. [optional]
page_size int Number of records returned on each page of the search results. The default page size is 50. [optional] [default to 50]
number string Number of the requested trip. [optional]
created_after \DateTime Search field for finding records created after the specified date and time in ISO 8601 format. [optional]
updated_after \DateTime Search field for finding records updated after the specified date and time in ISO 8601 format. [optional]

Return type

\BeLenka\Deposco\Model\TripCollectionDTO

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]