Service orders monitor

Returns active service orders (ESP/EXE/MAR states) with interventions, mechanics, budgets, badge urgency color and completion tracking.

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

num?integerDeprecated

Filter by service order number (eq, in)

document_number?stringDeprecated

Filter by document number (eq, ct)

status?stringDeprecated

Filter by status code (eq, in)

date?stringDeprecated

Filter by date (eq, gte, lte)

Formatdate

customer_id?integerDeprecated

Filter by customer ID (eq)

vehicle_plate?stringDeprecated

Filter by vehicle plate (eq, ct)

invoice_name?stringDeprecated

Filter by invoice name (eq, ct)

expected_delivery_date?stringDeprecated

Filter by expected delivery date (eq, gte, lte)

Formatdate

awaiting_parts?booleanDeprecated

Filter by awaiting parts flag, true/false or 1/0 (eq)

priority?integerDeprecated

Filter by priority (eq, in)

start_hour?string

Working hours start (HH:MM, default 09:00)

end_hour?string

Working hours end (HH:MM, default 18:30)

start_hour_lunch?string

Lunch break start (HH:MM, default 13:00)

end_hour_lunch?string

Lunch break end (HH:MM, default 14:30)

skip_weekends?boolean

Skip weekends in calculation, true/false or 1/0 (default true)

sort?string

Sort field (prefix - for DESC). Allowed: num, date, status, vehicle_plate, expected_delivery_date, priority

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[num][operator]?integer

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

filter[document_number][operator]?string

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

filter[status][operator]?string

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

filter[date][operator]?string

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

Formatdate

filter[customer_id][operator]?integer

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

filter[vehicle_plate][operator]?string

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

filter[invoice_name][operator]?string

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

filter[expected_delivery_date][operator]?string

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

Formatdate

filter[awaiting_parts][operator]?boolean

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

filter[priority][operator]?integer

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

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/workshop/monitor/service-orders?num=0&document_number=string&status=string&date=2019-08-24&customer_id=0&vehicle_plate=string&invoice_name=string&expected_delivery_date=2019-08-24&awaiting_parts=true&priority=0&start_hour=string&end_hour=string&start_hour_lunch=string&end_hour_lunch=string&skip_weekends=true&sort=string&limit=50&page=1&filter%5Bnum%5D%5Boperator%5D=0&filter%5Bdocument_number%5D%5Boperator%5D=string&filter%5Bstatus%5D%5Boperator%5D=string&filter%5Bdate%5D%5Boperator%5D=2019-08-24&filter%5Bcustomer_id%5D%5Boperator%5D=0&filter%5Bvehicle_plate%5D%5Boperator%5D=string&filter%5Binvoice_name%5D%5Boperator%5D=string&filter%5Bexpected_delivery_date%5D%5Boperator%5D=2019-08-24&filter%5Bawaiting_parts%5D%5Boperator%5D=true&filter%5Bpriority%5D%5Boperator%5D=0"

{
  "data": [
    {
      "number": 0,
      "document_number": "string",
      "status": "string",
      "date": "2019-08-24",
      "customer_id": 0,
      "vehicle_plate": "string",
      "invoice_name": "string",
      "expected_delivery_date": "2019-08-24T14:15:22Z",
      "awaiting_parts": true,
      "priority": 0,
      "completion_percentage": 0.1,
      "estimated_completion_date": "2019-08-24T14:15:22Z",
      "badge_color": "success",
      "interventions": {
        "sequence_number": 0,
        "intervention": "string",
        "completed": true,
        "duration": 0
      },
      "mechanics": {
        "employee_code": 0,
        "name": "string",
        "start_time": "2019-08-24T14:15:22Z",
        "show_in_monitor": true
      },
      "budgets": [],
      "vehicle": {
        "plate": "string",
        "description": "string",
        "manufacturing_year": 0,
        "km_counter": 0,
        "brand_name": "string",
        "model_name": "string",
        "version_name": "string",
        "fuel_name": "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"
  }
}

Service orders monitor

Authorization

Query Parameters

Response Body

200

401

403

422

429