NextGen APIs

GET territory/organizational-structures/r1/structures/{structureId}/validity-period

Http Verb

GET

Url

territory/organizational-structures/r1/structures/{structureId}/validity-period

Permissions required

Organizational Structure Entities: View (fsm.core.structure.view)

or

Organizational Structure Entities: Edit (fsm.core.structure.edit)

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W2 (FSM 17.0)

Deprecated since

 

Removed since

 

Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of Structure Validity Periods filtered by input criteria

Path Parameters

Field

Note

structureId


Query String Parameters

Filter ℹ️

Field

Validations

Note

id


Collection of Ids

startDate



endDate



originalPeriod



structure



Order ℹ️

Default Order

startDate (ASC)

Possible order values

all response payload fields

Page ℹ️

Default.

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id


startDate


endDate


originalPeriod


structure


Response error codes

BASE_0001