List packages

One row per package version referenced by a visible SCORM or IMSCP activity in this course; activity_id identifies the first visible reference. Processing state and aggregate size are shown, while file versions, manifests, same-origin acknowledgements, launch secrets, storage addresses, and hashes are omitted.

Quire permissions

Required capability: activity/view.

Credential scopes: courses:read.

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

GET

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

View as Markdown

Authorisation

apiKeyoptionalHTTP
oauth2optionalOAuth 2.0

Path parameters

course_idstringrequired

Query parameters

cursoroptionalstring
limitoptionalinteger
maximum: 9007199254740991, minimum: 1
updated_sinceoptionalstring
Only rows changed at or after this instant, sorted by updated_at then id. At most 90 days ago; a sync older than that has to start again from the beginning.

format: date-time, pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

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

Returns

200

Success.

JSON

dataarray ofobjectrequired
9 properties
- idstringrequired
- course_idstringrequired
- activity_idstringrequired
- stateextractingorquarantinedorreadyorrejectedrequired
- entry_countintegerrequired
  maximum: 9007199254740991, minimum: -9007199254740991
- total_bytesintegerrequired
  maximum: 9007199254740991, minimum: -9007199254740991
- profilestrictorruntimeorsame_originrequired
- created_atstringrequired
  RFC 3339 timestamp in UTC.
- updated_atstringrequired
  RFC 3339 timestamp in UTC.
pageobjectrequired
3 properties
- next_cursorstring | nullrequired
- has_morebooleanrequired
- limitintegerrequired
  maximum: 9007199254740991, minimum: -9007199254740991

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

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

{ "data": [ { "id": "string", "course_id": "string", "activity_id": "string", "state": "extracting", "entry_count": -9007199254740991, "total_bytes": -9007199254740991, "profile": "strict", "created_at": "string", "updated_at": "string" } ], "page": { "next_cursor": "string", "has_more": true, "limit": -9007199254740991 } }

{ "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" }