Resources

Aircraft, simulators, and rooms.

11 endpoints · base URL https://api.aerscheduler.com

get/resources

List resources

Every bookable resource — aircraft, simulators, and rooms together. Use /resources/planes, /simulators, or /rooms for one kind.

Responses

`200`	OK	The resources.→ { data: Resource[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl https://api.aerscheduler.com/resources \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/resources

Create a resource

Adds a resource to your organization. Requires the admin role.

Request body

The new resource. Exactly one of type.plane, type.simulator, or type.room must be present, and location.id is required.

`name`required	`string`
`location`required	`object`
`type`required	`object`

Responses

`201`	Created	The resource that was created.→ { data: Resource }
`400`	Bad Request	The body failed validation. `message` says which field.
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl -X POST https://api.aerscheduler.com/resources \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","location":{},"type":{}}'

get/resources/{id}

Get a resource

Fetches one resource by id.

Path parameters

idrequired integer The resource id.

Responses

`200`	OK	Success.→ { data: Resource }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	No such resource, or it belongs to another organization.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/resources/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

patch/resources/{id}

Update a resource

Changes the fields you send and leaves the rest alone. Requires the admin role.

Path parameters

idrequired integer The resource id.

Request body

Fields to change. type must be present even when you are only changing a top-level field.

`name`	`string`
`type`	`object`

Responses

`200`	OK	The updated resource.→ { data: Resource }
`400`	Bad Request	The body failed validation.
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl -X PATCH https://api.aerscheduler.com/resources/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","type":{}}'

delete/resources/{id}

Delete a resource

Removes the resource. Requires the admin role.

Path parameters

idrequired integer The resource id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The resource could not be deleted — usually because something still references it.
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl -X DELETE https://api.aerscheduler.com/resources/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/resources/planes

List aircraft

Only resources whose type is a plane.

Query parameters

`q`	`string`	Free-text filter. Matches the fields a person would search on.
`grounded`	`boolean`	Filter on grounded state.
`locationId`	`string`	Comma-separated location ids.

Responses

`200`	OK	The aircraft.→ { data: Resource[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl https://api.aerscheduler.com/resources/planes \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/resources/rooms

List rooms

Only resources whose type is a room.

Query parameters

`q`	`string`	Free-text filter. Matches the fields a person would search on.
`locationId`	`string`	Comma-separated location ids.

Responses

`200`	OK	The rooms.→ { data: Resource[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl https://api.aerscheduler.com/resources/rooms \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/resources/simulators

List simulators

Only resources whose type is a simulator.

Query parameters

`q`	`string`	Free-text filter. Matches the fields a person would search on.
`grounded`	`boolean`	Filter on grounded state.
`locationId`	`string`	Comma-separated location ids.

Responses

`200`	OK	The simulators.→ { data: Resource[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl https://api.aerscheduler.com/resources/simulators \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/resources/{id}/approve

Approve a member for a resource

Checks someone out on an aircraft. Requires the admin role.

Path parameters

idrequired integer The resource id.

Request body

Who to approve.

userIdrequired integer

Responses

`200`	OK	Success.→ { data: object }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	That person is not in your organization.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/resources/:id/approve \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId":1}'

post/resources/{id}/fuel

Record fuel on board

Updates fuel for one or both engines.

Path parameters

idrequired integer The resource id.

Request body

Fuel figures, in the aircraft's configured units.

`fuelEngine1`	`integer`
`fuelEngine2`	`integer`

Responses

`200`	OK	Success.→ { data: object }
`400`	Bad Request	Validation failed.
`401`	Unauthorized	No token, an expired token, or a malformed one. 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.

Example request

curl -X POST https://api.aerscheduler.com/resources/:id/fuel \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fuelEngine1":1,"fuelEngine2":1}'

post/resources/{id}/unapprove

Withdraw a member's approval

Requires the admin role.

Path parameters

idrequired integer The resource id.

Request body

Whose approval to withdraw.

userIdrequired integer

Responses

`200`	OK	Success.→ { data: object }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`404`	Not Found	That person is not in your organization.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/resources/:id/unapprove \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId":1}'

PreviousAvailabilityWhen people and aircraft are free.NextMaintenanceSquawks and maintenance reminders.