ProcessOrder.GetExisting

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

Path Parameters

Field Type Required Notes
workOrder string Yes Exported Winserve process work order.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status Notes
200 OK Returned when the final exported process work order exists for the tenant customer.
404 Not Found Final exported process work order was not found.

Success Body

Response type: ExistingProcessResponse

This endpoint resolves exported work orders only. See the Order Lifecycle guide for how draft web order ids become exported work order ids.

The response body is loaded from the tenant database final ProcessOrder tables. Workflow state is derived from proof of service when available, otherwise the current milestone is returned, falling back to Active.

Field Type Required Max Length Notes
workOrder string Yes Exported Winserve process work order.
customer string Yes Customer code.
contactCode int? No Contact code on the exported order.
jobCategory string Yes Job type abbreviation.
jobType string Yes Job type title.
status string Yes Proof of service status when available, otherwise milestone or Active.
milestone string Yes Current process milestone from the tenant Milestone table.
referenceNumber string Yes Customer reference / their file number.
plaintiff string Yes
defendant string Yes
courtCode string Yes
caseNumber string Yes
specialInstructions string Yes
servees array Yes Servee data from the final process order.

Response Sample

{
  "workOrder": "P123456",
  "customer": "ABC Legal Services",
  "contactCode": 456,
  "jobCategory": "STD",
  "jobType": "Standard Process",
  "status": "Personal Service",
  "milestone": "Assigned",
  "referenceNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "courtCode": "LASC",
  "caseNumber": "23STCV00001",
  "specialInstructions": "Serve as soon as possible.",
  "servees": [
    {
      "partyBeingServed": "John Doe",
      "agent": "",
      "partyIsAnEntity": false,
      "addresses": [],
      "serviceInstructions": "Serve defendant.",
      "amount": null
    }
  ]
}