NAV Navbar
cURL Angular

Introduction

Welcome to the FMS API! You can use our API to access FMS API endpoints.

You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API environments

Staging

Production

Collection query parameters

All collections use some common query parameters

Query param Description
page Number of page
limit Number of records per page. Default is 25
filter[something] Filtering collection by specific field in square brackets. Details in specific collection documentation
order[something] Sorting collection by specific field in square brackets. Details in specific collection documentation. Collections can be sorted ascending (asc) or descending (desc)

Errors

The FMS API uses the following error codes:

Error Code Description
400 Bad Request Your request is invalid.
401 Unauthorized Access token missing or invalid.
403 Forbidden User authenticated, but don't have permission for this action.
404 Not Found The specified object was not found.
405 Method Not Allowed You tried to access an object with an invalid method.
406 Not Acceptable You requested a format that isn't json.
422 Failed validation Data validation failed. See details in response
500 Internal Server Error We had a problem with our server. Try again later.
503 Service Unavailable We're temporarily offline for maintenance. Please try again later.

Authentication

For every endpoint FMS uses access tokens to allow access to the API.

FMS expects for the API access token to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer eyJ0eXAi...

Issue for new access token

To get new access token you have to send to authorization server with POST method following data:

HTTP Request

POST
/oauth/token

Example of issue new token:

curl 'https://api.fms.euromaster.pl/oauth/token' \
 -H 'Accept: application/json' \
 -H 'Content-Type: application/json' \
 --data-binary '{"grant_type":"client_credentials","client_id":"your_client_id","client_secret":"your_client_secret","scope":"vehicles.view services.view relocations.view relocations.create vehicle-tyres.view"}'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Basic ' + btoa('your_client_id:client_secret')});

httpClient.post('https://api.fms.euromaster.pl/oauth/token', {
  grant_type: 'client_credentials',
  scope: 'vehicles.view services.view relocations.view relocations.create vehicle-tyres.view'
}, {headers: headers}).subscribe(response => {
  // do something with response
});

Make sure you provide correct client_id and client_secret

JSON response example:

{
    "token_type": "Bearer",
    "expires_in": 7200,
    "access_token": "eyJ0eXA..."
}

POST parameters

Parameter Description
grant_type Pass client_credentials value
client_id Client ID for your application
client_secret Client Secret of your application
scope Space separated list of available scopes. See Scopes

Scopes

Below is list of all available scopes and their descriptions

Scope name Description
vehicles.view Read only access to vehicles
vehicles.update Updating vehicles
services.view Read only access to service points
relocations.view Read only access to relocations
relocations.create Creating new relocations
vehicle-tyres.view Read only access to vehicle tyres
vehicle-tyres.create Creating new vehicle tyres

Service points

Service Point properties

Attribute Type Description
id int Unique identifier for the resource
shortName string Short name
fullName string Full name
city string City or location name
zipcode string Postal code
street string Street address
house string House number
contactPerson string Contact person
phone string Phone number
fax string Fax number
email string Email address
openingMonFri string Opening hours from Monday to Friday
openingSat string Opening hours on Saturday
openingSun string Opening hours at Sunday
geoLng string Geolocation LNG
geoLat string Geolocation LAT
province object Province data. See Service Point - Province properties
serviceHeadOffice object Service Head Office data. See Service Point - Head Office properties
lastModified string Last modification date and time
d2d boolean Indicates if Service Point has D2D service active
isActive boolean Indicates if Service Point is active

Service Point - Head Office properties

Attribute Type Description
id int Unique identifier for the resource read-only
shortName string Short name
fullName string Full name
city string City or location name
zipcode string Postal code
street string Street address
house string House number
nip string NIP number
regon string REGON number
contactPerson string Contact person
phone string Phone number
fax string Fax number
email string Email address
www string WWW site address
lastModified string Last modification date and time
isActive boolean Indicates if Service Point is active

Service Point - Province properties

Attribute Type Description
id int Unique identifier for the resource
name string Province name

Get All Service points

This endpoint retrieves all service points.

HTTP Request

GET
/api/v1/service-points

Example of retireve all service points:

curl "https://api.fms.euromaster.pl/api/v1/service-points" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/service-points', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "_total_items": 273,
    "_page": 1,
    "_page_count": 11,
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/service-points?page=1"
        },
        "next": {
            "href": "https://api.fms.euromaster.pl/api/v1/service-points?page=2"
        },
        "last": {
            "href": "https://api.fms.euromaster.pl/api/v1/service-points?page=11"
        }
    },
    "_embedded": {
        "service_points": [
            {
                "fullName": "AAA-GUM Jan Kowalski",
                "shortName": "AAA-GUM",
                "city": "Warszawa",
                "zipcode": "01-100",
                "street": "Broniewskiego",
                "house": "1",
                "contactPerson": "Jan Kowalski",
                "phone": "555555555",
                "fax": "555555555",
                "email": "aaagum@example.com",
                "openingMonFri": "08:00-17:00",
                "openingSat": "08:00-13:00",
                "openingSun": null,
                "lastModified": "2016-07-29T13:26:59+02:00",
                "geoLng": "17.254512",
                "geoLat": "51.186234",
                "d2d": false,
                "isActive": true,
                "id": 236,
                "province": {
                    "name": "mazowieckie",
                    "id": 1
                },
                "serviceHeadOffice": {
                    "fullName": "AAA-GUM FH-U Adam Gacki",
                    "shortName": "AAA-GUM",
                    "city": "Warszawa",
                    "zipcode": "01-100",
                    "street": "Broniewskiego",
                    "house": "10",
                    "nip": "000-000-00-00",
                    "regon": "000000000",
                    "contactPerson": "Jan Kowalski",
                    "phone": "555555555",
                    "fax": null,
                    "email": "aaagum@example.com",
                    "www": null,
                    "lastModified": "2014-03-21T17:11:56+01:00",
                    "isActive": true,
                    "id": 467
                },
                "_links": {
                    "self": {
                        "href": "https://api.fms.euromaster.pl/api/v1/service-points/236"
                    }
                }
            }
        ]
    }
}

Query Parameters

Parameter Allowed values Description
filter[search] any string Filter results by short name, city, street or zipcode
filter[name] any string Filter results by short name
filter[fullName] any string Filter results by full name
filter[city] any string Filter results by city
filter[zipcode] any string Filter results by zipcode
filter[isActive] 0, 1 Filter results by active flag
order[name] asc, desc Sort results by short name default
order[city] asc, desc Sort results by city

Get One Service point

This endpoint retrieves service point by its ID.

HTTP Request

GET
/api/v1/service-points/<id>

Example of retireve one service point by ID:

curl "https://api.fms.euromaster.pl/api/v1/service-points/236" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/service-points/236', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "fullName": "AAA-GUM Jan Kowalski",
    "shortName": "AAA-GUM",
    "city": "Warszawa",
    "zipcode": "01-100",
    "street": "Broniewskiego",
    "house": "1",
    "contactPerson": "Jan Kowalski",
    "phone": "555555555",
    "fax": "555555555",
    "email": "aaagum@example.com",
    "openingMonFri": "08:00-17:00",
    "openingSat": "08:00-13:00",
    "openingSun": null,
    "lastModified": "2016-07-29T13:26:59+02:00",
    "geoLng": "17.254512",
    "geoLat": "51.186234",
    "d2d": false,
    "isActive": true,
    "id": 236,
    "province": {
        "name": "mazowieckie",
        "id": 1
    },
    "serviceHeadOffice": {
        "fullName": "AAA-GUM FH-U Adam Gacki",
        "shortName": "AAA-GUM",
        "city": "Warszawa",
        "zipcode": "01-100",
        "street": "Broniewskiego",
        "house": "10",
        "nip": "000-000-00-00",
        "regon": "000000000",
        "contactPerson": "Jan Kowalski",
        "phone": "555555555",
        "fax": null,
        "email": "aaagum@example.com",
        "www": null,
        "lastModified": "2014-03-21T17:11:56+01:00",
        "isActive": true,
        "id": 467
    }
}

URL Parameters

Parameter Description
id The ID of the service point

Vehicles

Vehicle properties

Attribute Type Description
id int Unique identifier for the resource
registrationNumber string Registration number
vin string VIN number
company string Company name
vehicleBrand string Vehicle's brand
vehicleModel string Vehicle's model
tyreSegment object Tyre segment data
vehicleType object Vehicle type
driverData string Driver's firstname and surname
driverEmail string Driver's email address
driverPhone string Driver's phone number
mileage int Vehicle's mileage in km
minTyres int Minimum tyres allowed on vehicle
maxTyres int Maximum tyres allowed on vehicle
fleet object Fleet data. See Vehicle - Fleet properties
contract object Contract data. See Vehicle - Contract properties
isFpv boolean Indicates if vehicle is virtual
d2d boolean Indicates if Vehicle has D2D service active
dateAdded string Creation date and time
lastModified string Last modification date and time
isActive boolean Indicates if Vehicle is active

Vehicle - Fleet properties

Attribute Type Description
id int Unique identifier for the resource read-only
shortName string Short name
fullName string Full name
city string City or location name
zipcode string Postal code
street string Street address
house string House number
nip string NIP number
regon string REGON number
contactPerson string Contact person
email string Email address
phone string Phone number
fax string Fax number
additionalInfo string Additional data, comment
lastModified string Last modification date and time
isActive boolean Indicates if fleet is active

Vehicle - Contract properties

Attribute Type Description
id int Unique identifier for the resource read-only
name string Contract name
dateStart string Begining of contract
dateFinish string End of contract
seasonSummerStart string Begining of summer season
seasonSummerFinish string End of summer season
seasonWinterStart string Begining of winter season
seasonWinterFinish string End of winter season
contractType object Contract type. Valid values: two sides, three sides
fleet object Fleet data. See Vehicle - Fleet properties
authorizationByService boolean Indicates if service can authorize own service requests
minTdWinter string Minimum tread depth for winter tyres
minTdSummer string Minimum tread depth for summer tyres
diagnosticsActivities string List of diagnostics activities
planningMethodDuringSeason string Service execution planning during season
planningMethodOutOfSeason string Service execution planning outside season
invoiceSchema string Invoicing schema
reportingDuringSeason string Reporting requirements during season
reportingOutOfSeason string Reporting requirements outside season
serviceRequestingMethod string Description of authorization number obtaining method
dotRequired boolean Requirement of the DOT tire replacement services
driverRelocation boolean Indicates if contract has driver relocation service active
lastModified string Last modification date and time

Get All Vehicles

This endpoint retrieves all vehicles.

HTTP Request

GET
/api/v1/vehicles

Example of retireve all vehicles:

curl "https://api.fms.euromaster.pl/api/v1/vehicles" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/vehicles', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "_total_items": 4,
    "_page": 1,
    "_page_count": 1,
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicles?page=1"
        }
    },
    "_embedded": {
        "vehicles": [
            {
                "registrationNumber": "WWTEST",
                "vin": "VF7RDRHH4CL514853",
                "company": "Jakaś firma",
                "vehicleBrand": "Ford",
                "vehicleModel": "Fiesta",
                "dateAdded": "2015-05-05T16:50:01+02:00",
                "mileage": 16000,
                "driverData": "Jan Kowalski",
                "driverEmail": "kowalski@example.com",
                "driverPhone": "600500200",
                "lastModified": "2020-08-25T14:46:53+02:00",
                "minTyres": 0,
                "maxTyres": 12,
                "d2d": false,
                "isActive": true,
                "isFpv": false,
                "id": 82702,
                "contract": {
                    "name": "Kontrakt testowy",
                    "dateStart": "2009-09-01T00:00:00+02:00",
                    "dateFinish": null,
                    "seasonSummerStart": "2019-03-19T00:00:00+01:00",
                    "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
                    "seasonWinterStart": "2019-10-01T00:00:00+02:00",
                    "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
                    "authorizationByService": false,
                    "dotRequired": false,
                    "diagnosticsActivities": null,
                    "planningMethodDuringSeason": null,
                    "planningMethodOutOfSeason": null,
                    "invoiceSchema": null,
                    "reportingDuringSeason": null,
                    "reportingOutOfSeason": null,
                    "serviceRequestingMethod": null,
                    "minTdWinter": "3.4",
                    "minTdSummer": "2.3",
                    "driverRelocation": false,
                    "isActive": false,
                    "id": 3,
                    "contractType": {
                        "name": "twoSides",
                        "id": 1
                    },
                    "fleet": {
                        "fullName": "Flota testowa Sp. z o.o.",
                        "shortName": "Flota testowa",
                        "city": "Warszawa",
                        "zipcode": "00-000",
                        "street": "Broniewskiego",
                        "house": "19",
                        "nip": "000-000-00-00",
                        "regon": null,
                        "contactPerson": "Jan Kowalski",
                        "email": "jan.kowalski@euromaster.com",
                        "phone": "100200300",
                        "fax": null,
                        "lastModified": "2014-10-06T10:09:24+02:00",
                        "isActive": true,
                        "additionalInfo": null,
                        "id": 3
                    }
                },
                "fleet": {
                    "fullName": "Flota testowa Sp. z o.o.",
                    "shortName": "Flota testowa",
                    "city": "Warszawa",
                    "zipcode": "00-000",
                    "street": "Broniewskiego",
                    "house": "19",
                    "nip": "000-000-00-00",
                    "regon": null,
                    "contactPerson": "Jan Kowalski",
                    "email": "jan.kowalski@euromaster.com",
                    "phone": "100200300",
                    "fax": null,
                    "lastModified": "2014-10-06T10:09:24+02:00",
                    "isActive": true,
                    "additionalInfo": null,
                    "id": 3
                },
                "tyreSegment": null,
                "vehicleType": {
                    "name": "osobowy",
                    "id": 1
                },
                "_links": {
                    "self": {
                        "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
                    }
                }
            }
        ]
    }
}

Query Parameters

Parameter Allowed values Description
filter[search] any string Filter results by registration number, vin, vehicle brand or vehicle model
filter[registrationNumber] any string Filter results by registration number
filter[vin] any string Filter results by vin number
filter[brand] any string Filter results by vehicle brand
filter[model] any string Filter results by vehicle model
filter[isActive] 0, 1 Filter results by active flag
order[registrationNumber] asc, desc Sort results by registration number default

Get One vehicle

This endpoint retrieves vehicle by its ID.

HTTP Request

GET
/api/v1/vehicles/<id>

Example of retireve one vehicle by ID:

curl "https://api.fms.euromaster.pl/api/v1/vehicles/82702" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/vehicles/82702', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "registrationNumber": "WWTEST",
    "vin": "VF7RDRHH4CL514853",
    "company": "Jakaś firma",
    "vehicleBrand": "Ford",
    "vehicleModel": "Fiesta",
    "dateAdded": "2015-05-05T16:50:01+02:00",
    "mileage": 16000,
    "driverData": "Jan Kowalski",
    "driverEmail": "kowalski@example.com",
    "driverPhone": "600500200",
    "lastModified": "2020-08-25T14:46:53+02:00",
    "minTyres": 0,
    "maxTyres": 12,
    "d2d": false,
    "isActive": true,
    "isFpv": false,
    "id": 82702,
    "contract": {
        "name": "Kontrakt testowy",
        "dateStart": "2009-09-01T00:00:00+02:00",
        "dateFinish": null,
        "seasonSummerStart": "2019-03-19T00:00:00+01:00",
        "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
        "seasonWinterStart": "2019-10-01T00:00:00+02:00",
        "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
        "authorizationByService": false,
        "dotRequired": false,
        "diagnosticsActivities": null,
        "planningMethodDuringSeason": null,
        "planningMethodOutOfSeason": null,
        "invoiceSchema": null,
        "reportingDuringSeason": null,
        "reportingOutOfSeason": null,
        "serviceRequestingMethod": null,
        "minTdWinter": "3.4",
        "minTdSummer": "2.3",
        "driverRelocation": false,
        "isActive": false,
        "id": 3,
        "contractType": {
            "name": "twoSides",
            "id": 1
        },
        "fleet": {
            "fullName": "Flota testowa Sp. z o.o.",
            "shortName": "Flota testowa",
            "city": "Warszawa",
            "zipcode": "00-000",
            "street": "Broniewskiego",
            "house": "19",
            "nip": "000-000-00-00",
            "regon": null,
            "contactPerson": "Jan Kowalski",
            "email": "jan.kowalski@euromaster.com",
            "phone": "100200300",
            "fax": null,
            "lastModified": "2014-10-06T10:09:24+02:00",
            "isActive": true,
            "additionalInfo": null,
            "id": 3
        }
    },
    "fleet": {
        "fullName": "Flota testowa Sp. z o.o.",
        "shortName": "Flota testowa",
        "city": "Warszawa",
        "zipcode": "00-000",
        "street": "Broniewskiego",
        "house": "19",
        "nip": "000-000-00-00",
        "regon": null,
        "contactPerson": "Jan Kowalski",
        "email": "jan.kowalski@euromaster.com",
        "phone": "100200300",
        "fax": null,
        "lastModified": "2014-10-06T10:09:24+02:00",
        "isActive": true,
        "additionalInfo": null,
        "id": 3
    },
    "tyreSegment": null,
    "vehicleType": {
        "name": "osobowy",
        "id": 1
    },
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
        }
    }
}

URL Parameters

Parameter Description
id The ID of the vehicle

Update vehicle

This endpoint updates vehicle by its ID.

HTTP Request

PATCH
/api/v1/vehicles/<id>

Example of update vehicle:

curl -X PATCH "https://api.fms.euromaster.pl/api/v1/vehicles/82702" \
     -H 'Authorization: Bearer eyJ0eXA...'
     -H 'Content-Type: application/json' \
     -d '{
       "vin": "VF7RDRHH4CL514851",
       "maxTyres": 5
     }'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.patch('https://api.fms.euromaster.pl/api/v1/vehicles/82702', {
    vin: 'VF7RDRHH4CL514851',
    maxTyres: 5
}, {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "registrationNumber": "WWTEST",
    "vin": "VF7RDRHH4CL514851",
    "company": "Jakaś firma",
    "vehicleBrand": "Ford",
    "vehicleModel": "Fiesta",
    "dateAdded": "2015-05-05T16:50:01+02:00",
    "mileage": 16000,
    "driverData": "Jan Kowalski",
    "driverEmail": "kowalski@example.com",
    "driverPhone": "600500200",
    "lastModified": "2024-04-10T13:49:15+02:00",
    "minTyres": 0,
    "maxTyres": 5,
    "d2d": false,
    "isActive": true,
    "isFpv": false,
    "id": 82702,
    "contract": {
        "name": "Kontrakt testowy",
        "dateStart": "2009-09-01T00:00:00+02:00",
        "dateFinish": null,
        "seasonSummerStart": "2019-03-19T00:00:00+01:00",
        "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
        "seasonWinterStart": "2019-10-01T00:00:00+02:00",
        "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
        "authorizationByService": false,
        "dotRequired": false,
        "diagnosticsActivities": null,
        "planningMethodDuringSeason": null,
        "planningMethodOutOfSeason": null,
        "invoiceSchema": null,
        "reportingDuringSeason": null,
        "reportingOutOfSeason": null,
        "serviceRequestingMethod": null,
        "minTdWinter": "3.4",
        "minTdSummer": "2.3",
        "driverRelocation": false,
        "isActive": false,
        "id": 3,
        "contractType": {
            "name": "twoSides",
            "id": 1
        },
        "fleet": {
            "fullName": "Flota testowa Sp. z o.o.",
            "shortName": "Flota testowa",
            "city": "Warszawa",
            "zipcode": "00-000",
            "street": "Broniewskiego",
            "house": "19",
            "nip": "000-000-00-00",
            "regon": null,
            "contactPerson": "Jan Kowalski",
            "email": "jan.kowalski@euromaster.com",
            "phone": "100200300",
            "fax": null,
            "lastModified": "2014-10-06T10:09:24+02:00",
            "isActive": true,
            "additionalInfo": null,
            "id": 3
        }
    },
    "fleet": {
        "fullName": "Flota testowa Sp. z o.o.",
        "shortName": "Flota testowa",
        "city": "Warszawa",
        "zipcode": "00-000",
        "street": "Broniewskiego",
        "house": "19",
        "nip": "000-000-00-00",
        "regon": null,
        "contactPerson": "Jan Kowalski",
        "email": "jan.kowalski@euromaster.com",
        "phone": "100200300",
        "fax": null,
        "lastModified": "2014-10-06T10:09:24+02:00",
        "isActive": true,
        "additionalInfo": null,
        "id": 3
    },
    "tyreSegment": null,
    "vehicleType": {
        "name": "osobowy",
        "id": 1
    },
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
        }
    }
}

URL Parameters

Parameter Description
id The ID of the vehicle

Body Parameters

Parameter Type Required? Description
registrationNumber int Yes Vehicle's registration number
fleet int Yes Fleet ID
contract int Yes Contract ID
vin string No Vehicle's VIN number
company string No Vehicle's company name
vehicleBrand string No Vehicle's brand
vehicleModel string No Vehicle's model
mileage int Yes Vehicle's mileage
driverData string No User data, eg. name and surname
driverEmail string No User email address
driverPhone string No User phone number
minTyres int Yes Minimum number of tyres
maxTyres int Yes Maximum number of tyres
d2d boolean Yes D2D flag
isActive boolean Yes Indicates of vehicle is active or not

Vehicle tyres

Vehicle tyre properties

Attribute Type Description
id int Unique identifier for the resource read-only
tyreNumber string Unique tyre number read-only
brand string Tyre brand
pattern string Tyre pattern
size int Tyre size
aspectRatio int Tyre aspect ratio
diameter int Tyre diameter
li string Tyre load index
si string Tyre speed index
depositNumber string Tyre deposit number in service storage
dot string DOT number
servicePoint object Service Point when tyre is deposited. See Service Point properties
vehicle object Vehicle to which the tyre is assigned. See Vehicle properties
treadDepth string Tyre tread depth
tyreSeason object Tyre season. Possible values: z - winter, l - summer, c - all year
tyreStatus object Tyre status. See Vehicle tyre - Status codes
position object Tyre position
statusFrom object The origin of the tyre
depositDate string Date and time when tyre was deposited
lastModified string Last modification date and time

Vehicle tyre - Status codes

Status code Description
d In deposit
e Erased, removed
o In release order
p To utilization
r In relocation
s On vehicle
u Utilized
w Given out

Get All Vehicle tyres

This endpoint retrieves all vehicle tyres.

HTTP Request

GET
/api/v1/vehicle-tyres

Example of retireve all vehicles:

curl "https://api.fms.euromaster.pl/api/v1/vehicle-tyres" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/vehicle-tyres', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "_total_items": 136299,
    "_page": 1,
    "_page_count": 5452,
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres?page=1"
        },
        "next": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres?page=2"
        },
        "last": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres?page=5452"
        }
    },
    "_embedded": {
        "vehicle_tyres": [
            {
                "tyreNumber": "201010011910121007",
                "brand": "BFGoodrich",
                "pattern": "G-ForceWinter",
                "size": 205,
                "aspectRatio": 60,
                "diameter": 16,
                "li": ".",
                "si": ".",
                "depositNumber": null,
                "dot": null,
                "comment": null,
                "treadDepth": 5.5,
                "lastOperation": "2014-09-29T16:01:53+02:00",
                "depositDate": null,
                "id": 43,
                "tyreSeason": {
                    "name": "winter",
                    "key": "z"
                },
                "position": {
                    "name": "leftFront",
                    "key": "LP"
                },
                "statusFrom": {
                    "name": "relocation",
                    "id": 2
                },
                "status": {
                    "name": "givenOut",
                    "key": "w"
                },
                "_links": {
                    "self": {
                        "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres/43"
                    }
                },
                "_embedded": {
                    "servicePoint": {
                        "fullName": "AAA-GUM Jan Kowalski",
                        "shortName": "AAA-GUM",
                        "city": "Warszawa",
                        "zipcode": "01-100",
                        "street": "Broniewskiego",
                        "house": "1",
                        "contactPerson": "Jan Kowalski",
                        "phone": "555555555",
                        "fax": "555555555",
                        "email": "aaagum@example.com",
                        "openingMonFri": "08:00-17:00",
                        "openingSat": "08:00-13:00",
                        "openingSun": null,
                        "lastModified": "2016-07-29T13:26:59+02:00",
                        "geoLng": "17.254512",
                        "geoLat": "51.186234",
                        "d2d": false,
                        "isActive": true,
                        "id": 236,
                        "province": {
                            "name": "mazowieckie",
                            "id": 1
                        },
                        "serviceHeadOffice": {
                            "fullName": "AAA-GUM FH-U Adam Gacki",
                            "shortName": "AAA-GUM",
                            "city": "Warszawa",
                            "zipcode": "01-100",
                            "street": "Broniewskiego",
                            "house": "10",
                            "nip": "000-000-00-00",
                            "regon": "000000000",
                            "contactPerson": "Jan Kowalski",
                            "phone": "555555555",
                            "fax": null,
                            "email": "aaagum@example.com",
                            "www": null,
                            "lastModified": "2014-03-21T17:11:56+01:00",
                            "isActive": true,
                            "id": 467
                        }
                    },
                    "vehicle": {
                       "registrationNumber": "WWTEST",
                       "vin": "VF7RDRHH4CL514853",
                       "company": "Jakaś firma",
                       "vehicleBrand": "Ford",
                       "vehicleModel": "Fiesta",
                       "dateAdded": "2015-05-05T16:50:01+02:00",
                       "mileage": 16000,
                       "driverData": "Jan Kowalski",
                       "driverEmail": "kowalski@example.com",
                       "driverPhone": "600500200",
                       "lastModified": "2020-08-25T14:46:53+02:00",
                       "minTyres": 0,
                       "maxTyres": 12,
                       "d2d": false,
                       "isActive": true,
                       "isFpv": false,
                       "id": 82702,
                       "contract": {
                           "name": "Kontrakt testowy",
                           "dateStart": "2009-09-01T00:00:00+02:00",
                           "dateFinish": null,
                           "seasonSummerStart": "2019-03-19T00:00:00+01:00",
                           "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
                           "seasonWinterStart": "2019-10-01T00:00:00+02:00",
                           "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
                           "authorizationByService": false,
                           "dotRequired": false,
                           "diagnosticsActivities": null,
                           "planningMethodDuringSeason": null,
                           "planningMethodOutOfSeason": null,
                           "invoiceSchema": null,
                           "reportingDuringSeason": null,
                           "reportingOutOfSeason": null,
                           "serviceRequestingMethod": null,
                           "minTdWinter": "3.4",
                           "minTdSummer": "2.3",
                           "driverRelocation": false,
                           "isActive": false,
                           "id": 3,
                           "contractType": {
                               "name": "twoSides",
                               "id": 1
                           },
                           "fleet": {
                               "fullName": "Flota testowa Sp. z o.o.",
                               "shortName": "Flota testowa",
                               "city": "Warszawa",
                               "zipcode": "00-000",
                               "street": "Broniewskiego",
                               "house": "19",
                               "nip": "000-000-00-00",
                               "regon": null,
                               "contactPerson": "Jan Kowalski",
                               "email": "jan.kowalski@euromaster.com",
                               "phone": "100200300",
                               "fax": null,
                               "lastModified": "2014-10-06T10:09:24+02:00",
                               "isActive": true,
                               "additionalInfo": null,
                               "id": 3
                           }
                       },
                       "fleet": {
                           "fullName": "Flota testowa Sp. z o.o.",
                           "shortName": "Flota testowa",
                           "city": "Warszawa",
                           "zipcode": "00-000",
                           "street": "Broniewskiego",
                           "house": "19",
                           "nip": "000-000-00-00",
                           "regon": null,
                           "contactPerson": "Jan Kowalski",
                           "email": "jan.kowalski@euromaster.com",
                           "phone": "100200300",
                           "fax": null,
                           "lastModified": "2014-10-06T10:09:24+02:00",
                           "isActive": true,
                           "additionalInfo": null,
                           "id": 3
                       },
                       "tyreSegment": null,
                       "vehicleType": {
                           "name": "osobowy",
                           "id": 1
                       },
                       "_links": {
                           "self": {
                               "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
                           }
                       }
                   }
                }
            }
        ]
    }
}

Query Parameters

Parameter Allowed values Description
filter[search] any string Filter results by tyre number, brand or pattern
filter[tyreNumber] any string Filter results by tyre number
filter[brand] any string Filter results by tyre brand
filter[pattern] any string Filter results by tyre pattern
filter[size] any string Filter results by tyre size
filter[aspectRatio] any string Filter results by tyre aspect ratio
filter[diameter] any string Filter results by tyre diameter
filter[li] any string Filter results by load index
filter[si] any string Filter results by speed index
filter[status.key] any string Filter results by status keys, colon separated
filter[season.key] any string Filter results by season keys, colon separated
filter[registrationNumber] any string Filter results by vehicle's registration number
filter[vehicle.id] any string Filter results by exact vehicle ID
filter[servicePoint.id] any string Filter results by exact service point ID
order[tyreNumber] asc, desc Sort results by tyre number default
order[brand] asc, desc Sort results by tyre brand
order[pattern] asc, desc Sort results by tyre pattern
order[size] asc, desc Sort results by tyre size
order[aspectRatio] asc, desc Sort results by tyre aspect ratio
order[diameter] asc, desc Sort results by tyre diameter
order[li] asc, desc Sort results by load index
order[si] asc, desc Sort results by speed index

Get One vehicle tyre

This endpoint retrieves vehicle by its ID.

HTTP Request

GET
/api/v1/vehicle-tyres/<id>

Example of retireve one vehicle tyre by ID:

curl "https://api.fms.euromaster.pl/api/v1/vehicle-tyres/43" \
     -H 'Authorization: Bearer eyJ0eXA...'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/vehicle-tyres/43', {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "tyreNumber": "201010011910121007",
    "brand": "BFGoodrich",
    "pattern": "G-ForceWinter",
    "size": 205,
    "aspectRatio": 60,
    "diameter": 16,
    "li": ".",
    "si": ".",
    "depositNumber": null,
    "dot": null,
    "comment": null,
    "treadDepth": 5.5,
    "lastOperation": "2014-09-29T16:01:53+02:00",
    "depositDate": null,
    "id": 43,
    "tyreSeason": {
        "name": "winter",
        "key": "z"
    },
    "position": {
        "name": "leftFront",
        "key": "LP"
    },
    "statusFrom": {
        "name": "relocation",
        "id": 2
    },
    "status": {
        "name": "givenOut",
        "key": "w"
    },
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres/43"
        }
    },
    "_embedded": {
        "servicePoint": {
            "fullName": "AAA-GUM Jan Kowalski",
            "shortName": "AAA-GUM",
            "city": "Warszawa",
            "zipcode": "01-100",
            "street": "Broniewskiego",
            "house": "1",
            "contactPerson": "Jan Kowalski",
            "phone": "555555555",
            "fax": "555555555",
            "email": "aaagum@example.com",
            "openingMonFri": "08:00-17:00",
            "openingSat": "08:00-13:00",
            "openingSun": null,
            "lastModified": "2016-07-29T13:26:59+02:00",
            "geoLng": "17.254512",
            "geoLat": "51.186234",
            "d2d": false,
            "isActive": true,
            "id": 236,
            "province": {
                "name": "mazowieckie",
                "id": 1
            },
            "serviceHeadOffice": {
                "fullName": "AAA-GUM FH-U Adam Gacki",
                "shortName": "AAA-GUM",
                "city": "Warszawa",
                "zipcode": "01-100",
                "street": "Broniewskiego",
                "house": "10",
                "nip": "000-000-00-00",
                "regon": "000000000",
                "contactPerson": "Jan Kowalski",
                "phone": "555555555",
                "fax": null,
                "email": "aaagum@example.com",
                "www": null,
                "lastModified": "2014-03-21T17:11:56+01:00",
                "isActive": true,
                "id": 467
            }
        },
        "vehicle": {
           "registrationNumber": "WWTEST",
           "vin": "VF7RDRHH4CL514853",
           "company": "Jakaś firma",
           "vehicleBrand": "Ford",
           "vehicleModel": "Fiesta",
           "dateAdded": "2015-05-05T16:50:01+02:00",
           "mileage": 16000,
           "driverData": "Jan Kowalski",
           "driverEmail": "kowalski@example.com",
           "driverPhone": "600500200",
           "lastModified": "2020-08-25T14:46:53+02:00",
           "minTyres": 0,
           "maxTyres": 12,
           "d2d": false,
           "isActive": true,
           "isFpv": false,
           "id": 82702,
           "contract": {
               "name": "Kontrakt testowy",
               "dateStart": "2009-09-01T00:00:00+02:00",
               "dateFinish": null,
               "seasonSummerStart": "2019-03-19T00:00:00+01:00",
               "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
               "seasonWinterStart": "2019-10-01T00:00:00+02:00",
               "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
               "authorizationByService": false,
               "dotRequired": false,
               "diagnosticsActivities": null,
               "planningMethodDuringSeason": null,
               "planningMethodOutOfSeason": null,
               "invoiceSchema": null,
               "reportingDuringSeason": null,
               "reportingOutOfSeason": null,
               "serviceRequestingMethod": null,
               "minTdWinter": "3.4",
               "minTdSummer": "2.3",
               "driverRelocation": false,
               "isActive": false,
               "id": 3,
               "contractType": {
                   "name": "twoSides",
                   "id": 1
               },
               "fleet": {
                   "fullName": "Flota testowa Sp. z o.o.",
                   "shortName": "Flota testowa",
                   "city": "Warszawa",
                   "zipcode": "00-000",
                   "street": "Broniewskiego",
                   "house": "19",
                   "nip": "000-000-00-00",
                   "regon": null,
                   "contactPerson": "Jan Kowalski",
                   "email": "jan.kowalski@euromaster.com",
                   "phone": "100200300",
                   "fax": null,
                   "lastModified": "2014-10-06T10:09:24+02:00",
                   "isActive": true,
                   "additionalInfo": null,
                   "id": 3
               }
           },
           "fleet": {
               "fullName": "Flota testowa Sp. z o.o.",
               "shortName": "Flota testowa",
               "city": "Warszawa",
               "zipcode": "00-000",
               "street": "Broniewskiego",
               "house": "19",
               "nip": "000-000-00-00",
               "regon": null,
               "contactPerson": "Jan Kowalski",
               "email": "jan.kowalski@euromaster.com",
               "phone": "100200300",
               "fax": null,
               "lastModified": "2014-10-06T10:09:24+02:00",
               "isActive": true,
               "additionalInfo": null,
               "id": 3
           },
           "tyreSegment": null,
           "vehicleType": {
               "name": "osobowy",
               "id": 1
           },
           "_links": {
               "self": {
                   "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
               }
           }
       }
    }
}

URL Parameters

Parameter Description
id The ID of the vehicle tyre

Add new vehicle tyre

This endpoint creates new vehicle tyre

HTTP Request

PATCH
/api/v1/vehicle-tyres

Example of update vehicle:

curl -X POST "https://api.fms.euromaster.pl/api/v1/vehicle-tyress" \
     -H 'Authorization: Bearer eyJ0eXA...'
     -H 'Content-Type: application/json' \
     -d '{
       "vehicle": 82702,
       "servicePoint": 236,
       "cai": "123456",
       "brand": "BFGoodrich",
       "pattern": "G-ForceWinter",
       "size": 215,
       "aspectRatio": 55,
       "diameter": 17,
       "li": "99",
       "si": "V",
       "tyreSeason": "l",
       "status": "d",
       "treadDepth": 7.5,
       "dot": "2409",
       "depositNumber": "1001"
     }'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.post('https://api.fms.euromaster.pl/api/v1/vehicle-tyres', {
    "vehicle": 82702,
    "servicePoint": 236,
    "cai": "123456",
    "brand": "BFGoodrich",
    "pattern": "G-ForceWinter",
    "size": 215,
    "aspectRatio": 55,
    "diameter": 17,
    "li": "99",
    "si": "V",
    "tyreSeason": "l",
    "status": "d",
    "treadDepth": 7.5,
    "dot": "2409",
    "depositNumber": "1001"
}, {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
  "tyreNumber": "202404101452374536",
  "cai": "123456",
  "brand": "BFGoodrich",
  "pattern": "G-ForceWinter",
  "size": 215,
  "aspectRatio": 55,
  "diameter": 17,
  "li": "99",
  "si": "V",
  "depositNumber": "1001",
  "dot": "2409",
  "comment": null,
  "treadDepth": 7.5,
  "lastOperation": "2024-04-10T14:52:37+02:00",
  "depositDate": "2024-04-10T14:52:37+02:00",
  "id": 170693,
  "tyreSeason": {
    "name": "summer",
    "key": "l"
  },
  "position": null,
  "statusFrom": {
    "name": "imported",
    "id": 5
  },
  "status": {
    "name": "inDeposit",
    "key": "d"
  },
  "_links": {
    "self": {
      "href": "https://api.fms.euromaster.pl/api/v1/vehicle-tyres/170693"
    }
  },
  "_embedded": {
    "servicePoint": {
      "fullName": "AAA-GUM Jan Kowalski",
      "shortName": "AAA-GUM",
      "city": "Warszawa",
      "zipcode": "01-100",
      "street": "Broniewskiego",
      "house": "1",
      "contactPerson": "Jan Kowalski",
      "phone": "555555555",
      "fax": "555555555",
      "email": "aaagum@example.com",
      "openingMonFri": "08:00-17:00",
      "openingSat": "08:00-13:00",
      "openingSun": null,
      "lastModified": "2016-07-29T13:26:59+02:00",
      "geoLng": "17.254512",
      "geoLat": "51.186234",
      "d2d": false,
      "isActive": true,
      "id": 236,
      "province": {
        "name": "mazowieckie",
        "id": 1
      },
      "serviceHeadOffice": {
        "fullName": "AAA-GUM FH-U Adam Gacki",
        "shortName": "AAA-GUM",
        "city": "Warszawa",
        "zipcode": "01-100",
        "street": "Broniewskiego",
        "house": "10",
        "nip": "000-000-00-00",
        "regon": "000000000",
        "contactPerson": "Jan Kowalski",
        "phone": "555555555",
        "fax": null,
        "email": "aaagum@example.com",
        "www": null,
        "lastModified": "2014-03-21T17:11:56+01:00",
        "isActive": true,
        "id": 467
      }
    },
    "vehicle": {
      "registrationNumber": "WWTEST",
      "vin": "VF7RDRHH4CL514853",
      "company": "Jakaś firma",
      "vehicleBrand": "Ford",
      "vehicleModel": "Fiesta",
      "dateAdded": "2015-05-05T16:50:01+02:00",
      "mileage": 16000,
      "driverData": "Jan Kowalski",
      "driverEmail": "kowalski@example.com",
      "driverPhone": "600500200",
      "lastModified": "2020-08-25T14:46:53+02:00",
      "minTyres": 0,
      "maxTyres": 12,
      "d2d": false,
      "isActive": true,
      "isFpv": false,
      "id": 82702,
      "contract": {
        "name": "Kontrakt testowy",
        "dateStart": "2009-09-01T00:00:00+02:00",
        "dateFinish": null,
        "seasonSummerStart": "2019-03-19T00:00:00+01:00",
        "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
        "seasonWinterStart": "2019-10-01T00:00:00+02:00",
        "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
        "authorizationByService": false,
        "dotRequired": false,
        "diagnosticsActivities": null,
        "planningMethodDuringSeason": null,
        "planningMethodOutOfSeason": null,
        "invoiceSchema": null,
        "reportingDuringSeason": null,
        "reportingOutOfSeason": null,
        "serviceRequestingMethod": null,
        "minTdWinter": "3.4",
        "minTdSummer": "2.3",
        "driverRelocation": false,
        "isActive": false,
        "id": 3,
        "contractType": {
          "name": "twoSides",
          "id": 1
        },
        "fleet": {
          "fullName": "Flota testowa Sp. z o.o.",
          "shortName": "Flota testowa",
          "city": "Warszawa",
          "zipcode": "00-000",
          "street": "Broniewskiego",
          "house": "19",
          "nip": "000-000-00-00",
          "regon": null,
          "contactPerson": "Jan Kowalski",
          "email": "jan.kowalski@euromaster.com",
          "phone": "100200300",
          "fax": null,
          "lastModified": "2014-10-06T10:09:24+02:00",
          "isActive": true,
          "additionalInfo": null,
          "id": 3
        }
      },
      "fleet": {
        "fullName": "Flota testowa Sp. z o.o.",
        "shortName": "Flota testowa",
        "city": "Warszawa",
        "zipcode": "00-000",
        "street": "Broniewskiego",
        "house": "19",
        "nip": "000-000-00-00",
        "regon": null,
        "contactPerson": "Jan Kowalski",
        "email": "jan.kowalski@euromaster.com",
        "phone": "100200300",
        "fax": null,
        "lastModified": "2014-10-06T10:09:24+02:00",
        "isActive": true,
        "additionalInfo": null,
        "id": 3
      },
      "tyreSegment": null,
      "vehicleType": {
        "name": "osobowy",
        "id": 1
      },
      "_links": {
        "self": {
          "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
        }
      }
    }
  }
}

Body Parameters

Parameter Type Required? Description
vehicle int Yes Vehicle ID
servicePoint int Yes Service Point ID
cai string No Tyre CAI number
brand string Yes Tyre brand name
pattern string Yes Tyre pattern name
size string Yes Tyre size
aspectRatio string Yes Tyre aspect ratio
diameter string Yes Tyre diameter
li string Yes Tyre load index
si string Yes Tyre speed index
tyreSeason string Yes Tyre season key. Allowed values: l - summer, z - winter, c - whole year
dot string No Tyre DOT
comment string No Tyre comment
treadDepth float Yes Tyre tread depth
status string Yes Tyre status key. Allowed values: d - In deposit, s - On vehicle

Relocations

Relocation properties

Attribute Type Description
id string Unique identifier for the resource
status object Relocation status. See Relocation - Status properties
sender object Internal sender data. See Service Point properties
recipient object Internal recipient data. See Service Point properties
vehicle object Vehicle to which the relocation is assigned. See Vehicle properties
senderExternalAddress object External sender address data. See Relocation - External address properties
recipientExternalAddress object External recipient address data. See Relocation - External address properties
externalId string External ID
unknownTyres int Number of unknown tyres which should be added by Service Point when receiving relocation
comment string Relocation's comment
errorLog string Any error message if relocation processing fails
user object User data. See Relocation - User properties
dateAdded string Creation date
dateSend string Relocation send to Service Point date
lastRemindSent string Date of last remind email send to Service Point
dateFinished string Finish or cancellation date

Relocation - Status properties

Attribute Type Description
id int Unique identifier for the resource
name string Status code. Should be translated at the end

Relocation - External address properties

Attribute Type Description
service_full_name string Name of Service Point or Customer mandatory
service_street string Street name and house number mandatory
service_city string City or location name mandatory
service_zipcode string Postal code mandatory
contact_name string Contact name
contact_phone string Contact phone number
contact_email string Contact email address

Relocation - User properties

Attribute Type Description
id int Unique identifier for the resource
login string User's login name

Get All relocations

This endpoint retrieves all relocations

HTTP Request

GET
/api/v1/relocations

Example of retireve all relocations:

curl "https://api.fms.euromaster.pl/api/v1/relocations"
  -H 'Authorization: Bearer eyJ0eXA...' \

import {HttpClient as httpClient} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/relocations', {
  headers: headers
}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "_total_items": 6529,
    "_page": 1,
    "_page_count": 262,
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/relocations?page=1"
        },
        "next": {
            "href": "https://api.fms.euromaster.pl/api/v1/relocations?page=2"
        },
        "last": {
            "href": "https://api.fms.euromaster.pl/api/v1/relocations?page=6529"
        }
    },
    "_embedded": {
        "relocations": [
            {
                "senderExternalAddress": {
                    "service_full_name": "Serwis zewnętrzny ABC",
                    "service_street": "Złota 123B/2",
                    "service_city": "Poznań",
                    "service_zipcode": "01-002"
                },
                "recipientExternalAddress": null,
                "dateAdded": "2020-09-22T09:45:32+02:00",
                "consignmentNumber": null,
                "dateSend": null,
                "dateFinished": null,
                "lastRemindSent": null,
                "externalId": null,
                "unknownTyres": null,
                "comment": null,
                "errorLog": null,
                "id": 10140,
                "status": {
                    "name": "relocationStatusNew",
                    "id": 1
                },
                "sender": null,
                "user": {
                    "login": "admin",
                    "id": 35
                },
                "_links": {
                    "self": {
                        "href": "https://api.fms.euromaster.pl/api/v1/relocations/10140"
                    }
                },
                "_embedded": {
                    "recipient": {
                         "fullName": "AAA-GUM Jan Kowalski",
                         "shortName": "AAA-GUM",
                         "city": "Warszawa",
                         "zipcode": "01-100",
                         "street": "Broniewskiego",
                         "house": "1",
                         "contactPerson": "Jan Kowalski",
                         "phone": "555555555",
                         "fax": "555555555",
                         "email": "aaagum@example.com",
                         "openingMonFri": "08:00-17:00",
                         "openingSat": "08:00-13:00",
                         "openingSun": null,
                         "lastModified": "2016-07-29T13:26:59+02:00",
                         "geoLng": "17.254512",
                         "geoLat": "51.186234",
                         "d2d": false,
                         "isActive": true,
                         "id": 236,
                         "province": {
                             "name": "mazowieckie",
                             "id": 1
                         },
                         "serviceHeadOffice": {
                             "fullName": "AAA-GUM FH-U Adam Gacki",
                             "shortName": "AAA-GUM",
                             "city": "Warszawa",
                             "zipcode": "01-100",
                             "street": "Broniewskiego",
                             "house": "10",
                             "nip": "000-000-00-00",
                             "regon": "000000000",
                             "contactPerson": "Jan Kowalski",
                             "phone": "555555555",
                             "fax": null,
                             "email": "aaagum@example.com",
                             "www": null,
                             "lastModified": "2014-03-21T17:11:56+01:00",
                             "isActive": true,
                             "id": 467
                         },
                         "_links": {
                             "self": {
                                 "href": "https://api.fms.euromaster.pl/api/v1/service-points/236"
                             }
                         }
                     },
                    "vehicle": {
                        "registrationNumber": "WWTEST",
                        "vin": "VF7RDRHH4CL514853",
                        "company": "Jakaś firma",
                        "vehicleBrand": "Ford",
                        "vehicleModel": "Fiesta",
                        "dateAdded": "2015-05-05T16:50:01+02:00",
                        "mileage": 16000,
                        "driverData": "Jan Kowalski",
                        "driverEmail": "kowalski@example.com",
                        "driverPhone": "600500200",
                        "lastModified": "2020-08-25T14:46:53+02:00",
                        "minTyres": 0,
                        "maxTyres": 12,
                        "d2d": false,
                        "isActive": true,
                        "isFpv": false,
                        "id": 82702,
                        "contract": {
                            "name": "Kontrakt testowy",
                            "dateStart": "2009-09-01T00:00:00+02:00",
                            "dateFinish": null,
                            "seasonSummerStart": "2019-03-19T00:00:00+01:00",
                            "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
                            "seasonWinterStart": "2019-10-01T00:00:00+02:00",
                            "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
                            "authorizationByService": false,
                            "dotRequired": false,
                            "diagnosticsActivities": null,
                            "planningMethodDuringSeason": null,
                            "planningMethodOutOfSeason": null,
                            "invoiceSchema": null,
                            "reportingDuringSeason": null,
                            "reportingOutOfSeason": null,
                            "serviceRequestingMethod": null,
                            "minTdWinter": "3.4",
                            "minTdSummer": "2.3",
                            "driverRelocation": false,
                            "isActive": false,
                            "id": 3,
                            "contractType": {
                                "name": "twoSides",
                                "id": 1
                            },
                            "fleet": {}
                        },
                        "fleet": {},
                        "tyreSegment": null,
                        "vehicleType": {
                            "name": "osobowy",
                            "id": 1
                        },
                        "_links": {
                            "self": {
                                "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
                            }
                        }
                    }
                }
            }
        ]
    }
}

Query Parameters

Parameter Allowed values Description
filter[registrationNumber] any string Filter results by vehicle's registration number
filter[sender.id] int Filter results by sender ID
filter[recipient.id] int Filter results recipient ID
order[registrationNumber] asc, desc Sort results by vehicle's registration number
order[dateAdded] asc, desc Sort results by creation date default desc

Get One relocation

This endpoint retrieves one relocation by id

HTTP Request

GET
/api/v1/relocations/<id>

Example of retireve one relocation by id:

curl "https://api.fms.euromaster.pl/api/v1/relocations/10140"
  -H 'Authorization: Bearer eyJ0eXA...' \

import {HttpClient as httpClient} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.get('https://api.fms.euromaster.pl/api/v1/relocations/10140', {
  headers: headers
}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "senderExternalAddress": {
        "service_full_name": "Serwis zewnętrzny ABC",
        "service_street": "Złota 123B/2",
        "service_city": "Poznań",
        "service_zipcode": "01-002"
    },
    "recipientExternalAddress": null,
    "dateAdded": "2020-09-22T09:45:32+02:00",
    "consignmentNumber": null,
    "dateSend": null,
    "dateFinished": null,
    "lastRemindSent": null,
    "externalId": null,
    "unknownTyres": null,
    "comment": null,
    "errorLog": null,
    "id": 10140,
    "status": {
        "name": "relocationStatusNew",
        "id": 1
    },
    "sender": null,
    "user": {
        "login": "admin",
        "id": 35
    },
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/relocations/10140"
        }
    },
    "_embedded": {
        "recipient": {
          "fullName": "AAA-GUM Jan Kowalski",
          "shortName": "AAA-GUM",
          "city": "Warszawa",
          "zipcode": "01-100",
          "street": "Broniewskiego",
          "house": "1",
          "contactPerson": "Jan Kowalski",
          "phone": "555555555",
          "fax": "555555555",
          "email": "aaagum@example.com",
          "openingMonFri": "08:00-17:00",
          "openingSat": "08:00-13:00",
          "openingSun": null,
          "lastModified": "2016-07-29T13:26:59+02:00",
          "geoLng": "17.254512",
          "geoLat": "51.186234",
          "d2d": false,
          "isActive": true,
          "id": 236,
          "province": {
            "name": "mazowieckie",
            "id": 1
          },
          "serviceHeadOffice": {
            "fullName": "AAA-GUM FH-U Adam Gacki",
            "shortName": "AAA-GUM",
            "city": "Warszawa",
            "zipcode": "01-100",
            "street": "Broniewskiego",
            "house": "10",
            "nip": "000-000-00-00",
            "regon": "000000000",
            "contactPerson": "Jan Kowalski",
            "phone": "555555555",
            "fax": null,
            "email": "aaagum@example.com",
            "www": null,
            "lastModified": "2014-03-21T17:11:56+01:00",
            "isActive": true,
            "id": 467
          },
          "_links": {
            "self": {
              "href": "https://api.fms.euromaster.pl/api/v1/service-points/236"
            }
          }
        },
        "vehicle": {
            "registrationNumber": "WWTEST",
            "vin": "VF7RDRHH4CL514853",
            "company": "Jakaś firma",
            "vehicleBrand": "Ford",
            "vehicleModel": "Fiesta",
            "dateAdded": "2015-05-05T16:50:01+02:00",
            "mileage": 16000,
            "driverData": "Jan Kowalski",
            "driverEmail": "kowalski@example.com",
            "driverPhone": "600500200",
            "lastModified": "2020-08-25T14:46:53+02:00",
            "minTyres": 0,
            "maxTyres": 12,
            "d2d": false,
            "isActive": true,
            "isFpv": false,
            "id": 82702,
            "contract": {
                "name": "Kontrakt testowy",
                "dateStart": "2009-09-01T00:00:00+02:00",
                "dateFinish": null,
                "seasonSummerStart": "2019-03-19T00:00:00+01:00",
                "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
                "seasonWinterStart": "2019-10-01T00:00:00+02:00",
                "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
                "authorizationByService": false,
                "dotRequired": false,
                "diagnosticsActivities": null,
                "planningMethodDuringSeason": null,
                "planningMethodOutOfSeason": null,
                "invoiceSchema": null,
                "reportingDuringSeason": null,
                "reportingOutOfSeason": null,
                "serviceRequestingMethod": null,
                "minTdWinter": "3.4",
                "minTdSummer": "2.3",
                "driverRelocation": false,
                "isActive": false,
                "id": 3,
                "contractType": {
                    "name": "twoSides",
                    "id": 1
                },
                "fleet": {}
            },
            "fleet": {},
            "tyreSegment": null,
            "vehicleType": {
                "name": "osobowy",
                "id": 1
            },
            "_links": {
                "self": {
                    "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
                }
            }
        }
    }
}

URL Parameters

Parameter Description
id The ID of the relocation

Add new relocation

This endpoint creates new relocation

HTTP Request

POST
/api/v1/relocations

Example of create relocation:

curl -X POST \
  'https://api.fms.euromaster.pl/api/v1/relocations' \
  -H 'Authorization: Bearer eyJ0eXA...' \
  -H 'Content-Type: application/json' \
  -d '{
    "vehicle": 82702,
    "sender": 236,
    "isExternalRecipient": true,
    "recipientExternalAddress": {
      "service_full_name": "Serwis zewnętrzny",
      "service_street": "Konopnickiej 2",
      "service_zipcode": "02-032",
      "service_city": "Gdańsk",
      "contact_name": "Adam Nowak",
      "contact_phone": "555666777",
      "contact_email": "adam@example.com"
    },
    "externalId": "6623",
    "comment": "Test relocation"
}'

import {HttpClient as httpClient, HttpHeaders} from '@angular/common/http';

const headers = new HttpHeaders({'Authorization': 'Bearer eyJ0eXA...'});

httpClient.post('https://api.fms.euromaster.pl/api/v1/relocations', {
    vehicle: 82702,
    sender: 236,
    isExternalRecipient: true,
    recipientExternalAddress: {
      service_full_name: "Serwis zewnętrzny",
      service_street: "Konopnickiej 2",
      service_zipcode: "02-032",
      service_city: "Gdańsk",
      contact_name: "Adam Nowak",
      contact_phone: "555666777",
      contact_email: "adam@example.com"
    },
    externalId: "6623",
    comment: "Test relocation"
}, {headers: headers}).subscribe(response => {
    // do something with response
});

JSON response example:

{
    "senderExternalAddress": null,
    "recipientExternalAddress": {
        "service_full_name": "Serwis zewnętrzny",
        "service_street": "Konopnickiej 2",
        "service_zipcode": "02-032",
        "service_city": "Gdańsk",
        "contact_phone": "555666777",
        "contact_name": "Adam Nowak",
        "contact_email": "adam@example.com"
    },
    "dateAdded": "2020-09-22T14:13:25+02:00",
    "consignmentNumber": null,
    "dateSend": null,
    "dateFinished": null,
    "lastRemindSent": null,
    "externalId": "6623",
    "unknownTyres": null,
    "comment": "Test relocation",
    "errorLog": null,
    "id": 10141,
    "status": {
        "name": "relocationStatusNew",
        "id": 1
    },
    "recipient": null,
    "user": {
        "login": "SYSTEM",
        "id": 999
    },
    "_links": {
        "self": {
            "href": "https://api.fms.euromaster.pl/api/v1/relocations/10141"
        }
    },
    "_embedded": {
        "sender": {
          "fullName": "AAA-GUM Jan Kowalski",
          "shortName": "AAA-GUM",
          "city": "Warszawa",
          "zipcode": "01-100",
          "street": "Broniewskiego",
          "house": "1",
          "contactPerson": "Jan Kowalski",
          "phone": "555555555",
          "fax": "555555555",
          "email": "aaagum@example.com",
          "openingMonFri": "08:00-17:00",
          "openingSat": "08:00-13:00",
          "openingSun": null,
          "lastModified": "2016-07-29T13:26:59+02:00",
          "geoLng": "17.254512",
          "geoLat": "51.186234",
          "d2d": false,
          "isActive": true,
          "id": 236,
          "province": {
              "name": "mazowieckie",
              "id": 1
          },
          "serviceHeadOffice": {
              "fullName": "AAA-GUM FH-U Adam Gacki",
              "shortName": "AAA-GUM",
              "city": "Warszawa",
              "zipcode": "01-100",
              "street": "Broniewskiego",
              "house": "10",
              "nip": "000-000-00-00",
              "regon": "000000000",
              "contactPerson": "Jan Kowalski",
              "phone": "555555555",
              "fax": null,
              "email": "aaagum@example.com",
              "www": null,
              "lastModified": "2014-03-21T17:11:56+01:00",
              "isActive": true,
              "id": 467
          },
          "_links": {
              "self": {
                  "href": "https://api.fms.euromaster.pl/api/v1/service-points/236"
              }
          }
        },
        "vehicle": {
            "registrationNumber": "WWTEST",
            "vin": "VF7RDRHH4CL514853",
            "company": "Jakaś firma",
            "vehicleBrand": "Ford",
            "vehicleModel": "Fiesta",
            "dateAdded": "2015-05-05T16:50:01+02:00",
            "mileage": 16000,
            "driverData": "Jan Kowalski",
            "driverEmail": "kowalski@example.com",
            "driverPhone": "600500200",
            "lastModified": "2020-08-25T14:46:53+02:00",
            "minTyres": 0,
            "maxTyres": 12,
            "d2d": false,
            "isActive": true,
            "isFpv": false,
            "id": 82702,
            "contract": {
                "name": "Kontrakt testowy",
                "dateStart": "2009-09-01T00:00:00+02:00",
                "dateFinish": null,
                "seasonSummerStart": "2019-03-19T00:00:00+01:00",
                "seasonSummerFinish": "2019-06-30T00:00:00+02:00",
                "seasonWinterStart": "2019-10-01T00:00:00+02:00",
                "seasonWinterFinish": "2020-01-31T00:00:00+01:00",
                "authorizationByService": false,
                "dotRequired": false,
                "diagnosticsActivities": null,
                "planningMethodDuringSeason": null,
                "planningMethodOutOfSeason": null,
                "invoiceSchema": null,
                "reportingDuringSeason": null,
                "reportingOutOfSeason": null,
                "serviceRequestingMethod": null,
                "minTdWinter": "3.4",
                "minTdSummer": "2.3",
                "driverRelocation": false,
                "isActive": false,
                "id": 3,
                "contractType": {
                    "name": "twoSides",
                    "id": 1
                },
                "fleet": {}
            },
            "fleet": {},
            "tyreSegment": null,
            "vehicleType": {
                "name": "osobowy",
                "id": 1
            },
            "_links": {
                "self": {
                    "href": "https://api.fms.euromaster.pl/api/v1/vehicles/82702"
                }
            }
        }
    }
}

Body Parameters

Parameter Type Required? Description
vehicle int Yes Vehicle ID
sender int Yes * Sender ID. Only if isExternalSenderAddress is false
recipient int Yes * Recipient ID. Only if isExternalRecipientAddress is false
isExternalSenderAddress boolean No Indicates if sender is external address. Default: false
isExternalRecipientAddress boolean No Indicates if recipient is external address. Default: false
senderExternalAddress object Yes * External sender address data. Only if isExternalSenderAddress is true. See Relocation - External address properties
recipientExternalAddress object Yes * External recipient address data. Only if isExternalRecipientAddress is true. See Relocation - External address properties
externalId string No External Id for custom reference
comment string No Relocation comment
cURL Angular