Groups

Sets of members or resources.

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

get/groups/orgUser

List member groups

Every member group in your organization.

Responses

`200`	OK	The member groups.→ { data: Group[] }
`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/groups/orgUser \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/groups/orgUser

Create a member group

Adds a member group to your organization. Requires the admin role.

Request body

The group. The addNew* flags auto-enrol future members holding that role.

`name`required	`string`
`description`	`string`
`orgUserIds`	`integer[]`
`addNewUsers`	`boolean`
`addNewStudents`	`boolean`
`addNewInstructors`	`boolean`
`addNewRenters`	`boolean`

Responses

`201`	Created	The member group that was created.→ { data: Group }
`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/groups/orgUser \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

get/groups/resource

List resource groups

Every resource group in your organization.

Responses

`200`	OK	The resource groups.→ { data: Group[] }
`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/groups/resource \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/groups/resource

Create a resource group

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

Request body

The group.

`name`required	`string`
`description`	`string`
`resourceIds`	`integer[]`

Responses

`201`	Created	The resource group that was created.→ { data: Group }
`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/groups/resource \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

get/groups/orgUser/{orgUserGroupId}

Get a member group

Fetches one member group by id.

Path parameters

orgUserGroupIdrequired integer The member group id.

Responses

`200`	OK	Success.→ { data: Group }
`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 member group, 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/groups/orgUser/:orgUserGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

patch/groups/orgUser/{orgUserGroupId}

Update a member group

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

Path parameters

orgUserGroupIdrequired integer The member group id.

Request body

Fields to change.

`name`	`string`
`description`	`string`
`orgUserIds`	`integer[]`

Responses

`200`	OK	The updated member group.→ { data: Group }
`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/groups/orgUser/:orgUserGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…"}'

delete/groups/orgUser/{orgUserGroupId}

Delete a member group

Removes the member group. Requires the admin role.

Path parameters

orgUserGroupIdrequired integer The member group id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The member group 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/groups/orgUser/:orgUserGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

get/groups/resource/{resourceGroupId}

Get a resource group

Fetches one resource group by id.

Path parameters

resourceGroupIdrequired integer The resource group id.

Responses

`200`	OK	Success.→ { data: Group }
`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 group, 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/groups/resource/:resourceGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

patch/groups/resource/{resourceGroupId}

Update a resource group

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

Path parameters

resourceGroupIdrequired integer The resource group id.

Request body

Fields to change.

`name`	`string`
`resourceIds`	`integer[]`

Responses

`200`	OK	The updated resource group.→ { data: Group }
`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/groups/resource/:resourceGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","resourceIds":[]}'

delete/groups/resource/{resourceGroupId}

Delete a resource group

Removes the resource group. Requires the admin role.

Path parameters

resourceGroupIdrequired integer The resource group id.

Responses

`204`	No Content	Success. No body.
`400`	Bad Request	The resource group 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/groups/resource/:resourceGroupId \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

PreviousLocationsBases of operation.NextCurrenciesRecurring requirements members must stay current on.