Class Manager
PATCH /v1/custom-field-responses/

Update custom field responses for entity

application/json

Body

Update custom field response request

  • entityId string Required

    Entity id

  • fields array[object] Required

    Custom field responses

    Hide fields attributes Show fields attributes object
    • id string Required

      Custom field id

    • value

      Custom field value

Responses

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    successful operation

    Hide response attribute Show response attribute object
    • fields array[object] Required

      List of responses for specific entity

      CustomFieldResponse schema

      Hide fields attributes Show fields attributes object
      • customField object Required

        CustomField schema

        Hide customField attributes Show customField attributes object
        • id string Required

          id

        • companyId string Required

          Company ID

        • type string Required

          Values are text, textarea, number, select, multiselect, date, or bool.

        • title string Required

          Title

        • entity string Required

          Values are staff, student, or family.

        • options array[string] | null Required

          Options

      • value Required

        Value
PATCH /v1/custom-field-responses/ 
curl \
 --request PATCH 'https://classmanager.test/v1/custom-field-responses/' \
 --header "Content-Type: application/json" \
 --data '{"entityId":"stf_xxxxxxxx","fields":[{"id":"stf_xxxxxxxx","value":"Answer 1"},{"id":"stf_xxxxxxxx","value":"Answer 2"}]}'
Request examples 
{
  "entityId": "stf_xxxxxxxx",
  "fields": [
    {
      "id": "stf_xxxxxxxx",
      "value": "Answer 1"
    },
    {
      "id": "stf_xxxxxxxx",
      "value": "Answer 2"
    }
  ]
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
{
  "fields": [
    {
      "value": "answer1",
      "customField": {
        "id": "cf_123123123123",
        "type": "select",
        "title": "Custom Field Title",
        "options": [
          "answer1",
          "answer2"
        ],
        "companyId": "co_123123123123"
      }
    }
  ]
}