TRANXACT.AI Help

Student Lifecycle · Rooms & Timetabling

Meeting Patterns

What the timetable builder is asked to place for a section: hours a week, session length, preferred days, room type and equipment. A section without one keeps the shape of the meetings it has.

Type REST6 operationsBase path /api/slcm/meeting-patternsPublished as /api/v1/meeting-patterns

Download specification (OpenAPI 3.1) Screen: Meeting Patterns

Overview

PackageStudent Lifecycle
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Student Lifecycle › Meeting Patterns on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableslcm.meeting_patterns · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/slcm/meeting-patternsList meeting patterns

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hours_per_week": "1250.00",
      "session_minutes": 10,
      "preferred_days": [],
      "earliest_start": "text",
      "latest_end": "text",
      "room_type": "lecture",
      "required_features": [],
      "needs_accessible": true,
      "expected_size": 10,
      "cohort_tag": "text",
      "keep_fixed": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/slcm/meeting-patterns?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/slcm/meeting-patterns/{id}Read one meeting patterns

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hours_per_week": "1250.00",
  "session_minutes": 10,
  "preferred_days": [],
  "earliest_start": "text",
  "latest_end": "text",
  "room_type": "lecture",
  "required_features": [],
  "needs_accessible": true,
  "expected_size": 10,
  "cohort_tag": "text",
  "keep_fixed": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/slcm/meeting-patterns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/meeting-patternsCreate a meeting patterns

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
section_iduuidYesSection
hours_per_weeknumericNoHours a week
session_minutesintegerNoSession length (minutes)
preferred_days_textNoPreferred days
earliest_starttime without time zoneNoNot before
latest_endtime without time zoneNoFinished by
room_typetextNoRoom type — Blank: a lecture, seminar or tutorial room.
Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other
required_features_textNoEquipment needed
needs_accessiblebooleanNoNeeds step-free access
expected_sizeintegerNoSeats needed — Blank: the section’s capacity.
cohort_tagtextNoCohort — Sections with the same cohort are never placed at the same hour.
keep_fixedbooleanNoKeep its meetings where they are
notestextNoNotes

Sample body

{
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hours_per_week": "1250.00",
  "session_minutes": 10,
  "preferred_days": [],
  "earliest_start": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hours_per_week": "1250.00",
  "session_minutes": 10,
  "preferred_days": [],
  "earliest_start": "text",
  "latest_end": "text",
  "room_type": "lecture",
  "required_features": [],
  "needs_accessible": true,
  "expected_size": 10,
  "cohort_tag": "text",
  "keep_fixed": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/meeting-patterns" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"section_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","hours_per_week":"1250.00","session_minutes":10,"preferred_days":[],"earliest_start":"text"}'
PUT/api/slcm/meeting-patterns/{id}Change a meeting patterns

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
section_iduuidYesSection
hours_per_weeknumericNoHours a week
session_minutesintegerNoSession length (minutes)
preferred_days_textNoPreferred days
earliest_starttime without time zoneNoNot before
latest_endtime without time zoneNoFinished by
room_typetextNoRoom type — Blank: a lecture, seminar or tutorial room.
Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other
required_features_textNoEquipment needed
needs_accessiblebooleanNoNeeds step-free access
expected_sizeintegerNoSeats needed — Blank: the section’s capacity.
cohort_tagtextNoCohort — Sections with the same cohort are never placed at the same hour.
keep_fixedbooleanNoKeep its meetings where they are
notestextNoNotes

Sample body

{
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hours_per_week": "1250.00"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hours_per_week": "1250.00",
  "session_minutes": 10,
  "preferred_days": [],
  "earliest_start": "text",
  "latest_end": "text",
  "room_type": "lecture",
  "required_features": [],
  "needs_accessible": true,
  "expected_size": 10,
  "cohort_tag": "text",
  "keep_fixed": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/slcm/meeting-patterns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"section_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","hours_per_week":"1250.00"}'
DELETE/api/slcm/meeting-patterns/{id}Delete a meeting patterns

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/slcm/meeting-patterns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/slcm/meeting-patterns/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/slcm/meeting-patterns/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a meeting patterns, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
section_iduuidread, writeSection
hours_per_weeknumericread, writeHours a week
session_minutesintegerread, writeSession length (minutes)
preferred_days_textread, writePreferred days
earliest_starttime without time zoneread, writeNot before
latest_endtime without time zoneread, writeFinished by
room_typetextread, writeRoom type — Blank: a lecture, seminar or tutorial room.
Allowed: lecture lab seminar tutorial exam_hall studio computer_lab other
required_features_textread, writeEquipment needed
needs_accessiblebooleanread, writeNeeds step-free access
expected_sizeintegerread, writeSeats needed — Blank: the section’s capacity.
cohort_tagtextread, writeCohort — Sections with the same cohort are never placed at the same hour.
keep_fixedbooleanread, writeKeep its meetings where they are
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Student Lifecycle › Meeting Patterns for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.