V1::GatewayCredentialsController
GatewayCredential
index
Get a list of gateway credentials
URL
GET /school/:school_id/gateway_credentialsParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| school_id | String | global unique id of the school |
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
| page | String | The desired page of results |
| per_page | String | How many gateway credentials per page (only works when page is provided) |
Objeto resposta
| Array<School::GatewayCredential> | The desired gateway credentials |
update
Update a desired gateway credential
URL
PATCH/PUT /gateway_credential/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | String | The id of the gateway credential to update |
| gateway_crendetial | Hash | The gateway credential params to update |
Objeto resposta
| School::GatewayCredential | The updated gateway credential or a list of errors |
destroy
Delete an existing gateway credential
URL
DELETE /gateway_credential/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| id | String | The id of the gateway credential to delete |
show
Get a gateway credential information
URL
GET /school/:school_guid/gateway_credential/:idParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| school_guid | String | global unique id of the school |
| id | String | id of the gateway credential |
Objeto resposta
| School::GatewayCredential | The requested gateway credential |
create
Create new gateway credentials
URL
POST /school/:school_id/gateway_credentialsParâmetros obrigatórios
| Nome | Tipo | Descrição |
|---|---|---|
| gateway_crendetial | Hash | The gateway credential to create |
Objeto resposta
| School::GatewayCredential | The created gateway credential or a list of errors |
