Create a resource

Create a new resource (required scope resources:write)

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

reference string nullable

The internal reference of the resource - should usually be unique

name string required

Possible values: non-empty

The full name of the resource

groupId int64 required

The unique identifier of the resource's group

mobile string nullable

The mobile telephone number of the resource

maxTravelDistance int32 nullable

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

fuelCard string nullable

The fuel card number associated to the resource

businessKey string nullable

The number associated to the resources business key

privateKey string nullable

The number associated to the resources private key

tachoCard string nullable

The tachograph driver card number associated to the resource

isTracked boolean

Indicates whether tracking data should be collected for this resource

isTrackedOutOfHours boolean

Indicates whether out of working hour tracking data is private

workingHours object[] nullable
The resources working hours / shifts, expressed relative to timeZoneId
Array [
dayOfWeek DayOfWeek required
Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
Possible values:
• sunday
• monday
• tuesday
• wednesday
• thursday
• friday
• saturday
start time required
The 24H format time of day that the resource starts their shift (hh:mm)
stop time required
The 24H format time of day that the resource stops their shift (hh:mm)
startAtContactId int64 nullable
The unique identifier of the contact (location) that the resource starts this shift from
]
customFields object[] nullable
Custom fields associated with the resource
Array [
definitionId int64 required
The unique identifier of the associated custom field definition
value string nullable
The value of this custom field. If set to null, any existing value will be unset
]

Responses

• 201
• 400
• 403
• 422
• 500

---

Created

application/json

Schema

Example (from schema)

---

Schema

id int64

Identifier of the newly created record

{
  "id": 0
}

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

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

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

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

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

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

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

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

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

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

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...