POST api/Client/Definition/GetPeriods

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
Name	string	None.
Status	integer	None.
CompanyId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Name": "sample string 2",
  "Status": 3,
  "CompanyId": 4
}

application/xml, text/xml

Sample:

<PeriodSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities.Models.Client.Definition">
  <CompanyId>4</CompanyId>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Status>3</Status>
</PeriodSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PeriodSearchModel'.

Response Information

Resource Description

ResultModelOfListOfPeriodResponseModel

Name	Type	Additional information
Response	boolean	None.
Message	string	None.
Exception	string	None.
Data	Collection of PeriodResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Message": "sample string 2",
  "Exception": "sample string 3",
  "Data": [
    {
      "Name": "sample string 1",
      "StartDate": "2025-10-25T21:08:22.0239633+03:00",
      "EndDate": "2025-10-25T21:08:22.0239633+03:00",
      "Id": 2,
      "CreatedOn": "2025-10-25T21:08:22.0239633+03:00",
      "ModifiedOn": "2025-10-25T21:08:22.0239633+03:00",
      "Status": 3
    },
    {
      "Name": "sample string 1",
      "StartDate": "2025-10-25T21:08:22.0239633+03:00",
      "EndDate": "2025-10-25T21:08:22.0239633+03:00",
      "Id": 2,
      "CreatedOn": "2025-10-25T21:08:22.0239633+03:00",
      "ModifiedOn": "2025-10-25T21:08:22.0239633+03:00",
      "Status": 3
    }
  ]
}

application/xml, text/xml

Sample:

<ResultModelOfArrayOfPeriodResponseModelIjrq4xa9 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Models.Client.Definition">
    <d2p1:PeriodResponseModel>
      <CreatedOn>2025-10-25T21:08:22.0239633+03:00</CreatedOn>
      <Id>2</Id>
      <ModifiedOn>2025-10-25T21:08:22.0239633+03:00</ModifiedOn>
      <Status>3</Status>
      <d2p1:EndDate>2025-10-25T21:08:22.0239633+03:00</d2p1:EndDate>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:StartDate>2025-10-25T21:08:22.0239633+03:00</d2p1:StartDate>
    </d2p1:PeriodResponseModel>
    <d2p1:PeriodResponseModel>
      <CreatedOn>2025-10-25T21:08:22.0239633+03:00</CreatedOn>
      <Id>2</Id>
      <ModifiedOn>2025-10-25T21:08:22.0239633+03:00</ModifiedOn>
      <Status>3</Status>
      <d2p1:EndDate>2025-10-25T21:08:22.0239633+03:00</d2p1:EndDate>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:StartDate>2025-10-25T21:08:22.0239633+03:00</d2p1:StartDate>
    </d2p1:PeriodResponseModel>
  </Data>
  <Exception>sample string 3</Exception>
  <Message>sample string 2</Message>
  <Response>true</Response>
</ResultModelOfArrayOfPeriodResponseModelIjrq4xa9>