Skip to main content

​
Organizations

Organizations are sub-units of an institution — faculties, departments, schools, or campuses. Courses can optionally be associated with an organization for better classification.

​
The organization object

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "School of Engineering",
  "code": "ENG",
  "institution": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology"
  },
  "created_at": "2024-01-15T10:00:00.000000Z"
}
FieldTypeDescription
uuidstringUnique identifier
namestringOrganization name
codestringShort code for internal reference
institutionobjectThe parent institution

​
List organizations

GET /organizations

curl https://api.dokstamp.eu/organizations \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Create an organization

POST /organizations
ParameterTypeRequiredDescription
namestringYesOrganization name
institution_uuidstringYesParent institution UUID
codestringNoShort reference code
curl -X POST https://api.dokstamp.eu/organizations \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "School of Engineering",
    "code": "ENG",
    "institution_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

​
Get, update, delete

GET    /organizations/{uuid}
PATCH  /organizations/{uuid}
PUT    /organizations/{uuid}
DELETE /organizations/{uuid}
DELETE /organizations/batch/destroy
All follow the same conventions as other resources. See Institutions for detailed examples.