Absence Periods

Creates an absence period

Creates an absence period for a user and assigns the substitutes who take over that user’s actions while they are away.

Each substitute is a stakeholder of type person, group or contactgroup (the same stakeholder types used elsewhere in the API) and is assigned one or more action types - approver, receiver, signer or formFiller. A substitute can optionally be allowed to reassign packages to another user.

The created absence period, and each of its substitutes, is returned with a generated Id.

POST

absenceperiods

Error

A valid request URL is required to generate request examples

{
  "Id": "b459d74c-1f90-4d63-9f4a-6de9cead8c5e",
  "User": "ada.rodriguez@comp.com",
  "StartDate": "2024-12-20T08:00:00+0200",
  "EndDate": "2025-01-01T08:00:00+0200",
  "Substitutes": [
    {
      "Id": "1fdbad81-75e5-4cc8-b113-39255fa119d7",
      "Type": "person",
      "ActionTypes": [
        "signer",
        "receiver"
      ],
      "AllowedToReassign": true,
      "Language": "en",
      "Title": "Ms.",
      "FirstName": "Jane",
      "LastName": "Doe",
      "EmailAddress": "jane.doe@comp.com"
    }
  ]
}

[
  {
    "ErrorCode": "Name.MinimumLength:6",
    "ErrorMessage": "The minimum length for a name is 6"
  }
]

[
  {
    "ErrorCode": "User.NotFound",
    "ErrorMessage": "No user found with email address [hello@world.test]."
  }
]

[
  {
    "ErrorCode": "AbsencePeriod.OverlapsWithExistingAbsencePeriod",
    "ErrorMessage": "The provided absence period overlaps with an existing absence period."
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Parameters for creating an absence period

User

string<email>

required

The user's email address

Example:

"hello@world.test"

StartDate

string<date-time>

required

The start of this absence period

EndDate

string<date-time>

The end of this absence period

Substitutes

(Person substitute · object | Group substitute · object | Contact group substitute · object)[]

The substitutes assigned for this absence period

A person that can replace a stakeholder to perform an action in a package

Person substitute
Group substitute
Contact group substitute

Show child attributes

Response

Absence period was created

An absence period id

string<guid>

required

This absence period's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

User

string<email>

required

The user's email address

Example:

"hello@world.test"

StartDate

string<date-time>

required

The start of this absence period

EndDate

string<date-time>

The end of this absence period

Substitutes

(Person substitute · object | Group substitute · object | Contact group substitute · object)[]

The substitutes assigned for this absence period

A person that can replace a stakeholder to perform an action in a package

Person substitute
Group substitute
Contact group substitute

Show child attributes

Gets absence periods by email addressRetrieves the absence periods configured for a user, identified by email address. The response shape matches the create-absence-period operation.

Error

A valid request URL is required to generate request examples

{
  "Id": "b459d74c-1f90-4d63-9f4a-6de9cead8c5e",
  "User": "ada.rodriguez@comp.com",
  "StartDate": "2024-12-20T08:00:00+0200",
  "EndDate": "2025-01-01T08:00:00+0200",
  "Substitutes": [
    {
      "Id": "1fdbad81-75e5-4cc8-b113-39255fa119d7",
      "Type": "person",
      "ActionTypes": [
        "signer",
        "receiver"
      ],
      "AllowedToReassign": true,
      "Language": "en",
      "Title": "Ms.",
      "FirstName": "Jane",
      "LastName": "Doe",
      "EmailAddress": "jane.doe@comp.com"
    }
  ]
}

[
  {
    "ErrorCode": "Name.MinimumLength:6",
    "ErrorMessage": "The minimum length for a name is 6"
  }
]

[
  {
    "ErrorCode": "User.NotFound",
    "ErrorMessage": "No user found with email address [hello@world.test]."
  }
]

[
  {
    "ErrorCode": "AbsencePeriod.OverlapsWithExistingAbsencePeriod",
    "ErrorMessage": "The provided absence period overlaps with an existing absence period."
  }
]

Product updates

NSEV WebPortal API

Creates an absence period

Authorizations

Body

Response