« Return to Index
inspection
Additional details for a job, especially those which change from one inspection to the next.
Access Level
Read/Write - this entity can be updated but never added or deleted.
When a new job is added, three inspection records are created automtatically.
Values
| Name | Type | Access |
|---|---|---|
| idinspection | integer | Read Only |
| idjob | integer | Read Only |
| idinspector | integer | Read + Write |
| idinspection_status | integer | Read + Write |
| idreport_type | integer | Read + Write |
| job_reference | string | Read Only |
| additional_instructions | text | Read + Write |
| cert_emailed_date | datetime | Read Only |
| completed | boolean | Read Only (can be set using mark completed action) |
| completed_date | datetime | Read Only |
| completed_signature_filename | string | Read Only |
| compliance_cert_or_non_compliance_notice_issued | boolean | Read Only |
| date_report_issued | datetime | Read Only |
| deleted | boolean | Read + Write |
| expiry_date | datetime | Read + Write |
| has_dog | boolean | Read + Write |
| identifier | string | Read Only |
| inspection_datetime | datetime | Read + Write |
| inspection_number | integer | Read Only |
| inspection_timer_end | datetime | Read + Write |
| inspection_timer_start | datetime | Read + Write |
| modified | datetime | Read Only |
| name_of_person_who_will_meet_inspector | string | Read + Write |
| notes | text | Read + Write |
| owners_preferred_inspection_date | date | Read + Write |
| owners_preferred_inspection_time | string | Read + Write |
| phone_of_person_who_will_meet_inspector | string | Read + Write |
| someone_will_meet_inspector | boolean | Read + Write |
| travel_distance | string | Read + Write |
Accessing by Reference
The inpsection entity can be accessed by reference, instead of idinspection.
Note this is the reference for the job table.
// fetch inspection by job reference
$apiRequest = array(
"username" => "user@example.com",
"password" => "bWy1P2xRdyczAzmfxmUYpPjPc4Vg1",
"actions" => array(
array("name" => "fetch", "params" => array("entity" => "inspection", "reference" => "42"))
)
);
// search by job reference
$apiRequest = array(
"username" => "user@example.com",
"password" => "bWy1P2xRdyczAzmfxmUYpPjPc4Vg1",
"actions" => array(
array("name" => "search", "params" => array("entity" => "inspection", "terms" => array("job_reference" => "42")))
)
);
Inspection Apps API Documentation « Return to Index