APIPeriod

Create Period

This endpoint allows an admin user to create a new period with a specified name, start date, and end date.

POST/Period/CreatePeriod

Authorization

AuthorizationRequiredBearer <token>

Authorization header using the Bearer scheme. Example: "Bearer {token}"

In: header

Query Parameters

Namestring

The name of the period to be created.

StartDatestring

The start date of the period to be created.

Format: "date-time"
EndDatestring

The end date of the period to be created.

Format: "date-time"
curl -X POST "https://example.com/Period/CreatePeriod?Name=%3Cstring%3E&StartDate=2019-08-24T14%3A15%3A22Z&EndDate=2019-08-24T14%3A15%3A22Z" \
  -H "Authorization: Bearer <token>"

Returns the created period.

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Period

Previous Page

Delete Period

This endpoint allows an admin user to delete a specific period by its ID.