Create a probationary-period

curl --request POST \
  --url https://{host}/lucca-api/probationary-periods \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employment": {
    "id": "4561"
  },
  "initialEndsOn": "2024-04-30"
}
'

import requests

url = "https://{host}/lucca-api/probationary-periods"

payload = {
    "employment": { "id": "4561" },
    "initialEndsOn": "2024-04-30"
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({employment: {id: '4561'}, initialEndsOn: '2024-04-30'})
};

fetch('https://{host}/lucca-api/probationary-periods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/probationary-periods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employment' => [
        'id' => '4561'
    ],
    'initialEndsOn' => '2024-04-30'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/probationary-periods"

	payload := strings.NewReader("{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/lucca-api/probationary-periods")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/probationary-periods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "8721",
  "type": "probationary-period",
  "url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
  "employment": {
    "id": "4561",
    "type": "employment",
    "url": "https://example.ilucca.net/lucca-api/employments/4561"
  },
  "startsOn": "2024-02-01",
  "endsOn": "2024-07-31",
  "initialEndsOn": "2024-04-30",
  "extendedEndsOn": "2024-07-31",
  "createdAt": "2024-03-24T08:21:35.001Z",
  "lastUpdatedAt": "2024-03-24T08:21:35.001Z",
  "links": {},
  "embedded": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 403,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

POST

lucca-api

probationary-periods

Create a probationary-period

curl --request POST \
  --url https://{host}/lucca-api/probationary-periods \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employment": {
    "id": "4561"
  },
  "initialEndsOn": "2024-04-30"
}
'

import requests

url = "https://{host}/lucca-api/probationary-periods"

payload = {
    "employment": { "id": "4561" },
    "initialEndsOn": "2024-04-30"
}
headers = {
    "Api-Version": "<api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Api-Version': '<api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({employment: {id: '4561'}, initialEndsOn: '2024-04-30'})
};

fetch('https://{host}/lucca-api/probationary-periods', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/lucca-api/probationary-periods",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employment' => [
        'id' => '4561'
    ],
    'initialEndsOn' => '2024-04-30'
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Version: <api-version>",
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/lucca-api/probationary-periods"

	payload := strings.NewReader("{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Api-Version", "<api-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/lucca-api/probationary-periods")
  .header("Api-Version", "<api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/lucca-api/probationary-periods")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Version"] = '<api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employment\": {\n    \"id\": \"4561\"\n  },\n  \"initialEndsOn\": \"2024-04-30\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "8721",
  "type": "probationary-period",
  "url": "https://example.ilucca.net/lucca-api/probationary-periods/8721",
  "employment": {
    "id": "4561",
    "type": "employment",
    "url": "https://example.ilucca.net/lucca-api/employments/4561"
  },
  "startsOn": "2024-02-01",
  "endsOn": "2024-07-31",
  "initialEndsOn": "2024-04-30",
  "extendedEndsOn": "2024-07-31",
  "createdAt": "2024-03-24T08:21:35.001Z",
  "lastUpdatedAt": "2024-03-24T08:21:35.001Z",
  "links": {},
  "embedded": {}
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "instance": "https://example.ilucca.net/lucca-api/leaves/1573",
  "errors": {
    "endsOn": [
      "Invalid period: StartsOn should be before EndsOn."
    ],
    "employeeId": [
      "The employeeId query parameter is required."
    ]
  },
  "extensions": {
    "traceId": "|78777424-49cc27e04281bbfc."
  }
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://datatracker.ietf.org/doc/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 403,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Internal Server Error",
  "status": 500,
  "instance": "https://example.ilucca.net/lucca-api/employees/1573"
}

This API endpoint is in beta and may be subject to changes, including breaking changes (similarly to the legacy API endpoints), without prior notice. Read more about versioning.

Access

OAuth 2.0 scopes

 probationary-periods.readwrite

EstablishmentsThis API endpoint will filter out results based on accessible business-establishments.You may only access probationary-periods belonging to employees whose applicable business-establishments are accessible to you.

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

include

enum<string>[]

Include metadata:

embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Body

application/json

Representation of a probationary-period.

The probationary-period to create.

employment

employment-reference · object

required

Reference to an employment resource.

Show child attributes

initialEndsOn

string<date>

required

Initial end date of the probationary-period. Required upon creation.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

extendedEndsOn

null | string<date>

End date of the probationary-period in case it was extended.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

Response

Created

The created probationary-period resource.

string

Minimum string length: 1

type

string

Allowed value: "probationary-period"

url

string<uri>

employment

employment-reference · object

The employment this probationary-period applies to. Cannot be modified once the probationary-period is created.

Show child attributes

startsOn

string<date>

Read-only. Equal to the related employment start date.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

endsOn

string<date>

Read-only. End date of the probationary-period, equal to extendedEndsOn if not null, and initialEndsOn otherwise.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

initialEndsOn

string<date>

Initial end date of the probationary-period. Required upon creation.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

extendedEndsOn

null | string<date>

End date of the probationary-period in case it was extended.

Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

createdAt

string<date-time>

Read-only. UTC timestamp of the moment this object was created. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt

string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object. The UTC offset may be written Z or +00:00, with up to 7 fractional digits of a second.

Examples:

"2023-01-23T12:45:23.1234567+00:00"

"2023-01-23T12:45:23.1234Z"

links

object

embedded

object | null

No embedded resources on a probationary-period(s) response. Expect an empty object if embedded are requested.

Overview

Files

Organization

Employee Records

Time Management

Events & Webhooks

Create a probationary-period

Authorizations

Headers

Query Parameters

Body

Response