Documentation Powered by ReDoc

DarwinEd API (2.0)

Download OpenAPI specification:Download

Jonathan Urzúa: jonathan@foris.ai URL: https://foris.ai

DarwinEd API v2

Authentication

token

DarwinEd API token of user

Security scheme type: API Key
Header parameter name: token

Components

View Component

Get component by ID

Authorizations:
token
path Parameters
componentId
required
number

Component ID

query Parameters
active_scenario_id
required
integer

Scenario ID to use

Responses

200
get /components/{componentId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/components/{componentId}

Local development server

http://localhost:4000/api/v2/components/{componentId}

Delete Component

Deletes a Component record (by ID)

Authorizations:
token
path Parameters
componentId
required
number

Component ID

Responses

200
delete /components/{componentId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/components/{componentId}

Local development server

http://localhost:4000/api/v2/components/{componentId}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    [
    ]
}

Import Components

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
data
required
Array of objects (Datum1)

Responses

200
post /components/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/components/import

Local development server

http://localhost:4000/api/v2/components/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

List Components

List components

Authorizations:
token

Responses

200
get /components

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/components

Local development server

http://localhost:4000/api/v2/components

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Component

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /components

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/components

Local development server

http://localhost:4000/api/v2/components

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "PR3",
  • "name": "PRACTICA3"
}

Classrooms

List Classrooms

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
integer

Scenario ID to use

Responses

200
get /classrooms

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms

Local development server

http://localhost:4000/api/v2/classrooms

Create Classroom

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
integer

Scenario ID to use

Request Body schema: application/json
campus_id
required
integer <int32>
campus
required
string
building_id
required
integer <int32>
building
required
string
classroom_type_id
required
integer <int32>
classroom_type_code
required
string
name
required
string
label
required
string
code
required
string
capacity
required
integer <int32>
floor
required
string
allowed_overload
required
integer <int32>
legacy
required
boolean

Responses

200
post /classrooms

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms

Local development server

http://localhost:4000/api/v2/classrooms

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campus_id": 0,
  • "campus": "string",
  • "building_id": 0,
  • "building": "string",
  • "classroom_type_id": 0,
  • "classroom_type_code": "string",
  • "name": "string",
  • "label": "string",
  • "code": "string",
  • "capacity": 0,
  • "floor": "string",
  • "allowed_overload": 0,
  • "legacy": true
}

Get Classroom

Get classroom by ID

Authorizations:
token
path Parameters
classroomId
required
number

Classroom ID

Responses

200
get /classrooms/{classroomId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms/{classroomId}

Local development server

http://localhost:4000/api/v2/classrooms/{classroomId}

Edit Classroom

TODO: Add Description

Authorizations:
token
path Parameters
classroomId
required
number

Classroom ID

Request Body schema: application/json
name
required
string

Responses

200
post /classrooms/{classroomId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms/{classroomId}

Local development server

http://localhost:4000/api/v2/classrooms/{classroomId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Delete Classroom

TODO: Add Description

Authorizations:
token
path Parameters
classroomId
required
number

Classroom ID

Request Body schema: application/json
name
required
string

Responses

200
delete /classrooms/{classroomId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms/{classroomId}

Local development server

http://localhost:4000/api/v2/classrooms/{classroomId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Import Classrooms

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
integer

Scenario ID to use

Request Body schema: application/json
data
required
Array of objects (Data1)

Responses

200
post /classrooms/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classrooms/import

Local development server

http://localhost:4000/api/v2/classrooms/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Classroom Types

List Classroom Types

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
integer

Scenario ID to use

Responses

200
get /classroom_types

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classroom_types

Local development server

http://localhost:4000/api/v2/classroom_types

Create Classroom Type

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
integer

Scenario ID to use

Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /classroom_types

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classroom_types

Local development server

http://localhost:4000/api/v2/classroom_types

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "string",
  • "name": "string"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Classroom Type

TODO: Add Description

Authorizations:
token
path Parameters
classroomTypeId
required
integer

Classroom Type

query Parameters
active_scenario_id
required
integer

Scenario ID to use

Responses

200
get /classroom_types/{classroomTypeId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classroom_types/{classroomTypeId}

Local development server

http://localhost:4000/api/v2/classroom_types/{classroomTypeId}

Edit Classroom Type

TODO: Add Description

Authorizations:
token
path Parameters
classroomTypeId
required
integer

Classroom Type

query Parameters
active_scenario_id
required
integer

Scenario ID to use

Request Body schema: application/json
name
required
string

Responses

200
post /classroom_types/{classroomTypeId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/classroom_types/{classroomTypeId}

Local development server

http://localhost:4000/api/v2/classroom_types/{classroomTypeId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Buildings

List Buildings

TODO: Add Description

Authorizations:
token

Responses

200
get /buildings

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/buildings

Local development server

http://localhost:4000/api/v2/buildings

Create Building

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
campus_id
required
integer <int32>
code
required
string
name
required
string

Responses

200
post /buildings

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/buildings

Local development server

http://localhost:4000/api/v2/buildings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campus_id": 0,
  • "code": "string",
  • "name": "string"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    [
    ]
}

View Building

TODO: Add Description

Authorizations:
token

Responses

200
get /buildings/42

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/buildings/42

Local development server

http://localhost:4000/api/v2/buildings/42

Edit Building

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /buildings/42

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/buildings/42

Local development server

http://localhost:4000/api/v2/buildings/42

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "New name for building"
}

Regions

List Regions

TODO: Add Description

Authorizations:
token

Responses

200
get /regions

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/regions

Local development server

http://localhost:4000/api/v2/regions

Create Region

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
label
required
string
code
required
string
name
required
string

Responses

200
post /regions

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/regions

Local development server

http://localhost:4000/api/v2/regions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "label": 1,
  • "code": "0001X",
  • "name": "hello"
}

View Region

TODO: Add Description

Authorizations:
token

Responses

200
get /regions/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/regions/1

Local development server

http://localhost:4000/api/v2/regions/1

Edit Region

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /regions/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/regions/1

Local development server

http://localhost:4000/api/v2/regions/1

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "hello2"
}

Administrations

List Administrations

TODO: Add Description

Authorizations:
token

Responses

200
get /administrations

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/administrations

Local development server

http://localhost:4000/api/v2/administrations

Create Administration

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /administrations

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/administrations

Local development server

http://localhost:4000/api/v2/administrations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "X",
  • "name": "X"
}

View Administration

TODO: Add Description

Authorizations:
token
path Parameters
administrationId
required
integer

Administration ID

Responses

200
get /administrations/{administrationId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/administrations/{administrationId}

Local development server

http://localhost:4000/api/v2/administrations/{administrationId}

Edit Administration

TODO: Add Description

Authorizations:
token
path Parameters
administrationId
required
integer

Administration ID

Request Body schema: application/json
name
required
string

Responses

200
post /administrations/{administrationId}

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/administrations/{administrationId}

Local development server

http://localhost:4000/api/v2/administrations/{administrationId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "X22"
}

Areas

List Areas

TODO: Add Description

Authorizations:
token

Responses

200
get /areas

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/areas

Local development server

http://localhost:4000/api/v2/areas

Create Area

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /areas

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/areas

Local development server

http://localhost:4000/api/v2/areas

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "TEST",
  • "name": "X56"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Area

TODO: Add Description

Authorizations:
token

Responses

200
get /areas/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/areas/1

Local development server

http://localhost:4000/api/v2/areas/1

Edit Area

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string
legacy
required
boolean

Responses

200

hola

post /areas/19

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/areas/19

Local development server

http://localhost:4000/api/v2/areas/19

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "X2asdasd2",
  • "legacy": true
}

Departments

List Departments

TODO: Add Description

Authorizations:
token

Responses

200
get /departments

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/departments

Local development server

http://localhost:4000/api/v2/departments

Create Department

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
area_id
required
integer <int32>
name
required
string
code
required
string

Responses

200
post /departments

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/departments

Local development server

http://localhost:4000/api/v2/departments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "area_id": 1,
  • "name": "X222",
  • "code": 11222
}

View Department

TODO: Add Description

Authorizations:
token

Responses

200
get /departments/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/departments/1

Local development server

http://localhost:4000/api/v2/departments/1

Edit Department

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string
legacy
required
boolean

Responses

200
post /departments/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/departments/1

Local development server

http://localhost:4000/api/v2/departments/1

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "X22",
  • "legacy": true
}

Shifts

List Shifts

TODO: Add Description

Authorizations:
token

Responses

200
get /shifts

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/shifts

Local development server

http://localhost:4000/api/v2/shifts

Create Shift

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
string
Example: active_scenario_id=%7B%7Bactive_scenario_id%7D%7D
header Parameters
token
required
string
Example: {{token}}
Request Body schema: application/json
name
required
string
code
required
string

Responses

200
post /shifts

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/shifts

Local development server

http://localhost:4000/api/v2/shifts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "V",
  • "code": "V"
}

View Shift

TODO: Add Description

Authorizations:
token

Responses

200
get /shifts/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/shifts/1

Local development server

http://localhost:4000/api/v2/shifts/1

Edit Shift

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /shifts/2

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/shifts/2

Local development server

http://localhost:4000/api/v2/shifts/2

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "Diurna"
}

Create Instructor

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string
min_hours
required
integer <int32>
max_hours
required
integer <int32>

Responses

200
post /instructors

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/instructors

Local development server

http://localhost:4000/api/v2/instructors

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "INS1",
  • "name": "John",
  • "min_hours": 10,
  • "max_hours": 50
}

Modalities

List Modalities

TODO: Add Description

Authorizations:
token

Responses

200
get /modalities

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/modalities

Local development server

http://localhost:4000/api/v2/modalities

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Modality

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /modalities

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/modalities

Local development server

http://localhost:4000/api/v2/modalities

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "TR",
  • "name": "New Modality"
}

View Modality

TODO: Add Description

Authorizations:
token

Responses

200
get /modalities/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/modalities/1

Local development server

http://localhost:4000/api/v2/modalities/1

Edit Modality

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /modalities/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/modalities/1

Local development server

http://localhost:4000/api/v2/modalities/1

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "New name for modality"
}

Programs

List Programs

TODO: Add Description

Authorizations:
token

Responses

200
get /programs

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/programs

Local development server

http://localhost:4000/api/v2/programs

Create Program

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
campus_id
required
integer <int32>
modality_id
required
integer <int32>
shift_id
required
integer <int32>
department_id
required
integer <int32>
area_id
required
integer <int32>
name
required
string
label
required
string
code
required
string

Responses

200
post /programs

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/programs

Local development server

http://localhost:4000/api/v2/programs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campus_id": 2,
  • "modality_id": 1,
  • "shift_id": 1,
  • "department_id": 8,
  • "area_id": 8,
  • "name": "PRUEBA",
  • "label": 9999,
  • "code": 9999
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Program

TODO: Add Description

Authorizations:
token

Responses

200
get /programs/185

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/programs/185

Local development server

http://localhost:4000/api/v2/programs/185

Edit Program

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /programs/185

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/programs/185

Local development server

http://localhost:4000/api/v2/programs/185

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "X22"
}

Curriculums

Note: This endpoints does not support the EDIT operation, as curricuculum are non-editable. You need to create a new curricuculum (with the desired changes)

List Curriculums

TODO: Add Description

Authorizations:
token

Responses

200
get /curriculums

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/curriculums

Local development server

http://localhost:4000/api/v2/curriculums

Create Curriculum

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
program_id
required
integer <int32>
plan
required
string

Responses

200
post /curriculums

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/curriculums

Local development server

http://localhost:4000/api/v2/curriculums

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "program_id": 191,
  • "plan": "X2"
}

View Curriculum

TODO: Add Description

Authorizations:
token

Responses

200
get /curriculums/543

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/curriculums/543

Local development server

http://localhost:4000/api/v2/curriculums/543

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Levels

List Levels

TODO: Add Description

Authorizations:
token

Responses

200
get /levels

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/levels

Local development server

http://localhost:4000/api/v2/levels

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Level

TODO: Add Description

Authorizations:
token
query Parameters
active_scenario_id
required
string
Example: active_scenario_id=%7B%7Bactive_scenario_id%7D%7D
header Parameters
token
required
string
Example: {{token}}
Request Body schema: application/json
curriculum_id
required
integer <int32>
level
required
integer <int32>
max_subjects_per_year
required
integer <int32>
max_credits_per_term
required
integer <int32>

Responses

200
post /levels

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/levels

Local development server

http://localhost:4000/api/v2/levels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "curriculum_id": 536,
  • "level": 3,
  • "max_subjects_per_year": 10,
  • "max_credits_per_term": 50
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Course

TODO: Add Description

Authorizations:
token

Responses

200
get /courses/9185

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/courses/9185

Local development server

http://localhost:4000/api/v2/courses/9185

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Edit Level

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
max_subjects_per_term
required
integer <int32>

Responses

200
post /levels/3

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/levels/3

Local development server

http://localhost:4000/api/v2/levels/3

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "max_subjects_per_term": 7
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Import Levels

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
data
required
Array of objects (Data13)

Responses

200
post /levels/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/levels/import

Local development server

http://localhost:4000/api/v2/levels/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Courses

Edit Course

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string
legacy
required
boolean

Responses

200
post /courses/9185

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/courses/9185

Local development server

http://localhost:4000/api/v2/courses/9185

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "X22",
  • "legacy": true
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

List Courses

TODO: Add Description

Authorizations:
token

Responses

200
get /courses

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/courses

Local development server

http://localhost:4000/api/v2/courses

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Course

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
curriculum_id
required
integer <int32>
code
required
string
name
required
string

Responses

200
post /courses

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/courses

Local development server

http://localhost:4000/api/v2/courses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "curriculum_id": 536,
  • "code": "ASDF",
  • "name": "X22"
}

Import Courses

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
data
required
Array of objects (Data18)

Responses

200
post /courses/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/courses/import

Local development server

http://localhost:4000/api/v2/courses/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Terms

List Terms

TODO: Add Description

Authorizations:
token

Responses

200
get /terms

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/terms

Local development server

http://localhost:4000/api/v2/terms

Create Term

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /terms

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/terms

Local development server

http://localhost:4000/api/v2/terms

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "X",
  • "name": "X"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Term

TODO: Add Description

Authorizations:
token

Responses

200
get /terms/2

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/terms/2

Local development server

http://localhost:4000/api/v2/terms/2

Edit Term

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /terms/5

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/terms/5

Local development server

http://localhost:4000/api/v2/terms/5

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": 12
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Intervals

List Intervals

TODO: Add Description

Authorizations:
token

Responses

200
get /intervals

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/intervals

Local development server

http://localhost:4000/api/v2/intervals

Create Interval

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
term_id
required
integer <int32>
name
required
string
starting_date
required
string
ending_date
required
string

Responses

200
post /intervals

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/intervals

Local development server

http://localhost:4000/api/v2/intervals

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "term_id": 1,
  • "name": "S2",
  • "starting_date": "2016-07-30T00:00:00.000Z",
  • "ending_date": "2016-08-06T00:00:00.000Z"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Interval

TODO: Add Description

Authorizations:
token

Responses

200
get /intervals/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/intervals/1

Local development server

http://localhost:4000/api/v2/intervals/1

Edit Interval

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string

Responses

200
post /intervals/5

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/intervals/5

Local development server

http://localhost:4000/api/v2/intervals/5

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "S2X"
}

Blocks

NOTE: Blocks are not editable, you must execute a mass import operation in order to change the blocks grid.

List Blocks

TODO: Add Description

Authorizations:
token

Responses

200
get /blocks

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/blocks

Local development server

http://localhost:4000/api/v2/blocks

View Block

TODO: Add Description

Authorizations:
token

Responses

200
get /blocks/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/blocks/1

Local development server

http://localhost:4000/api/v2/blocks/1

Stripes

List Stripes

TODO: Add Description

Authorizations:
token

Responses

200
get /stripes

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/stripes

Local development server

http://localhost:4000/api/v2/stripes

View Stripe

TODO: Add Description

Authorizations:
token

Responses

200
get /stripes/4

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/stripes/4

Local development server

http://localhost:4000/api/v2/stripes/4

Edit Stripe

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
name
required
string
blocks_ids
required
Array of integers <int32>

Responses

200
post /stripes/4

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/stripes/4

Local development server

http://localhost:4000/api/v2/stripes/4

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "blocks_ids":
    [
    ]
}

Course Components

List Course Components

TODO: Add Description

Authorizations:
token

Responses

200
get /course_components

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/course_components

Local development server

http://localhost:4000/api/v2/course_components

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Course Component

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
course_id
required
integer <int32>
component_id
required
integer <int32>

Responses

200
400

Bad Request

post /course_components

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/course_components

Local development server

http://localhost:4000/api/v2/course_components

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "course_id": 9186,
  • "component_id": 50
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Course Component

TODO: Add Description

Authorizations:
token

Responses

200
404

Not Found

get /course_components/65199

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/course_components/65199

Local development server

http://localhost:4000/api/v2/course_components/65199

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "course_id": 0,
  • "component_id": 0,
  • "academic_standard": 0,
  • "events_per_interval": 0,
  • "sessions_per_interval": 0,
  • "type": "string",
  • "attendance_type": "string",
  • "modulation": "string",
  • "online": true,
  • "usable": true,
  • "inline": true,
  • "nativo": true,
  • "component": "string",
  • "course": "string",
  • "course_label": "string",
  • "course_name": "string",
  • "course_level": "string",
  • "course_elective_code": "string",
  • "course_widespread": true,
  • "shift": "string",
  • "shift_id": 0,
  • "campus": "string",
  • "campus_id": 0,
  • "department": "string",
  • "department_id": 0,
  • "modality": "string",
  • "modality_id": 0,
  • "program_id": 0,
  • "program": "string",
  • "curriculum": "string",
  • "curriculum_id": 0,
  • "impartation_intervals_ids":
    [
    ],
  • "impartation_intervals":
    [
    ],
  • "classroom_priorities":
    [
    ],
  • "stripe_priorities":
    [
    ]
}

Import Course Components

TODO: Add Description

Authorizations:
token
query Parameters
term_id
required
integer <int32>
Request Body schema: application/json
data
required
Array of objects (Data25)

Responses

200
post /course_components/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/course_components/import

Local development server

http://localhost:4000/api/v2/course_components/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Instructors

List Instructors

TODO: Add Description

Authorizations:
token

Responses

200
get /instructors

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/instructors

Local development server

http://localhost:4000/api/v2/instructors

View Instructor

TODO: Add Description

Authorizations:
token

Responses

200
get /instructors/5920

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/instructors/5920

Local development server

http://localhost:4000/api/v2/instructors/5920

Edit Instructor

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
min_hours
required
integer <int32>
max_hours
required
integer <int32>
priority
required
integer <int32>
blocks_ids
required
Array of integers <int32>
course_components
required
Array of objects (CourseComponent)

Responses

200
post /instructors/7963

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/instructors/7963

Local development server

http://localhost:4000/api/v2/instructors/7963

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "min_hours": 0,
  • "max_hours": 0,
  • "priority": 0,
  • "blocks_ids":
    [
    ],
  • "course_components":
    [
    ]
}

Pagination Examples

This collections shows some ways to paginate results of endpoints

Students

List Students

List components

Authorizations:
token
query Parameters
page[size]
integer <int32>
Example: page[size]=10

Responses

200
get /students

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/students

Local development server

http://localhost:4000/api/v2/students

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Create Student

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
code
required
string
name
required
string

Responses

200
post /students

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/students

Local development server

http://localhost:4000/api/v2/students

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "STUDENT_CODE_TEST",
  • "name": "Student Name"
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Import Students

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
data
required
Array of objects (Data34)

Responses

200
post /students/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/students/import

Local development server

http://localhost:4000/api/v2/students/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Student

List components

Authorizations:
token

Responses

200
get /students/7

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/students/7

Local development server

http://localhost:4000/api/v2/students/7

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Delete Student

Deletes a Component record (by ID)

Authorizations:
token

Responses

200
delete /students/1

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/students/1

Local development server

http://localhost:4000/api/v2/students/1

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta": [ ]
}

Student Registries

List Student Registries

List components

Authorizations:
token
query Parameters
page[size]
integer <int32>
Example: page[size]=10

Responses

200
get /student_registries

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/student_registries

Local development server

http://localhost:4000/api/v2/student_registries

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Import Student Registries

TODO: Add Description

Authorizations:
token
Request Body schema: application/json
data
required
Array of objects (Data39)

Responses

200
post /student_registries/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/student_registries/import

Local development server

http://localhost:4000/api/v2/student_registries/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Student Registry

List components

Authorizations:
token

Responses

200
get /student_registries/4

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/student_registries/4

Local development server

http://localhost:4000/api/v2/student_registries/4

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Delete Student Copy

Deletes a Component record (by ID)

Authorizations:
token

Responses

200
delete /student_registries/4

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/student_registries/4

Local development server

http://localhost:4000/api/v2/student_registries/4

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta": [ ]
}

Records

List Records of an Origin

List components

Authorizations:
token
query Parameters
limit
integer <int32>
Example: limit=5
origin_id
required
integer <int32>
Example: origin_id=513

Responses

200
get /records

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/records

Local development server

http://localhost:4000/api/v2/records

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Import Records into new Origin

TODO: Add Description

Authorizations:
token
query Parameters
origin_id
required
string
Example: origin_id=create
periodo_id
required
integer <int32>
Example: periodo_id=52
Request Body schema: application/json
data
required
Array of objects (Data44)

Responses

200
post /records/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/records/import

Local development server

http://localhost:4000/api/v2/records/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Record

List components

Authorizations:
token

Responses

200
get /records/1805969

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/records/1805969

Local development server

http://localhost:4000/api/v2/records/1805969

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Setup Demands

List Demands of an Origin

List components

Authorizations:
token
query Parameters
limit
required
integer <int32>
Example: limit=5
origin_id
required
integer <int32>
Example: origin_id=336

Responses

200
get /demands

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/demands

Local development server

http://localhost:4000/api/v2/demands

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Import Forecast Setup Demands into new Origin

TODO: Add Description

Authorizations:
token
query Parameters
origin_id
required
string
Example: origin_id=create
demand_type_id
required
integer <int32>
Example: demand_type_id=5
periodo_id
required
integer <int32>
Example: periodo_id=5
Request Body schema: application/json
data
required
Array of objects (Data50)

Responses

200
post /demands/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/demands/import

Local development server

http://localhost:4000/api/v2/demands/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Demand

List components

Authorizations:
token

Responses

200
get /demands/200006

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/demands/200006

Local development server

http://localhost:4000/api/v2/demands/200006

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Enrollments

List Enrollments of an Origin

List components

Authorizations:
token
query Parameters
origin_id
required
integer <int32>
Example: origin_id=516

Responses

200
get /enrollments

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/enrollments

Local development server

http://localhost:4000/api/v2/enrollments

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}

Import Enrollments into new Origin

TODO: Add Description

Authorizations:
token
query Parameters
origin_id
required
string
Example: origin_id=create
Request Body schema: application/json
data
required
Array of objects (Data56)

Responses

200
post /enrollments/import

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/enrollments/import

Local development server

http://localhost:4000/api/v2/enrollments/import

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ]
}

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

View Enrollment

List components

Authorizations:
token

Responses

200
get /enrollments/549330

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/enrollments/549330

Local development server

http://localhost:4000/api/v2/enrollments/549330

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "meta":
    {
    }
}

Scenarios

List Scenarios

Get the list of all scenarios for the institution

Authorizations:
token

Responses

200
get /api_scenarios

Unisabana UAT

https://demo.foris.cl/unisabana_uat/api/v2/api_scenarios

Local development server

http://localhost:4000/api/v2/api_scenarios

Response samples

Content type
application/json; charset=UTF-8
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "meta":
    {
    }
}