Trail Asset Management API

This is the API documentation of Trail API.

Authentication

To use this API you have to get an API Token from the Trail service. Once you have the token, you can access the services below by adding the token into the request header:

Authorization: Basic <YOUR API TOKEN>

curl -H "Content-Type: application/json" -H "Authorization: Basic <YOUR API TOKEN>" https://guest.trail.fi/api/v1/items

Getting the Api key

Request the API key from your Trail administrator, or contact our support support@trail.fi.

Items ¶

Get Items
GET`/items{?search,page,per_page}`

Get a list of items.

Example URI

GET https://api.trail.fi/api/v1/items?search=&page=1&per_page=50

URI Parameters

HideShow

search

hash (optional)

Search parameters

For example search[free]=akg

page

integer (optional) Example: 1

Page number

per_page

integer (optional) Example: 50

Number of results per page

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 39,
      "identity": "I100115",
      "model": {
        "id": 510,
        "identity": "M100101",
        "name": "C414B-XLS",
        "manufacturer": "AKG"
      },
      "category": "Microphones",
      "department": null,
      "serial": "10341",
      "created_at": "2019-01-04T14:52:21Z",
      "updated_at": "2019-01-04T14:52:21Z",
      "location": {
        "location": {
          "id": 2,
          "code": "1001",
          "name": "Main Stage"
        }
      }
    }
  ],
  "metadata": {
    "page": 1,
    "total_pages": 1,
    "per_page": 50,
    "total_entries": 4,
    "order_by": null,
    "order_direction": null
  }
}

Create New Item
POST`/items`

Create a new item using a title and an optional content body.

Example URI

POST https://api.trail.fi/api/v1/items

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "department": "Target department name",
  "category": "Model category name",
  "manufacturer": "Manufacturer name",
  "model": {
    "id": 510,
    "identity": "M100101",
    "name": "C414B-XLS",
    "manufacturer": "AKG"
  },
  "location": {
    "type": "location",
    "identity": "Location identity"
  },
  "serial": "",
  "current_user": "",
  "width": "",
  "length": "",
  "height": ""
}

Response 201

Response 401

HideShow

Headers

Content-Type: application/json

Body

{
  "errors": [
    "authentication.api_key.user.no_privileges"
  ]
}

Item ¶

Item description

Get Item
GET`/items/{id}`

Get a single item.

Example URI

GET https://api.trail.fi/api/v1/items/I100115

URI Parameters

HideShow

id: string (required) Example: I100115
The item id or identity.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": 39,
    "identity": "I100115",
    "model": {
      "id": 510,
      "identity": "M100101",
      "name": "C414B-XLS",
      "manufacturer": "AKG"
    },
    "category": "Microphones",
    "department": null,
    "serial": "10341",
    "created_at": "2019-01-04T14:52:21Z",
    "updated_at": "2019-01-04T14:52:21Z",
    "location": {
      "location": {
        "id": 2,
        "code": "1001",
        "name": "Main Stage"
      }
    }
  }
}

Response 400

HideShow

Headers

Content-Type: application/json

Body

{
  "errors": [
    "api.v1.items.not_found"
  ]
}

Update a Item
PUT`/items/{id}`

Example URI

PUT https://api.trail.fi/api/v1/items/I100115

URI Parameters

HideShow

id: string (required) Example: I100115
The item id or identity.

Request

HideShow

Headers

Content-Type: application/json

Body

{
  "department": "Target department name",
  "category": "Model category name",
  "manufacturer": "Manufacturer name",
  "model": {
    "id": 510,
    "identity": "M100101",
    "name": "C414B-XLS",
    "manufacturer": "AKG"
  },
  "location": {
    "type": "location",
    "identity": "Location identity"
  },
  "serial": "",
  "current_user": "",
  "width": "",
  "length": "",
  "height": ""
}

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": {
    "id": 39,
    "identity": "I100115",
    "model": {
      "id": 510,
      "identity": "M100101",
      "name": "C414B-XLS",
      "manufacturer": "AKG"
    },
    "category": "Microphones",
    "department": null,
    "serial": "10341",
    "created_at": "2019-01-04T14:52:21Z",
    "updated_at": "2019-01-04T14:52:21Z",
    "location": {
      "location": {
        "id": 2,
        "code": "1001",
        "name": "Main Stage"
      }
    }
  }
}

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "errors": [
    "api.v1.items.invalid_request"
  ]
}

Delete an Item
DELETE`/items/{id}{?delete_reason,delete_description,permanently}`

Delete a single item

Example URI

DELETE https://api.trail.fi/api/v1/items/I100115?delete_reason=lost&delete_description=Lost during reservation&permanently=false

URI Parameters

HideShow

id: string (required) Example: I100115
The item id or identity.
delete_reason: string (optional) Example: lost
Choices: broken lost other redundant renewed sold wrong stolen recycled
delete_description: string (optional) Example: Lost during reservation
permanently: boolean (optional) Default: false Example: false
If true, the item will be permanently deleted. Do not specify if you want to soft delete the item.

Response 200

Response 404

HideShow

Headers

Content-Type: application/json

Body

{
  "errors": [
    "authentication.api_key.user.no_privileges"
  ]
}

Locations ¶

Group of all location-related resources.

Locations ¶

Get Locations
GET`/locations{?search,page,per_page}`

Get a list of locations.

Example URI

GET https://api.trail.fi/api/v1/locations?search=&page=1&per_page=50

URI Parameters

HideShow

search

array (optional)

Search parameters

For example search[free]=warehouse

page

integer (required) Example: 1

Page number

per_page

integer (required) Example: 50

Number of results per page

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 1,
      "identity": "L100007",
      "code": "K2001",
      "name": "Warehouse",
      "description": null,
      "ancestry": null
    }
  ],
  "metadata": {
    "page": 1,
    "total_pages": 1,
    "per_page": 50,
    "total_entries": 4,
    "order_by": null,
    "order_direction": null
  }
}

Departments ¶

Group of all departments accessible for the user.

Departments ¶

Get Departments
GET`/departments`

Get a list of departments.

Example URI

GET https://api.trail.fi/api/v1/departments

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 1,
      "identity": "L100007",
      "code": "K2001",
      "name": "Warehouse",
      "description": null,
      "ancestry": null,
      "created_at": "2019-01-27T14:57:29+02:00",
      "updated_at": "2019-01-27T14:57:29+02:00"
    }
  ],
  "metadata": {
    "page": 1,
    "total_pages": 1,
    "per_page": 50,
    "total_entries": 4,
    "order_by": null,
    "order_direction": null
  }
}

Models ¶

Group of all model-related resources.

Models ¶

Get Models
GET`/models{?search,page,per_page}`

Get a list of models.

Example URI

GET https://api.trail.fi/api/v1/models?search=&page=1&per_page=50

URI Parameters

HideShow

search

array (optional)

Search parameters

For example search[free]=warehouse

page

integer (required) Example: 1

Page number

per_page

integer (required) Example: 50

Number of results per page

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 1,
      "identity": "M100008",
      "manufacturer": "Manufacturer name",
      "name": "Model name",
      "description": null
    }
  ],
  "metadata": {
    "page": 1,
    "total_pages": 1,
    "per_page": 50,
    "total_entries": 4,
    "order_by": null,
    "order_direction": null
  }
}

Categories ¶

Group of all category-related resources.

Categories ¶

Get Categories
GET`/categories{?search,page,per_page}`

Get a list of categories.

Example URI

GET https://api.trail.fi/api/v1/categories?search=&page=1&per_page=50

URI Parameters

HideShow

search

array (optional)

Search parameters

For example search[free]=microphones

page

integer (required) Example: 1

Page number

per_page

integer (required) Example: 50

Number of results per page

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "data": [
    {
      "id": 1,
      "identity": "L100007",
      "code": "K2001",
      "name": "Warehouse",
      "description": null,
      "ancestry": null,
      "created_at": "2019-01-27T14:57:29+02:00",
      "updated_at": "2019-01-27T14:57:29+02:00"
    }
  ],
  "metadata": {
    "page": 1,
    "total_pages": 1,
    "per_page": 50,
    "total_entries": 4,
    "order_by": null,
    "order_direction": null
  }
}

Authentication ¶

Getting the Api key ¶

Items ¶

Items ¶

Get ItemsGET/items{?search,page,per_page}

Example URI

Headers

Body

Create New ItemPOST/items

Example URI

Headers

Body

Headers

Body

Item ¶

Get ItemGET/items/{id}

Example URI

Headers

Body

Headers

Body

Update a ItemPUT/items/{id}

Example URI

Headers

Body

Headers

Body

Headers

Body

Delete an ItemDELETE/items/{id}{?delete_reason,delete_description,permanently}

Example URI

Headers

Body

Locations ¶

Locations ¶

Get LocationsGET/locations{?search,page,per_page}

Example URI

Headers

Body

Departments ¶

Departments ¶

Get DepartmentsGET/departments

Example URI

Headers

Body

Models ¶

Models ¶

Get ModelsGET/models{?search,page,per_page}

Example URI

Headers

Body

Categories ¶

Categories ¶

Get CategoriesGET/categories{?search,page,per_page}

Example URI

Headers

Body

Authentication

Getting the Api key

Get Items
GET`/items{?search,page,per_page}`

Create New Item
POST`/items`

Get Item
GET`/items/{id}`

Update a Item
PUT`/items/{id}`

Delete an Item
DELETE`/items/{id}{?delete_reason,delete_description,permanently}`

Get Locations
GET`/locations{?search,page,per_page}`

Get Departments
GET`/departments`

Get Models
GET`/models{?search,page,per_page}`

Get Categories
GET`/categories{?search,page,per_page}`