Skip to content
ulamsulamsulams docs

ulams consultations

Generated from front/cli (ulams schema)

ulams consultations access-enquiries-approve

Section titled “ulams consultations access-enquiries-approve”

Approve the specified consultation access enquiry by proposed term id.

Kind: write. Stability: stable. MCP tool: consultations_access_enquiries_approve. Scopes: enrolments:write.

Endpoints: POST /api/admin/consultation-access-enquiries/approve/{proposedTermId}.

Flag Type Required Description
--proposed-term-id (positional) integer yes proposedTermId
--meeting-link string meeting_link
Terminal window
# Approve the specified consultation access enquiry by proposed term id
ulams consultations access-enquiries-approve 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "proposedTermId": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "proposedTermId"
    },
    "meeting_link": {
      "type": "string",
      "description": "meeting_link"
    }
  },
  "required": [
    "proposedTermId"
  ],
  "additionalProperties": {}
}

ulams consultations access-enquiries-disapprove

Section titled “ulams consultations access-enquiries-disapprove”

Disapprove the specified consultation access enquiry by id.

Kind: write. Stability: stable. MCP tool: consultations_access_enquiries_disapprove. Scopes: enrolments:write.

Endpoints: POST /api/admin/consultation-access-enquiries/disapprove/{id}.

Flag Type Required Description
--id (positional) integer yes id
--message string message
Terminal window
# Disapprove the specified consultation access enquiry by id
ulams consultations access-enquiries-disapprove 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id"
    },
    "message": {
      "type": "string",
      "description": "message"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams consultations access-enquiries-list

Section titled “ulams consultations access-enquiries-list”

Get all consultation access enquiries.

Kind: read (idempotent). Stability: stable. MCP tool: consultations_access_enquiries_list. Scopes: enrolments:read.

Endpoints: GET /api/admin/consultation-access-enquiries.

Flag Type Required Description
--page integer
--per-page integer
--consultation-id number
--user-id number
--status string
--proposed-at-from string Proposed at from
--proposed-at-to string Proposed at to
--is-coming string approved future or past consultations
Terminal window
# Get all consultation access enquiries
ulams consultations access-enquiries-list --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "per_page": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "consultation_id": {
      "type": "number"
    },
    "user_id": {
      "type": "number"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "approved"
      ]
    },
    "proposed_at_from": {
      "type": "string",
      "description": "Proposed at from"
    },
    "proposed_at_to": {
      "type": "string",
      "description": "Proposed at to"
    },
    "is_coming": {
      "type": "string",
      "enum": [
        "true",
        "false"
      ],
      "description": "approved future or past consultations"
    }
  },
  "additionalProperties": {}
}

ulams consultations create

Section titled “ulams consultations create”

Store a newly created Consultation in storage.

Kind: write. Stability: stable. MCP tool: consultations_create. Scopes: events:write.

Endpoints: POST /api/admin/consultations.

Flag Type Required Description
--active-from string active_from
--active-to string active_to
--author-id integer yes author_id
--busy-terms array busy_terms
--categories array categories
--consultation-user-id integer consultation_user_id
--created-at string created_at
--description string yes description
--duration string duration
--executed-at string executed_at
--executed-status string executed_status
--id integer id
--image-path string image_path
--image-url string image_url
--logotype-path string logotype_path
--logotype-url string logotype_url
--max-session-students integer max_session_students
--name string yes name
--proposed-terms array proposed_terms
--status string yes status
--updated-at string updated_at
Terminal window
# Store a newly created Consultation in storage
ulams consultations create --author-id text --description text --name Example --status text --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "active_from": {
      "type": "string",
      "description": "active_from"
    },
    "active_to": {
      "type": "string",
      "description": "active_to"
    },
    "author_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "author_id"
    },
    "busy_terms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "description": "busy_terms"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "icon_class": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "parent_id": {}
        },
        "additionalProperties": {}
      },
      "description": "categories"
    },
    "consultation_user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "consultation_user_id"
    },
    "created_at": {
      "type": "string",
      "description": "created_at"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "duration": {
      "type": "string",
      "description": "duration"
    },
    "executed_at": {
      "type": "string",
      "description": "executed_at"
    },
    "executed_status": {
      "type": "string",
      "description": "executed_status"
    },
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id"
    },
    "image_path": {
      "type": "string",
      "description": "image_path"
    },
    "image_url": {
      "type": "string",
      "description": "image_url"
    },
    "logotype_path": {
      "type": "string",
      "description": "logotype_path"
    },
    "logotype_url": {
      "type": "string",
      "description": "logotype_url"
    },
    "max_session_students": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "max_session_students"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "proposed_terms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "description": "proposed_terms"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "updated_at": {
      "type": "string",
      "description": "updated_at"
    }
  },
  "required": [
    "author_id",
    "description",
    "name",
    "status"
  ],
  "additionalProperties": {}
}

ulams consultations delete

Section titled “ulams consultations delete”

Remove the specified Consultation from storage.

Kind: destructive (idempotent). Stability: stable. MCP tool: consultations_delete. Scopes: events:write.

Endpoints: DELETE /api/admin/consultations/{id}.

Flag Type Required Description
--id (positional) integer yes id of Consultation
Terminal window
# Remove the specified Consultation from storage
ulams consultations delete 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Consultation"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams consultations get

Section titled “ulams consultations get”

Display the specified Consultation.

Kind: read (idempotent). Stability: stable. MCP tool: consultations_get. Scopes: events:read.

Endpoints: GET /api/admin/consultations/{id}.

Flag Type Required Description
--id (positional) integer yes id of Consultation
Terminal window
# Display the specified Consultation
ulams consultations get 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Consultation"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams consultations list

Section titled “ulams consultations list”

GET /api/admin/consultations.

Kind: read (idempotent). Stability: stable. MCP tool: consultations_list. Scopes: events:read.

Endpoints: GET /api/admin/consultations.

Flag Type Required Description
--order-by string
--order string
--page number Pagination Page Number
--per-page number Pagination Per Page
--name string Consultation name %LIKE%
--status string Consultation status ==
--only-with-categories boolean Consultation has categories
Terminal window
# GET /api/admin/consultations
ulams consultations list --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "order_by": {
      "type": "string",
      "enum": [
        "id",
        "name",
        "status",
        "duration",
        "active_from",
        "active_to",
        "created_at"
      ]
    },
    "order": {
      "type": "string",
      "enum": [
        "ASC",
        "DESC"
      ]
    },
    "page": {
      "type": "number",
      "description": "Pagination Page Number"
    },
    "per_page": {
      "type": "number",
      "description": "Pagination Per Page"
    },
    "name": {
      "type": "string",
      "description": "Consultation name %LIKE%"
    },
    "status": {
      "type": "string",
      "description": "Consultation status =="
    },
    "only_with_categories": {
      "type": "boolean",
      "description": "Consultation has categories"
    }
  },
  "additionalProperties": {}
}

ulams consultations schedule

Section titled “ulams consultations schedule”

Get Consultation schedule.

Kind: read (idempotent). Stability: stable. MCP tool: consultations_schedule. Scopes: events:read.

Endpoints: GET /api/admin/consultations/{id}/schedule.

Flag Type Required Description
--id (positional) integer yes id of Consultation
--date-from string Course term date from
--date-to string Course term date to
--status string Course term status: not_reported, reported, reject, approved
Terminal window
# Get Consultation schedule
ulams consultations schedule 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Consultation"
    },
    "date_from": {
      "type": "string",
      "description": "Course term date from"
    },
    "date_to": {
      "type": "string",
      "description": "Course term date to"
    },
    "status": {
      "type": "string",
      "description": "Course term status: not_reported, reported, reject, approved"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams consultations update

Section titled “ulams consultations update”

Update the specified Consultation in storage.

Kind: write (idempotent). Stability: stable. MCP tool: consultations_update. Scopes: events:write.

Endpoints: PUT /api/admin/consultations/{id}.

Flag Type Required Description
--id (positional) integer yes id of Consultation
--active-from string active_from
--active-to string active_to
--author-id integer author_id
--busy-terms array busy_terms
--categories array categories
--consultation-user-id integer consultation_user_id
--created-at string created_at
--description string description
--duration string duration
--executed-at string executed_at
--executed-status string executed_status
--image-path string image_path
--image-url string image_url
--logotype-path string logotype_path
--logotype-url string logotype_url
--max-session-students integer max_session_students
--name string name
--proposed-terms array proposed_terms
--status string status
--updated-at string updated_at
Terminal window
# Update the specified Consultation in storage
ulams consultations update 1 --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "id of Consultation"
    },
    "active_from": {
      "type": "string",
      "description": "active_from"
    },
    "active_to": {
      "type": "string",
      "description": "active_to"
    },
    "author_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "author_id"
    },
    "busy_terms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "description": "busy_terms"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "icon_class": {
            "type": "string"
          },
          "is_active": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "parent_id": {}
        },
        "additionalProperties": {}
      },
      "description": "categories"
    },
    "consultation_user_id": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "consultation_user_id"
    },
    "created_at": {
      "type": "string",
      "description": "created_at"
    },
    "description": {
      "type": "string",
      "description": "description"
    },
    "duration": {
      "type": "string",
      "description": "duration"
    },
    "executed_at": {
      "type": "string",
      "description": "executed_at"
    },
    "executed_status": {
      "type": "string",
      "description": "executed_status"
    },
    "image_path": {
      "type": "string",
      "description": "image_path"
    },
    "image_url": {
      "type": "string",
      "description": "image_url"
    },
    "logotype_path": {
      "type": "string",
      "description": "logotype_path"
    },
    "logotype_url": {
      "type": "string",
      "description": "logotype_url"
    },
    "max_session_students": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991,
      "description": "max_session_students"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "proposed_terms": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          }
        },
        "additionalProperties": {}
      },
      "description": "proposed_terms"
    },
    "status": {
      "type": "string",
      "description": "status"
    },
    "updated_at": {
      "type": "string",
      "description": "updated_at"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": {}
}

ulams consultations users-assignable

Section titled “ulams consultations users-assignable”

Get users assignable to consultations.

Kind: read (idempotent). Stability: stable. MCP tool: consultations_users_assignable. Scopes: events:read.

Endpoints: GET /api/admin/consultations/users/assignable.

Flag Type Required Description
--search string
Terminal window
# Get users assignable to consultations
ulams consultations users-assignable --json
Input JSON Schema 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "search": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}