Specific Methods

Specific methods

The following methods are specifics of note to assist with development.

Clients

GET /clients

This method returns a short JSON definition in a document containing all clients.

GET /clients/{id}

This method returns a specific detailed JSON document containing all fields.

The {id} can be either;

clientId (the Core system generated GUID) or;
importuniqueid (your internally supplied id)

PUT

The PUT command creates a client record and if a clientlocation JSON structure isn't supplied a default location matching the clientname is created and set as the default location.

ClientId - If this value is supplied it's ignored.
Name - The only required.
ClientLocations - JSON structure. LocationName is required or an error is thrown.

PATCH /clients/{id}

This method takes a patchdocument in the request body returns a specific detailed JSON document containing all fields.

The {id} can be either;

clientId (the Core system generated GUID) or;
importuniqueid (your internally supplied id)

Equipment

GET /Equipment?locationid={locationid} - Gets a list of equipment at a specific clientlocation.

GET /Equipment/{EquipmentGuid} - Gets an item by its ID.

GET /Equipment/Search/Barcode/XXXX - Gets an equipment item with the barcode XXXX

Inspections

GET /Inspections/{inspectionGuid}

Description:
Retrieves the details of a specific inspection using its unique identifier (inspectionGuid).

Parameters

Name	Type	Required	Description
`InspectionGuid`	`GUID`	Yes	The unique identifier of the inspection you want to retrieve.

Request Example

GET http://beta.api4.coreinspection.com/Inspections/6418a8a6-d68f-41ff-aa62-b2d9dc522767

PATCH http://api4.coreinspection.com/Inspections/{inspectionGuid}

Description

Updates an existing inspection record by applying changes to specific fields, such as DateCreated, Passed, Failed, Notes, and component results.

Parameters

Name	Type	Required	Description
`inspectionGuid`	`GUID`	Yes	Unique identifier of the inspection to update.

Request Body

The request body is an array of objects where each object specifies a field to update using a path and its corresponding value.

Field	Type	Description
`path`	`string`	The name of the field to update (e.g., `DateCreated`, `Passed`). Please refer to the Inspection API object definitions for more details.
`value`	`string`/`boolean`/`array`	The new value to assign.
`InspectionComponentResults`	`array`	A list of inspection component result objects (with IDs and values).

Request Example

[
  {
    "path": "DateCreated",
    "value": "2025-09-20T00:00:00"
  },
  {
    "path": "Passed",
    "value": null
  },
  {
    "path": "Failed",
    "value": true
  },
  {
    "path": "Missed",
    "value": null
  },
  {
    "path": "Notes",
    "value": "2024-01-11T00:00:00"
  },
  {
    "path": "InspectionComponentResults",
    "value": [
      {
        "InspectionComponentResultId": "8ed66b61-41d7-492d-abab-5ec6b2c8d1d1",
        "value": "Test",
        "value2": "Test-fr"
      },
      {
        "InspectionComponentResultId": "b8622c4d-0e44-4464-9c3f-00edc126f7d0",
        "value": "Yes"
      }
    ]
  }
]

Jobs

GET /Jobs?statusid={statusid}&branchid={branchid}&techid={techid}&datefrom={datefrom}&dateto={dateto}

Mandatory search fields are statusid and DateFrom. If dateto isn't it's assumed as a month query.

This method returns a short JSON definition in a document containing all jobs.

Typical senarios

Get all completed jobs in Jan - Jobs?statusid=5&branchid=123&datefrom=01/Jan/2022&dateto=31/Jan/2022
Get all active jobs in Jan - Jobs?statusid=5&branchid=123&datefrom=01/Jan/2022&dateto=31/mar/2022

Limits

Statusid,datefrom are mandatory
Branchid,techid,dateto are optional
If you don't specify a dateto this is set as 30 days from datefrom
There is a limit of 3 months
The query returns a max of 200 items.

GET /Jobs/{id}

This method returns a specific detailed JSON document containing all fields.

The {id} is the jobguid (the Core system generated GUID)

Job workers

Job workers are assigned by suppling a list of worker emails. Any previous workers allocated are removed from the job. If any of the technicans cannot be found (matching their email) an error is thrown.

PUT requestbody

The PUT command creates a job record based on a JSON job structure.

The field definitions are on the Object Reference documentation.

PATCH requestbody

Jobworkers

"jobWorkers": [{

"WorkerEmail": "worker1@domain.com"},{

"WorkerEmail": "worker2@domain.com"

}]

Reports

GET /Reports

Description

Retrieves dynamic reports, filtered by report name, and optionally branch and date (month/year), with support for pagination.

Query Parameters

Name	Type	Required	Description
`reportName`	`string`	Yes	The report type to retrieve. Example: `"All Inspections by Month"`.
`branchId`	`int`	No	Filters the report by branch. -1 value denotes all branch
`month`	`int`	No	Filters the report by month (1–12).
`year`	`int`	No	Filters the report by year (e.g., `2025`).
`pageNumber`	`int`	No	The page of results to retrieve.
`pageSize`	`int`	No	Number of records per page.

Request Example

GET http://api4.coreinspection.com/Reports?reportName=All Inspections by Month&month=9&year=2025&pageSize=50&pageNumber=1

Specific Methods

September 28, 2025