OfficeGest
Workshop/Processes

List workshop processes

Returns a paginated list of workshop processes with vehicle, owner and customer details.

GET
/workshop/processes
AuthorizationBearer <token>

In: header

Query Parameters

plate?stringDeprecated

Filter by vehicle plate (eq, ct, sw)

status_id?integerDeprecated

Filter by process status ID (eq, in)

customer_id?integerDeprecated

Filter by billing customer ID (eq)

owner_customer_id?integerDeprecated

Filter by vehicle owner customer ID (eq)

created_at?stringDeprecated

Filter by registration date (eq, gte, lte)

Formatdate
is_closing_status?booleanDeprecated

Filter by closing status flag, true/false or 1/0 (eq)

search?string

Free text search on plate

sort?string

Sort field (prefix - for DESC). Allowed: id, plate, created_at, status_id, km_counter

limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250
page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
filter[plate][operator]?string

Operators: eq, ct, sw. Example: filter[plate][eq]=value

filter[status_id][operator]?integer

Operators: eq, in. Example: filter[status_id][eq]=value

filter[customer_id][operator]?integer

Operators: eq. Example: filter[customer_id][eq]=value

filter[owner_customer_id][operator]?integer

Operators: eq. Example: filter[owner_customer_id][eq]=value

filter[created_at][operator]?string

Operators: eq, gte, lte. Example: filter[created_at][eq]=value

Formatdate
filter[is_closing_status][operator]?boolean

Operators: eq. Example: filter[is_closing_status][eq]=value

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/workshop/processes?plate=string&status_id=0&customer_id=0&owner_customer_id=0&created_at=2019-08-24&is_closing_status=true&search=string&sort=string&limit=50&page=1&filter%5Bplate%5D%5Boperator%5D=string&filter%5Bstatus_id%5D%5Boperator%5D=0&filter%5Bcustomer_id%5D%5Boperator%5D=0&filter%5Bowner_customer_id%5D%5Boperator%5D=0&filter%5Bcreated_at%5D%5Boperator%5D=2019-08-24&filter%5Bis_closing_status%5D%5Boperator%5D=true"
{
  "data": [
    {
      "id": 0,
      "plate": "string",
      "km_counter": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "process_status": {
        "resource": "string"
      },
      "vehicle": {
        "resource": "string"
      },
      "customer": {
        "resource": "string"
      }
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}