Aircraft owners
An aircraft owner's own aircraft and the jobs on them. Answered for whatever the caller owns or is billed for; anything else answers 404, exactly as an id that does not exist. The one part of the API an owner from outside the organization may call.
11 endpoints · base URL https://api.aerscheduler.com
/owner/aircraftList my aircraft
The aircraft the caller owns here, each with its open job and its most urgent open inspections (hours in tenths). Also any aircraft they do not own but have an open job or an unpaid bill on, with owns: false, their own jobs only and none of the aircraft's inspections or times. Empty for a member with neither. Found items waiting on an answer are counted in needsAnswer, and job by job, oldest first, in needsAnswerJobs (jobId, label, count); needsAnswerJobId names the first of them. A job that is closed or invoiced asks for no answers.
Query parameters
limit | integer | Aircraft to return, 1 to 1000. Defaults to all. |
offset | integer | Aircraft to skip, for paging. Defaults to 0. |
Responses
200 | OK | My aircraft.→ { data: object[] } |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl https://api.aerscheduler.com/owner/aircraft \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/filesList the files on my account
What the shop shows you on your account, and the documents you added yourself (yours), newest first. Never a file the shop keeps to itself.
Query parameters
limit | integer | Rows to return, 1,1000. Defaults to 1000; a larger value is clamped rather than rejected. |
offset | integer | Rows to skip, for paging. Defaults to 0. |
sort | string | Field to order by before paging, as a dot path into the row , total, user.firstName. Omit to keep the endpoint's own order. Numbers and ISO timestamps order as numbers and instants, not as text, and empty values always sort last regardless of direction. Ordering happens before the page is cut, so it orders the whole collection rather than the page you are holding. |
order | "asc" | "desc" | asc (default) or desc. Only meaningful with sort. |
Responses
200 | OK | Your files.→ { data: OwnFile[] } |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl https://api.aerscheduler.com/owner/files \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/filesAdd documents to my account
Name up to 5 files and upload each to the returned signedUrlData. The shop always sees them, and so do you. You can keep up to 20 of your own files. Turned off in the public demo.
Request body
The files.
fileNamesrequired | string[] | |
label | string | null |
Responses
201 | Created | The files, with signedUrlData beside data.→ { data: OwnFile[] } |
400 | Bad Request | No files, or too many. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | The public demo. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X POST https://api.aerscheduler.com/owner/files \
-H "Authorization: Bearer $AERSCHEDULER_KEY" \
-H "Content-Type: application/json" \
-d '{"fileNames":[]}'/owner/aircraft/{id}Read one of my aircraft
Its jobs (newest first), every open inspection, its recent Hobbs and tach readings, papers, the aircraft's papers the shop shows its owners (each with a 15-minute url; a customer's aircraft only), and components, its life-limited components on it now with their life left (id, name, position, partNumber, serialNumber, installedOn, timeSince, limitHours, limitMonths and life, as GET /resources/{id}/components reads them, without the shop's notes; a customer's aircraft only). mayRecordTimes is true for a customer's aircraft with meters.
Path parameters
idrequired | integer | The resource id. |
Responses
200 | OK | The aircraft.→ { data: object } |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not one of yours. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl https://api.aerscheduler.com/owner/aircraft/:id \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/files/{fileId}Remove a document I added
Only a file you added yourself; any other id answers 404, the same as one that does not exist.
Path parameters
fileIdrequired | integer | The file id. |
Responses
204 | No Content | Success. No body. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not a file you added. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X DELETE https://api.aerscheduler.com/owner/files/:fileId \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/work-orders/{id}Read a job on my aircraft
The owner's view of a job: where it stands, the items (and which found ones wait on an answer), the files shared with the owner, and, only for the person billed, the charges and the invoice (refunded when handed back in full, pastDue when unpaid past its dueAt). A finding the shop has not sent is not shown, nor anything priced against it. lines and chargesCents leave out the lines of findings the owner has not agreed to (still waiting, declined or deferred); once the job is invoiced they are the bill's, every billable line, so chargesCents is the invoice's subtotal, and no item needsAnswer. Each item carries estimateCents, what its billable lines come to (null for anybody but the person billed), answeredByYou, true when the caller gave its answer here, and askedAt, when the shop sent it (null if never), which an answer sends back. mayAnswer is true while the job is open and not invoiced; ownsAircraft says whether the caller owns the aircraft. No shop notes, costs, markups or rates.
Path parameters
idrequired | integer | The work order id. |
Responses
200 | OK | The job.→ { data: object } |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not on your aircraft. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl https://api.aerscheduler.com/owner/work-orders/:id \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/aircraft/{id}/historyList what has been done to my aircraft
One of the caller's aircraft, newest first: its inspection sign-offs and the shop's completed jobs (no squawks, no technicians, no certificate numbers, nothing the shop keeps to itself). Paged, at most 250 a page. Filter with kind (inspection, work_order).
Path parameters
idrequired | integer | The resource id. |
Query parameters
kind | string | Only these kinds, comma separated. |
sort | "date" | date to order by date. |
order | "asc" | "desc" | desc (default) or asc. |
limit | integer | Rows to return, 1 to 250. |
offset | integer | Rows to skip, for paging. Defaults to 0. |
Responses
200 | OK | A page of the history.→ { data: AircraftHistoryEntry[] } |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not one of yours. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl https://api.aerscheduler.com/owner/aircraft/:id/history \
-H "Authorization: Bearer $AERSCHEDULER_KEY"/owner/aircraft/{id}/metersRecord my aircraft's times
Exactly as POST /resources/{id}/meters, for the aircraft's owner, on a customer's aircraft only: the school's own aircraft are read at every close-out and answer 403.
Path parameters
idrequired | integer | The resource id. |
Request body
The reading.
hobbsTime | integer | null | |
tachTime | integer | null | |
readAt | string | null | |
note | string | null | |
fileName | string | null | |
confirmLower | boolean | |
meterReplaced | boolean | |
confirmMaintenanceTrigger | boolean |
Responses
201 | Created | The reading.→ { data: object } |
400 | Bad Request | Not a reading. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | One of the organization's own aircraft. |
404 | Not Found | Not one of yours. |
409 | Lower than the aircraft, or would ground it: confirm and send again. | |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X POST https://api.aerscheduler.com/owner/aircraft/:id/meters \
-H "Authorization: Bearer $AERSCHEDULER_KEY" \
-H "Content-Type: application/json" \
-d '{"hobbsTime":1,"tachTime":1}'/owner/aircraft/{id}/requestsRequest work on my aircraft
Opens a Requested job on the shop's board, billed to the aircraft's billed owner, and tells the shop. Only request is needed. wantedBy (a real date, today or later, within two years) is added to the request in words; the shop sets the promised date. preferredFrom (and preferredTo, for a range), grounded and location are kept on the job as said, and shown to the shop as the owner's wish, not its plan. hobbsTime and tachTime (tenths; a customer's aircraft only, 403 otherwise) are recorded on the aircraft's meter log as POST /owner/aircraft/{id}/meters would, linked to the job; a reading lower than on record, or one that would ground the aircraft, answers 409 BEFORE anything is opened, until sent again with confirmLower / confirmMaintenanceTrigger. Name up to five photos or PDFs in fileNames and upload them to the returned signedUrlData, as when attaching to a job; refused in the public demo.
Path parameters
idrequired | integer | The resource id. |
Request body
The request.
request | string | What you would like done. |
wantedBy | string | null | When you would like it back. |
preferredFrom | string | null | When it can come in: the day, or the first day of a range. |
preferredTo | string | null | The last day it can come in. Needs preferredFrom, and is not before it. |
grounded | boolean | null | True: it cannot fly as it is. False: it can fly in. Null or absent: not said. |
location | string | null | Where the aircraft is now, such as the airport and hangar. |
hobbsTime | integer | null | Its Hobbs now, in tenths. |
tachTime | integer | null | Its tach now, in tenths. |
confirmLower | boolean | |
meterReplaced | boolean | |
confirmMaintenanceTrigger | boolean | |
fileNames | string[] | Photos or PDFs to upload with it. |
Responses
201 | Created | The job's id, label and aircraftTimes (updated, logged, or null), with signedUrlData beside data for the files.→ { data: object } |
400 | Bad Request | Not a request. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Times on one of the organization's own aircraft, or files in the demo. |
404 | Not Found | Not one of yours. |
409 | The times are lower than the aircraft's, or would ground it: confirm and send again. Nothing was opened. | |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X POST https://api.aerscheduler.com/owner/aircraft/:id/requests \
-H "Authorization: Bearer $AERSCHEDULER_KEY" \
-H "Content-Type: application/json" \
-d '{"request":"…","wantedBy":"…"}'/owner/work-orders/{id}/answersAnswer the shop's found items
Approve, decline or defer found items still waiting on an answer, on an open job. Any owner of the aircraft answers, or the person the job is billed to; the answer names who gave it. An item already answered or done is refused: call the shop to change an answer. Each answer sends back the item's askedAt from the job: a finding reworded since (or reworded and sent again) is refused with a 409, to be read again first. Refused with a 409 once the job is invoiced.
Path parameters
idrequired | integer | The work order id. |
Request body
The answers.
decisions | object[] |
Responses
201 | Created | The answer as recorded.→ { data: object } |
400 | Bad Request | Not an answer, no askedAt, or already answered. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not on your aircraft. |
409 | Somebody has just answered it, the finding changed since it was read (reload it), or the job is invoiced. | |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X POST https://api.aerscheduler.com/owner/work-orders/:id/answers \
-H "Authorization: Bearer $AERSCHEDULER_KEY" \
-H "Content-Type: application/json" \
-d '{"decisions":[]}'/owner/work-orders/{id}/filesAttach photos to a job on my aircraft
Name up to 5 files and upload each to the returned signedUrlData. They are shown to the shop and to you. An owner adds up to 20 files to a job.
Path parameters
idrequired | integer | The work order id. |
Request body
The files.
fileNames | string[] |
Responses
201 | Created | The files, with signedUrlData.→ { data: object[] } |
400 | Bad Request | No files, or too many. |
401 | Unauthorized | No token, an expired token, a malformed one, or a session token naming a membership that is no longer yours ("Your session is out of date"). Sign in again. |
403 | Forbidden | Authenticated, but not allowed to do this. |
404 | Not Found | Not on your aircraft. |
429 | Too Many Requests | Rate limited. Retry-After says how long to wait. |
curl -X POST https://api.aerscheduler.com/owner/work-orders/:id/files \
-H "Authorization: Bearer $AERSCHEDULER_KEY" \
-H "Content-Type: application/json" \
-d '{"fileNames":[]}'