Create Student Photo Permission

POST 
/students/:communityId/photo-permissions

Create a photo permission record for a student.

For a list of all photo permission types, go to Lookup - Photo Permission Type.

Request

Path Parameters

communityId uuidrequired

The unique identifier of the community member.

application/json

Body

required

Create photo permission payload

comment stringnullablerequired
photoPermissionType objectrequired

id uuidrequired

Lookup - Photo Permission Type

photoPermissionGranted booleanrequired

Responses

201

Created

application/json

Schema

Schema

code stringrequired

Status Code

data object
id uuidrequired
comment stringnullablerequired
photoPermissionGranted booleanrequired
photoPermissionType objectrequired
id uuidrequired
Lookup - Photo Permission Type
description stringrequired
code stringrequired

Example (from schema)

{
  "code": "OK",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "comment": "string",
    "photoPermissionGranted": true,
    "photoPermissionType": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "code": "string"
    }
  }
}

Successful

{
  "code": "CREATED",
  "data": {
    "id": "65d44722-5592-41d8-89b1-6dea990b44a2",
    "comment": "Parent gives permission",
    "photoPermissionGranted": true,
    "photoPermissionType": {
      "id": "32bd35eb-6f03-4bbc-baf5-876f7077e319",
      "description": "Promotional material",
      "code": "PM"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1100",
      "message": "Bad Request"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1101",
      "message": "Unauthorized"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1102",
      "message": "Forbidden"
    }
  ]
}

404

Resource not found

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1103",
      "message": "Not Found"
    }
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1108",
      "message": "Unprocessable Entity"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
message stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "errors": [
    {
      "code": "PA1109",
      "message": "Internal Server Error"
    }
  ]
}

Loading...