Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Resources

Get a resource

Retrieve the details of a single resource (required scope resources:read)

get/v1/resources/{resourceId}

Path parameters

resourceIdinteger required

The unique identifer of the resource

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the resource

createdAtstring date-time

The UTC timestamp of when this resource was created

referencestring

The internal reference of the resource - should usually be unique

namestring

The full name of the resource

groupIdinteger

The unique identifier of the resource's group

groupNamestring

The name of the resource's group

mobilestring nullable

The mobile telephone number of the resource

timeZoneIdstring

The id of the timezone that the resource operates in

maxTravelDistanceinteger nullable

The maximum number of kilometres the resource will travel from start location (as crow flies)

fuelCardstring nullable

The fuel card number associated to the resource

businessKeystring nullable

The number associated to the resources business key

privateKeystring nullable

The number associated to the resources private key

tachoCardstring nullable

The tachograph driver card number associated to the resource

isTrackedboolean

Indicates whether tracking data should be collected for this resource

isTrackedOutOfHoursboolean

Indicates whether out of working hour tracking data is private

Example response

{
  "id": 5514123,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "reference": "XYZ12345",
  "name": "David Smith",
  "groupId": 441122,
  "groupName": "Plumbers",
  "mobile": "+447812 123112",
  "timeZoneId": "GMT Standard Time",
  "maxTravelDistance": 5,
  "fuelCard": "01234567891234",
  "businessKey": "1231231",
  "privateKey": "414221",
  "tachoCard": "DRI0RDW0000000100",
  "isTracked": true,
  "workingHours": [
    {
      "dayOfWeek": "sunday",
      "start": "09:00",
      "stop": "17:00",
      "startAtContactId": 1241551,
      "startAtLocation": {
        "latitude": 51.31349,
        "longitude": -0.7464233
      }
    }
  ],
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}