GET Api/TimeSettings/GetPeriods?date={date}

Obtains a list of periods to be used in period views inside web clients.

Request Information

URI Parameters

Name	Description	Type	Additional information
date		date	Required

Body Parameters

None.

Response Information

Resource Description

Collection of WebPeriodInfo

Name	Type	Additional information
PeriodNumber	integer	None.
StartDate	date	None.
EndDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PeriodNumber": 1,
    "StartDate": "2024-12-22T00:19:28.4167406+01:00",
    "EndDate": "2024-12-22T00:19:28.4167406+01:00"
  },
  {
    "PeriodNumber": 1,
    "StartDate": "2024-12-22T00:19:28.4167406+01:00",
    "EndDate": "2024-12-22T00:19:28.4167406+01:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWebPeriodInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paralax.Cas.Web.WebServices.Models">
  <WebPeriodInfo>
    <PeriodNumber>1</PeriodNumber>
    <StartDate>2024-12-22T00:19:28.4167406+01:00</StartDate>
    <EndDate>2024-12-22T00:19:28.4167406+01:00</EndDate>
  </WebPeriodInfo>
  <WebPeriodInfo>
    <PeriodNumber>1</PeriodNumber>
    <StartDate>2024-12-22T00:19:28.4167406+01:00</StartDate>
    <EndDate>2024-12-22T00:19:28.4167406+01:00</EndDate>
  </WebPeriodInfo>
</ArrayOfWebPeriodInfo>