API Reference

Endpoint

POST /v1/memberships/{contractId}/self-service/idle-periods/validate

Path Parameters

contractId required integer (int64)

Unique ID of the contract

Request Body application/json

required

Represents an idle period validation request

startDate string(date) required

Start date of the idle period

temporalUnit required

Represents the temporal unit of an idle period

Allowed values:

`DAY`	Represents a daily temporal unit of the idle period. Can be used for day pickers only.
`WEEK`	Represents a weekly temporal unit of the idle period. Can be used for week pickers only. Supports only full weeks.
`MONTH`	Represents a monthly temporal unit of the idle period. Can be used for month pickers only. Supports only full months.

Example: "WEEK"

termValue integer(int32) required

Duration term of the idle period. The field is related to the temporal unit

Example: 1

Responses

Response Body application/json

Idle period validation status

validationStatus required

Status of the idle period validation

Allowed values:

`IDLEPERIOD_DEACTIVATED_FOR_CONTRACT`	Idle periods are deactivated for the contract.
`IDLEPERIOD_PENDING_VERIFICATION`	Idle periods cannot be created if a pending verification for an amendment exists.
`IDLEPERIOD_DATE_NOT_FIRSTDAY_OF_TEMPORALUNIT`	The idle period start date must be the first day of the period, defined by the temporal unit (DAY -> same day, WEEK -> start day of the week, MONTH -> start date of the month).
`IDLEPERIOD_DEADLINE_VIOLATED`	The start date violates the submission deadline.
`IDLEPERIOD_EXPECTED_STARTDATE_MISMATCH`	The idle period start date does not match the expected start date.
`IDLEPERIOD_MAXIMUM_YEARS_VIOLATED`	5 years is a hard limit for the length of the idle period.
`IDLEPERIOD_OVERLAPPING`	The idle period is overlapping existing idle periods.
`IDLEPERIOD_TEMPORALUNIT_INVALID`	The temporal unit must match the temporal unit of the config.
`IDLEPERIOD_MAXIMUM_TERMS_VIOLATED`	The idle period violates the maximum terms value.
`IDLEPERIOD_CREATABLE`	The idle period can be created.

Example: "IDLEPERIOD_DEACTIVATED_FOR_CONTRACT"

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST

reference

Reference to validation error

Example: "parent.child"

Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"