V1::SchoolsController
Schools
index
Get a list of schools. This list can be filtered by user.
URL
GET /schoolsParâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| String | User's email (required with type present) |
|
| type | String | User's type (Student or Collaborator) (required with email present) |
Objeto resposta
| Array<School> | The created schools |
show
View a content school
URL
GET /schools/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | Identifier the school |
Objeto resposta
| School | The requested school |
create
Create school
URL
POST /schoolsParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| school | Hash | The School to create |
| school[name] | String | Name of the school |
| school[subdomain] | String | Subdomain of the school |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| school[domains] | Array<String> | Domains of the school |
| school[rdstation_token] | String | Rdstation_token of the school |
| school[adroll_adv_id] | String | Adroll_adv_id of the school |
| school[adroll_pix_id] | String | Adroll_pix_id of the school |
| school[email] | String | Email of the school |
| school[phone] | String | Phone of the school |
| school[cnpj] | String | Cnpj of the school |
| school[samba_key] | String | Samba key of the school |
| school[samba_player_key] | String | Samba player key of the school |
| school[samba_access_token] | String | Samba access token of the school |
| school[samba_project_id] | String | Samba project id of the school |
| school[terms_of_use] | Text | |
| school[adroll_adv_id] | String | |
| school[adroll_pix_id] | String | |
| school[facebook] | String | |
| school[twitter] | String | |
| school[linkedin] | String | |
| school[pinterest] | String | |
| school[google_plus] | String | |
| school[youtube] | String | |
| school[instagram] | String | |
| school[site] | String | |
| school[address] | String | |
| school[company_name] | String | |
| school[seo_title] | String | |
| school[seo_description] | String | |
| school[logo] | String | |
| school[metadata] | Json | |
| school[meta_available_locales] | Json | School locales |
Objeto resposta
| School | The created school or a list of errors |
wizard
Create school
URL
POST /schools/wizardParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| school | Hash | The school to create |
| school[name] | String | Name used at School, Organization, Admin and also to infer School's subdomain |
| school[email] | String | Email used at School and Admin |
| school[password] | String | Password set to the new Admin |
update
Update an existing school
URL
PUT/PATCH /school/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| school | Hash | The School to create |
| school[name] | String | Name of the school |
| school[subdomain] | String | Subdomain of the school |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| school[domains] | Array<String> | Domains of the school |
| school[rdstation_token] | String | Rdstation_token of the school |
| school[adroll_adv_id] | String | Adroll_adv_id of the school |
| school[adroll_pix_id] | String | Adroll_pix_id of the school |
| school[email] | String | Email of the school |
| school[phone] | String | Phone of the school |
| school[cnpj] | String | Cnpj of the school |
| school[samba_key] | String | Samba key of the school |
| school[samba_player_key] | String | Samba player key of the school |
| school[samba_access_token] | String | Samba access token of the school |
| school[samba_project_id] | String | Samba project id of the school |
| school[terms_of_use] | Text | |
| school[adroll_adv_id] | String | |
| school[adroll_pix_id] | String | |
| school[facebook] | String | |
| school[twitter] | String | |
| school[linkedin] | String | |
| school[pinterest] | String | |
| school[google_plus] | String | |
| school[youtube] | String | |
| school[instagram] | String | |
| school[site] | String | |
| school[address] | String | |
| school[company_name] | String | |
| school[seo_title] | String | |
| school[seo_description] | String | |
| school[logo] | String | |
| school[metadata] | Json | |
| school[meta_available_locales] | Json | School locales |
| school[event] | String | Event triggered by school. Event can be try_out, block, active, overdue, suspend or cancel. |
Objeto resposta
| School | The updated school or a list of errors |
destroy
Delete school
URL
DELETE /school/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | Integer | Id of an school |
