V1::PathsController
Path
index
Get a list of paths
URL
GET /paths or /school_products/:school_product_id/paths or /enrollments/:enrollment_id/pathsObjeto resposta
| Array<Path> | The created paths |
create
Create new path
URL
POST /pathsParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| path | Hash | The path to create |
| path[name] | String | Name of the path |
| path[description] | String | Description of the path |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| path[image_url] | String | URL of the path image |
| path[code] | String | Custom code to use as identifier |
| path[course_ids] | Array<Integer> | An array of course ids to associate to the path |
Objeto resposta
| Path | The created path or a list of errors |
show
Get a paths information
URL
GET /paths/:id or /school_products/:school_product_id/paths/:id or /enrollments/:enrollment_id/paths/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | of the path |
Objeto resposta
| Path | The requested path |
add_course
Add course to path
URL
PUT/PATCH /paths/:id/add_courseremove_course
Remove course from path
URL
PUT/PATCH /paths/:id/remove_courseupdate
Update an existing path and redirect to 'show' action
URL
PUT/PATCH /paths/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| path | Hash | The path to create |
| path | String | name Name of the path |
| path | String | description Description of the path |
Objeto resposta
| Path | The created path or a list of errors |
destroy
Destroy path
URL
DELETE /paths/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | Id of a path |
