Add a manual or calculated column to a course gradebook

Quire permissions

Required capability: grade/manage.

Credential scopes: grades:write.

The acting subject must also be allowed to perform this action in the organisation.

POST

https://your-organisation.quirelms.com/api/v1/courses/{course_id}/grade_items

View as Markdown

Authorisation

apiKeyoptionalHTTP
oauth2optionalOAuth 2.0

Path parameters

course_idstringrequired

Header parameters

Quire-Versionoptionalstring
The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.

format: date
Idempotency-Keyoptionalstring
A caller-chosen key making this request safe to retry. A replay of a completed request returns the recorded response with Idempotency-Replayed: true. Reusing a key for a different request is refused.

maxLength: 255

Request bodyJSONrequired

namestringrequired
maxLength: 255, minLength: 1
id_numberoptionalstringornull
2 variants
One of the following:
string
null
grade_maxoptionalnumber
maximum: 100000, minimum: -100000
grade_minoptionalnumber
maximum: 100000, minimum: -100000
grade_passoptionalnumberornull
2 variants
One of the following:
number
null
weightoptionalnumberornull
2 variants
One of the following:
number
null
calculationoptionalstringornull
A formula over other columns, for a calculated item.
2 variants
One of the following:
string
null
hiddenoptionalboolean
lockedoptionalboolean
item_typeoptionalmanualorcalculated
category_idoptionalstring
The gradebook category; the course's top category when absent.

format: uuid, pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
grade_typeoptionalvalueorscaleortext
scale_idoptionalstringornull
2 variants
One of the following:
string
null
external_idoptionalstring
maxLength: 255, minLength: 1

Returns

201

Success.

JSON

idstringrequired
external_idstring | nullrequired
course_idstringrequired
category_idstringrequired
item_typemodormanualorcalculatedorcategoryorcourseoroutcomerequired
item_modulestring | nullrequired
item_instancestring | nullrequired
id_numberstring | nullrequired
namestringrequired
grade_typenoneorvalueorscaleortextrequired
grade_maxnumberrequired
grade_minnumberrequired
grade_passnumber | nullrequired
weightnumber | nullrequired
hiddenbooleanrequired
locked_atstringornullrequired
2 variants
One of the following:
string
null
sort_orderintegerrequired
maximum: 9007199254740991, minimum: -9007199254740991
created_atstringrequired
RFC 3339 timestamp in UTC.
updated_atstringrequired
RFC 3339 timestamp in UTC.
deleted_atstringornullrequired
2 variants
One of the following:
string
null

401

The credential is missing, malformed, expired or revoked.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

404

No such resource, or none this credential is permitted to know about.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

409

The request conflicts with the current state, with a previous use of the same idempotency key, or with a concurrent write.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

422

The request was understood and its content is not valid. errors names each field.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

429

A rate limit or a concurrency cap was reached. Retry-After says when to try again.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

500

Something failed at our end. Quote request_id when reporting it.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

curl --request POST \ --url https://your-organisation.quirelms.com/api/v1/courses/string/grade_items \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "id_number": "string", "grade_max": -100000, "grade_min": -100000, "grade_pass": -100000, "weight": 100000, "calculation": "string", "hidden": true, "locked": true, "item_type": "manual", "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2", "grade_type": "value", "scale_id": "5b8db256-14ec-46e3-b65b-6ee80d73bf01", "external_id": "string" } '

{ "id": "string", "external_id": "string", "course_id": "string", "category_id": "string", "item_type": "mod", "item_module": "string", "item_instance": "string", "id_number": "string", "name": "string", "grade_type": "none", "grade_max": 0, "grade_min": 0, "grade_pass": 0, "weight": 0, "hidden": true, "locked_at": "string", "sort_order": -9007199254740991, "created_at": "string", "updated_at": "string", "deleted_at": "string" }

{ "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" }