POST api/Client/Definition/GetOffices

Request Information

URI Parameters

None.

Body Parameters

OfficeSearchModel
NameDescriptionTypeAdditional information
Name

string

None.

CompanyId

integer

None.

Id

integer

None.

CreatedOn

date

None.

ModifiedOn

date

None.

Status

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "CompanyId": 2,
  "Id": 3,
  "CreatedOn": "2025-10-25T21:04:36.2083124+03:00",
  "ModifiedOn": "2025-10-25T21:04:36.2083124+03:00",
  "Status": 4
}

application/xml, text/xml

Sample:
<OfficeSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities.Models.Client.Definition">
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">2025-10-25T21:04:36.2083124+03:00</CreatedOn>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">3</Id>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">2025-10-25T21:04:36.2083124+03:00</ModifiedOn>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">4</Status>
  <CompanyId>2</CompanyId>
  <Name>sample string 1</Name>
</OfficeSearchModel>

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 'OfficeSearchModel'.

Response Information

Resource Description

ResultModelOfListOfOfficeResponseModel
NameDescriptionTypeAdditional information
Response

boolean

None.

Message

string

None.

Exception

string

None.

Data

Collection of OfficeResponseModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Response": true,
  "Message": "sample string 2",
  "Exception": "sample string 3",
  "Data": [
    {
      "Name": "sample string 1",
      "SmsCompanyId": 1,
      "SmsUserName": "sample string 2",
      "SmsPassword": "sample string 3",
      "SmsOriginator": "sample string 4",
      "SmsCompanyCode": "sample string 5",
      "SmsSendHour": "sample string 6",
      "SmsLimit": 1,
      "IsSendSms": 1,
      "RemindReservation": 1,
      "RemindReservationSteeringExam": 1,
      "Id": 7,
      "CreatedOn": "2025-10-25T21:04:36.2083124+03:00",
      "ModifiedOn": "2025-10-25T21:04:36.2083124+03:00",
      "Status": 8
    },
    {
      "Name": "sample string 1",
      "SmsCompanyId": 1,
      "SmsUserName": "sample string 2",
      "SmsPassword": "sample string 3",
      "SmsOriginator": "sample string 4",
      "SmsCompanyCode": "sample string 5",
      "SmsSendHour": "sample string 6",
      "SmsLimit": 1,
      "IsSendSms": 1,
      "RemindReservation": 1,
      "RemindReservationSteeringExam": 1,
      "Id": 7,
      "CreatedOn": "2025-10-25T21:04:36.2083124+03:00",
      "ModifiedOn": "2025-10-25T21:04:36.2083124+03:00",
      "Status": 8
    }
  ]
}

application/xml, text/xml

Sample:
<ResultModelOfArrayOfOfficeResponseModelIjrq4xa9 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:OfficeResponseModel>
      <CreatedOn>2025-10-25T21:04:36.2083124+03:00</CreatedOn>
      <Id>7</Id>
      <ModifiedOn>2025-10-25T21:04:36.2083124+03:00</ModifiedOn>
      <Status>8</Status>
      <d2p1:IsSendSms>1</d2p1:IsSendSms>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:RemindReservation>1</d2p1:RemindReservation>
      <d2p1:RemindReservationSteeringExam>1</d2p1:RemindReservationSteeringExam>
      <d2p1:SmsCompanyCode>sample string 5</d2p1:SmsCompanyCode>
      <d2p1:SmsCompanyId>1</d2p1:SmsCompanyId>
      <d2p1:SmsLimit>1</d2p1:SmsLimit>
      <d2p1:SmsOriginator>sample string 4</d2p1:SmsOriginator>
      <d2p1:SmsPassword>sample string 3</d2p1:SmsPassword>
      <d2p1:SmsSendHour>sample string 6</d2p1:SmsSendHour>
      <d2p1:SmsUserName>sample string 2</d2p1:SmsUserName>
    </d2p1:OfficeResponseModel>
    <d2p1:OfficeResponseModel>
      <CreatedOn>2025-10-25T21:04:36.2083124+03:00</CreatedOn>
      <Id>7</Id>
      <ModifiedOn>2025-10-25T21:04:36.2083124+03:00</ModifiedOn>
      <Status>8</Status>
      <d2p1:IsSendSms>1</d2p1:IsSendSms>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:RemindReservation>1</d2p1:RemindReservation>
      <d2p1:RemindReservationSteeringExam>1</d2p1:RemindReservationSteeringExam>
      <d2p1:SmsCompanyCode>sample string 5</d2p1:SmsCompanyCode>
      <d2p1:SmsCompanyId>1</d2p1:SmsCompanyId>
      <d2p1:SmsLimit>1</d2p1:SmsLimit>
      <d2p1:SmsOriginator>sample string 4</d2p1:SmsOriginator>
      <d2p1:SmsPassword>sample string 3</d2p1:SmsPassword>
      <d2p1:SmsSendHour>sample string 6</d2p1:SmsSendHour>
      <d2p1:SmsUserName>sample string 2</d2p1:SmsUserName>
    </d2p1:OfficeResponseModel>
  </Data>
  <Exception>sample string 3</Exception>
  <Message>sample string 2</Message>
  <Response>true</Response>
</ResultModelOfArrayOfOfficeResponseModelIjrq4xa9>