Create Location Entry

POST 
https://secure.fleetio.com/api/v1/location_entries

Create a new LocationEntry for a Vehicle or for a Contact. If you need to create many Location Entries at once, use the Bulk API to avoid Rate Limiting errors.

Request

application/json

Body

anyOf
For Contact

contact_idId (integer)required

Possible values: >= 1

datedate-timerequired

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14T13:46:27-06:00

latitudeCoordinate (number)required

Possible values: >= -90 and <= 90

longitudeCoordinate (number)required

Possible values: >= -90 and <= 90

For Vehicle

vehicle_idId (integer)required

Possible values: >= 1

datedate-timerequired

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14T13:46:27-06:00

latitudeCoordinate (number)required

Possible values: >= -90 and <= 90

longitudeCoordinate (number)required

Possible values: >= -90 and <= 90

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

account_idId (integer)required

Possible values: >= 1

datedate-timerequired

The date and time at which this Location Entry was recorded.

Example: 2023-03-14T13:46:27-06:00

item_typestringrequired

The type of object that this Location Entry is associated with.

Possible values: [Vehicle, Contact]

item_idNullableId (integer)nullablerequired

Possible values: >= 1

locatable_typestringnullablerequired

The type of object that triggered the creation of this Location Entry, if applicable.

Possible values: [FuelEntry, ServiceEntry, SubmittedInspectionForm]

locatable_idNullableId (integer)nullablerequired

Possible values: >= 1

contact_idNullableId (integer)nullablerequired

Possible values: >= 1

addressstringnullablerequired

The full address where this Location Entry took place.

address_components objectnullablerequired

street_numberstring

The street number in the address.

streetstring

The street name in the address.

citystring

The city in the address.

regionstring

The region, state or province in the address.

region_shortstring

The abbreviated region, state or province code.

countrystring

The country in the address.

country_shortstring

The abbreviated country code.

postal_codestring

The postal code, ZIP, or equivalent in the address.

is_currentbooleanrequired

Indicates whether this Location Entry is the most recent one for this object.

locationstringrequired

A string representation of the recorded location.

Example: POINT (33.515000,-86.807610)

account_membership_idNullableId (integer)nullablerequired

Possible values: >= 1

vehicle_archived_atdate-timenullablerequired

The date and time at which the Vehicle associated with this Location Entry was archived, if applicable.

contact_archived_atdate-timenullablerequired

The date and time at which the Contact associated with this Location Entry was archived, if applicable.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "item_type": "Vehicle",
  "item_id": 0,
  "locatable_type": "FuelEntry",
  "locatable_id": 0,
  "contact_id": 0,
  "address": "string",
  "address_components": {
    "street_number": "string",
    "street": "string",
    "city": "string",
    "region": "string",
    "region_short": "string",
    "country": "string",
    "country_short": "string",
    "postal_code": "string"
  },
  "is_current": true,
  "location": "POINT (33.515000,-86.807610)",
  "account_membership_id": 0,
  "vehicle_archived_at": "2024-07-29T15:51:28.071Z",
  "contact_archived_at": "2024-07-29T15:51:28.071Z"
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/location_entries' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "contact_id": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "latitude": 0,
  "longitude": 0
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "contact_id": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "latitude": 0,
  "longitude": 0
}

ResponseClear

Click the Send API Request button above and see the response here!