POST api/orders/filter?RqUID={RqUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
RqUID		string	None.

Body Parameters

RestOrderFilterDTO

Name	Type	Additional information
OrderId	integer	None.
OrderNumber	string	None.
ExpedientNumber	string	None.
ExpedientNumberExact	string	None.
EstimateId	string	None.
EstimateIdExact	string	None.
CompanyCommercialName	string	None.
CompanyId	integer	None.
RequesterCommercialName	string	None.
CreatorUserName	string	None.
CreateDateFrom	date	None.
CreateDateUntil	date	None.
VehicleOdometer	integer	None.
VehicleLicense	string	None.
VehicleVin	string	None.
VehicleBrand	string	None.
VehicleModel	string	None.
OrderStep	integer	Range: inclusive between 1 and 5
OrderState	integer	Range: inclusive between 1 and 6

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "OrderNumber": "sample string 1",
  "ExpedientNumber": "sample string 2",
  "ExpedientNumberExact": "sample string 3",
  "EstimateId": "sample string 4",
  "EstimateIdExact": "sample string 5",
  "CompanyCommercialName": "sample string 6",
  "CompanyId": 1,
  "RequesterCommercialName": "sample string 7",
  "CreatorUserName": "sample string 8",
  "CreateDateFrom": "2025-04-29T18:16:19.993476+02:00",
  "CreateDateUntil": "2025-04-29T18:16:19.993476+02:00",
  "VehicleOdometer": 1,
  "VehicleLicense": "sample string 9",
  "VehicleVin": "sample string 10",
  "VehicleBrand": "sample string 11",
  "VehicleModel": "sample string 12",
  "OrderStep": 1,
  "OrderState": 1
}

application/xml, text/xml

Sample:

<RestOrderFilterDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Order">
  <CompanyCommercialName>sample string 6</CompanyCommercialName>
  <CompanyId>1</CompanyId>
  <CreateDateFrom>2025-04-29T18:16:19.993476+02:00</CreateDateFrom>
  <CreateDateUntil>2025-04-29T18:16:19.993476+02:00</CreateDateUntil>
  <CreatorUserName>sample string 8</CreatorUserName>
  <EstimateId>sample string 4</EstimateId>
  <EstimateIdExact>sample string 5</EstimateIdExact>
  <ExpedientNumber>sample string 2</ExpedientNumber>
  <ExpedientNumberExact>sample string 3</ExpedientNumberExact>
  <OrderId>1</OrderId>
  <OrderNumber>sample string 1</OrderNumber>
  <OrderState>1</OrderState>
  <OrderStep>1</OrderStep>
  <RequesterCommercialName>sample string 7</RequesterCommercialName>
  <VehicleBrand>sample string 11</VehicleBrand>
  <VehicleLicense>sample string 9</VehicleLicense>
  <VehicleModel>sample string 12</VehicleModel>
  <VehicleOdometer>1</VehicleOdometer>
  <VehicleVin>sample string 10</VehicleVin>
</RestOrderFilterDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RestListResponseDTOOfRestOrderDTO

Name	Type	Additional information
Count	integer	None.
List	Collection of RestOrderDTO	None.
RqUID	string	None.
Code	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Count": 1,
  "List": [
    {
      "Id": 1,
      "OrderStep": 1,
      "OrderState": 1,
      "OrderNumber": "sample string 2",
      "ExpedientNumber": "sample string 3",
      "EstimateNumber": "sample string 4",
      "Requester": {
        "BOEntity": "sample string 1",
        "FirmName": "sample string 2",
        "CommercialName": "sample string 3"
      },
      "Company": {
        "Code": "sample string 1",
        "FirmName": "sample string 2",
        "CommercialName": "sample string 3"
      },
      "Vehicle": {
        "Odometer": 1,
        "License": "sample string 1",
        "Vin": "sample string 2",
        "Brand": "sample string 3",
        "Model": "sample string 4"
      }
    },
    {
      "Id": 1,
      "OrderStep": 1,
      "OrderState": 1,
      "OrderNumber": "sample string 2",
      "ExpedientNumber": "sample string 3",
      "EstimateNumber": "sample string 4",
      "Requester": {
        "BOEntity": "sample string 1",
        "FirmName": "sample string 2",
        "CommercialName": "sample string 3"
      },
      "Company": {
        "Code": "sample string 1",
        "FirmName": "sample string 2",
        "CommercialName": "sample string 3"
      },
      "Vehicle": {
        "Odometer": 1,
        "License": "sample string 1",
        "Vin": "sample string 2",
        "Brand": "sample string 3",
        "Model": "sample string 4"
      }
    }
  ],
  "RqUID": "sample string 2",
  "Code": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<RestListResponseDTOOfRestOrderDTOzCdi0SAh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Shared">
  <Code>sample string 3</Code>
  <Message>sample string 4</Message>
  <RqUID>sample string 2</RqUID>
  <Count>1</Count>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/GtMotive.GtGlobal.Common.DTO.Rest.Order">
    <d2p1:RestOrderDTO>
      <d2p1:Company>
        <CommercialName>sample string 3</CommercialName>
        <FirmName>sample string 2</FirmName>
        <Code>sample string 1</Code>
      </d2p1:Company>
      <d2p1:EstimateNumber>sample string 4</d2p1:EstimateNumber>
      <d2p1:ExpedientNumber>sample string 3</d2p1:ExpedientNumber>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:OrderNumber>sample string 2</d2p1:OrderNumber>
      <d2p1:OrderState>DRAFT</d2p1:OrderState>
      <d2p1:OrderStep>ORDER_DATA</d2p1:OrderStep>
      <d2p1:Requester>
        <CommercialName>sample string 3</CommercialName>
        <FirmName>sample string 2</FirmName>
        <BOEntity>sample string 1</BOEntity>
      </d2p1:Requester>
      <d2p1:Vehicle>
        <d2p1:Brand>sample string 3</d2p1:Brand>
        <d2p1:License>sample string 1</d2p1:License>
        <d2p1:Model>sample string 4</d2p1:Model>
        <d2p1:Odometer>1</d2p1:Odometer>
        <d2p1:Vin>sample string 2</d2p1:Vin>
      </d2p1:Vehicle>
    </d2p1:RestOrderDTO>
    <d2p1:RestOrderDTO>
      <d2p1:Company>
        <CommercialName>sample string 3</CommercialName>
        <FirmName>sample string 2</FirmName>
        <Code>sample string 1</Code>
      </d2p1:Company>
      <d2p1:EstimateNumber>sample string 4</d2p1:EstimateNumber>
      <d2p1:ExpedientNumber>sample string 3</d2p1:ExpedientNumber>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:OrderNumber>sample string 2</d2p1:OrderNumber>
      <d2p1:OrderState>DRAFT</d2p1:OrderState>
      <d2p1:OrderStep>ORDER_DATA</d2p1:OrderStep>
      <d2p1:Requester>
        <CommercialName>sample string 3</CommercialName>
        <FirmName>sample string 2</FirmName>
        <BOEntity>sample string 1</BOEntity>
      </d2p1:Requester>
      <d2p1:Vehicle>
        <d2p1:Brand>sample string 3</d2p1:Brand>
        <d2p1:License>sample string 1</d2p1:License>
        <d2p1:Model>sample string 4</d2p1:Model>
        <d2p1:Odometer>1</d2p1:Odometer>
        <d2p1:Vin>sample string 2</d2p1:Vin>
      </d2p1:Vehicle>
    </d2p1:RestOrderDTO>
  </List>
</RestListResponseDTOOfRestOrderDTOzCdi0SAh>