Radius Web-API API documentation version 1
https://radius.av2/api
/login
Login System
post /login
Login System
Body
Media type: application/json
Type: object
Properties- username: required (string)
- password: required (string)
HTTP status code 000
Success Login, token is field message
Body
Media type: application/json
Type: object
Properties- code: required (string)
- message: required (string)
HTTP status code 001
Incorrect User or Password
Body
Media type: application/json
Type: object
Properties- code: required (string)
- message: required (string)
/plan
Retrieve resources plan
Create a new resource plan
get /plan
Retrieve resources plan
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Plan
- id: required (string)
- code: required (string)
- name: required (string)
- description: required (string)
- duration: required (number)
- speed_up: required (number)
- speed_down: required (number)
- download_limit_id: required (number)
- valid_since: required (number)
- valid_to: required (number)
- allow_recharges: required (number)
- id_delected: required (number)
Example:
{ "id": 4, "code": "DEMO01", "name": "Plan Peru", "description": "Test de plan", "duration": 1234121, "speed_up": 1, "speed_down": 2, "download_limit": 1, "valid_since": 1525712400000, "valid_to": 1527526800000, "allow_recharges": 1, "id_delected": 0 }
Example:
{
"count": 8,
"list": "Plan[]"
}post /plan
Create a new resource plan
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- name: required (string)
- description: required (string)
- duration: required (number)
- speed_up: required (number)
- speed_down: required (number)
- download_limit_id: required (number)
- valid_since: required (number)
- valid_to: required (number)
- allow_recharges: required (number)
- id_delected: required (number)
Example:
{
"id": 4,
"code": "DEMO01",
"name": "Plan Peru",
"description": "Test de plan",
"duration": 1234121,
"speed_up": 1,
"speed_down": 2,
"download_limit": 1,
"valid_since": 1525712400000,
"valid_to": 1527526800000,
"allow_recharges": 1,
"id_delected": 0
}HTTP status code 201
Succesfully created a new resource plan
Retrieve Filters to Plan
Add or Remove Filter to Plan, if there is a instance plan_filter then remove instance else add new instance
get /plan/{id}/filter
Retrieve Filters to Plan
URI Parameters
- id: required (string)
HTTP status code 200
Succesfully retrieved Filter
Body
Media type: application/json
Type: array of object
Items: PlanToFilter
- id: required (number)
- plans_id: required (number)
- filters_id: required (number)
post /plan/{id}/filter
Add or Remove Filter to Plan, if there is a instance plan_filter then remove instance else add new instance
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- filter: required (number)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- code: required (string)
- message: required (string)
Example:
{
"code": 200,
"message": "Filtro eliminado | Filtro agregado"
}Retrieve resources by filters
post /plan/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"code": "DEMO01",
"name": "Plan Peru",
"description": "Test de plan",
"duration": 1234121,
"speed_up": {
"id": 1
},
"speed_down": {
"id": 1
},
"download_limits": {
"id": "number"
},
"date_since": 1525712400000,
"date_to": 1527526800000,
"allow_recharges": {
"code": "ALL"
}
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Plan
- id: required (string)
- code: required (string)
- name: required (string)
- description: required (string)
- duration: required (number)
- speed_up: required (number)
- speed_down: required (number)
- download_limit_id: required (number)
- valid_since: required (number)
- valid_to: required (number)
- allow_recharges: required (number)
- id_delected: required (number)
Example:
{ "id": 4, "code": "DEMO01", "name": "Plan Peru", "description": "Test de plan", "duration": 1234121, "speed_up": 1, "speed_down": 2, "download_limit": 1, "valid_since": 1525712400000, "valid_to": 1527526800000, "allow_recharges": 1, "id_delected": 0 }
Example:
{
"count": 4,
"list": "Plan[]"
}Update an existing resource plan
Delete resource plan
put /plan/{id}
Update an existing resource plan
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- name: required (string)
- description: required (string)
- duration: required (number)
- speed_up: required (number)
- speed_down: required (number)
- download_limit_id: required (number)
- valid_since: required (number)
- valid_to: required (number)
- allow_recharges: required (number)
- id_delected: required (number)
Example:
{
"id": 4,
"code": "DEMO01",
"name": "Plan Peru",
"description": "Test de plan",
"duration": 1234121,
"speed_up": 1,
"speed_down": 2,
"download_limit": 1,
"valid_since": 1525712400000,
"valid_to": 1527526800000,
"allow_recharges": 1,
"id_delected": 0
}HTTP status code 204
Succesfully updated the resource plan
delete /plan/{id}
/master_account
Retrieve resources master_account
Create a new resource master_account
get /master_account
Retrieve resources master_account
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: MasterAccount
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- mac: required (string)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_type: required (one of 1, 2)
Example:
{ "ciu": 111, "type_ciu": "RUC", "mac": "B870F42B0012", "first_name": "Test", "last_name": null, "phone": 45185926645, "email": "mohts@sdf.lo", "account_type": 1 }
Example:
{
"count": 8,
"list": "MasterAccount[]"
}post /master_account
Create a new resource master_account
Body
Media type: application/json
Type: object
Properties- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- mac: required (string)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_type: required (one of 1, 2)
Example:
{
"ciu": 111,
"type_ciu": "RUC",
"mac": "B870F42B0012",
"first_name": "Test",
"last_name": null,
"phone": 45185926645,
"email": "mohts@sdf.lo",
"account_type": 1
}HTTP status code 201
Succesfully created a new resource master_account
Retrieve resources by filters
post /master_account/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"ciu": 111,
"type_ciu": "RUC",
"mac": "B870F42B0012",
"first_name": "Test",
"last_name": null,
"phone": 45185926645,
"email": "mohts@sdf.lo",
"account_type": 1
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: MasterAccount
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- mac: required (string)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_type: required (one of 1, 2)
Example:
{ "ciu": 111, "type_ciu": "RUC", "mac": "B870F42B0012", "first_name": "Test", "last_name": null, "phone": 45185926645, "email": "mohts@sdf.lo", "account_type": 1 }
Example:
{
"count": 4,
"list": "MasterAccount[]"
}Update an existing resource master_account
Delete resource master_account
put /master_account/{id}
Update an existing resource master_account
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- mac: required (string)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_type: required (one of 1, 2)
Example:
{
"ciu": 111,
"type_ciu": "RUC",
"mac": "B870F42B0012",
"first_name": "Test",
"last_name": null,
"phone": 45185926645,
"email": "mohts@sdf.lo",
"account_type": 1
}HTTP status code 204
Succesfully updated the resource master_account
delete /master_account/{id}
Delete resource master_account
/subscriber
Retrieve resources subscriber
Create a new resource subscriber
get /subscriber
Retrieve resources subscriber
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Subscriber
- id: required (number)
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_types_id: required (number)
Example:
{ "id": 4, "ciu": 47179115, "type_ciu": "DNI", "first_name": "erick", "last_name": "molina", "phone": 991621274, "email": "mohts@sdf.lo", "account_types_id": 1 }
Example:
{
"count": 8,
"list": "Subscriber[]"
}post /subscriber
Create a new resource subscriber
Body
Media type: application/json
Type: object
Properties- id: required (number)
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_types_id: required (number)
Example:
{
"id": 4,
"ciu": 47179115,
"type_ciu": "DNI",
"first_name": "erick",
"last_name": "molina",
"phone": 991621274,
"email": "mohts@sdf.lo",
"account_types_id": 1
}HTTP status code 201
Succesfully created a new resource subscriber
Retrieve resources by filters
post /subscriber/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"ciu": 4717,
"first_name": "er",
"email": "mohts"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Subscriber
- id: required (number)
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_types_id: required (number)
Example:
{ "id": 4, "ciu": 47179115, "type_ciu": "DNI", "first_name": "erick", "last_name": "molina", "phone": 991621274, "email": "mohts@sdf.lo", "account_types_id": 1 }
Example:
{
"count": 4,
"list": "Subscriber[]"
}Update an existing resource subscriber
Delete resource subscriber
put /subscriber/{id}
Update an existing resource subscriber
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (number)
- ciu: required (string)
- type_ciu: required (one of RUC, DNI)
- first_name: required (string)
- last_name: required (string)
- phone: required (string)
- email: required (string)
- account_types_id: required (number)
Example:
{
"id": 4,
"ciu": 47179115,
"type_ciu": "DNI",
"first_name": "erick",
"last_name": "molina",
"phone": 991621274,
"email": "mohts@sdf.lo",
"account_types_id": 1
}HTTP status code 204
Succesfully updated the resource subscriber
delete /subscriber/{id}
Delete resource subscriber
/recharge
Retrieve resources recharge
Create a new resource recharge
get /recharge
Retrieve resources recharge
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of )
Example:
{
"count": 8,
"list": "RechargeAccount[]"
}post /recharge
Retrieve resources by filters
post /recharge/all
Retrieve resources by filters
Body
Media type: application/json
Type: RechargeAccountSearchModel
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of )
Example:
{
"count": 4,
"list": "RechargeAccount[]"
}Update an existing resource recharge
Delete resource recharge
put /recharge/{id}
Update an existing resource recharge
delete /recharge/{id}
Delete resource recharge
/filter
Retrieve resources filter
Create a new resource filter
get /filter
Retrieve resources filter
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Filter
- id: required (string)
- name: required (string)
Example:
{ "id": 4, "name": "Streaming" }
Example:
{
"count": 8,
"list": "Filter[]"
}post /filter
Create a new resource filter
Retrieve Combinations of Filters
Add or Remove Combination to Filter, if there is a instance Combination with filter and type_filter then remove instance else add new instance
get /filter/{id}/combinations
Retrieve Combinations of Filters
URI Parameters
- id: required (string)
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- combination: required (array of object)
Items: Combination
- id: required (number)
- filters_id: required (number)
- filter_types_id: required (number)
- filter_type: required (string)
Example:
{ "id": 7, "filter_id": 6, "filter_type_id": 4, "filter_type_name": "VIDEO" } - filter_types: required (array of object)
Items: FilterType
- id: required (string)
- name: required (string)
- is_active: required (boolean)
Example:
{ "id": 4, "name": "VIDEO", "is_active": 1 }
post /filter/{id}/combinations
Add or Remove Combination to Filter, if there is a instance Combination with filter and type_filter then remove instance else add new instance
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- filter_type_id: required (number)
HTTP status code 200
Body
Media type: application/json
Type: object
Properties- code: required (string)
- message: required (string)
Example:
{
"code": 200,
"message": "Combinación eliminada | Combinación agregada | El tipo de filtro no existe"
}Retrieve resources by filters
post /filter/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"name": "Streaming"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Filter
- id: required (string)
- name: required (string)
Example:
{ "id": 4, "name": "Streaming" }
Example:
{
"count": 4,
"list": "Filter[]"
}Update an existing resource filter
Delete resource filter
put /filter/{id}
Update an existing resource filter
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
Example:
{
"id": 4,
"name": "Streaming"
}HTTP status code 204
Succesfully updated the resource filter
delete /filter/{id}
/filter_type
Retrieve resources filter_type
Create a new resource filter_type
get /filter_type
Retrieve resources filter_type
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: FilterType
- id: required (string)
- name: required (string)
- is_active: required (boolean)
Example:
{ "id": 4, "name": "VIDEO", "is_active": 1 }
Example:
{
"count": 8,
"list": "FilterType[]"
}post /filter_type
Create a new resource filter_type
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- is_active: required (boolean)
Example:
{
"id": 4,
"name": "VIDEO",
"is_active": 1
}HTTP status code 201
Succesfully created a new resource filter_type
Retrieve resources by filters
post /filter_type/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"name": "VIDEO"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: FilterType
- id: required (string)
- name: required (string)
- is_active: required (boolean)
Example:
{ "id": 4, "name": "VIDEO", "is_active": 1 }
Example:
{
"count": 4,
"list": "FilterType[]"
}Update an existing resource filter_type
Delete resource filter_type
put /filter_type/{id}
Update an existing resource filter_type
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- is_active: required (boolean)
Example:
{
"id": 4,
"name": "VIDEO",
"is_active": 1
}HTTP status code 204
Succesfully updated the resource filter_type
delete /filter_type/{id}
Delete resource filter_type
/account_type
Retrieve resources account_type
Create a new resource account_type
get /account_type
Retrieve resources account_type
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: AccountType
- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
10
Example:
{
"count": 8,
"list": "AccountType[]"
}post /account_type
Create a new resource account_type
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
10HTTP status code 201
Succesfully created a new resource account_type
Retrieve resources by filters
post /account_type/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"code": "Mbps",
"value": "10"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: AccountType
- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
10
Example:
{
"count": 4,
"list": "AccountType[]"
}Update an existing resource account_type
Delete resource account_type
put /account_type/{id}
Update an existing resource account_type
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
10HTTP status code 204
Succesfully updated the resource account_type
delete /account_type/{id}
Delete resource account_type
/speed
Retrieve resources speed
Create a new resource speed
get /speed
Retrieve resources speed
Retrieve resources by filters
post /speed/all
Retrieve resources by filters
Body
Media type: application/json
Type: SpeedSearchModel
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of )
Example:
{
"count": 4,
"list": "Speed[]"
}Update an existing resource speed
Delete resource speed
put /speed/{id}
Update an existing resource speed
delete /speed/{id}
/download_limit
Retrieve resources download_limit
Create a new resource download_limit
get /download_limit
Retrieve resources download_limit
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: DownloadLimit
- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
3
Example:
{
"count": 8,
"list": "DownloadLimit[]"
}post /download_limit
Create a new resource download_limit
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
3HTTP status code 201
Succesfully created a new resource download_limit
Retrieve resources by filters
post /download_limit/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"code": "Gb",
"value": "3"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: DownloadLimit
- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
3
Example:
{
"count": 4,
"list": "DownloadLimit[]"
}Update an existing resource download_limit
Delete resource download_limit
put /download_limit/{id}
Update an existing resource download_limit
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- code: required (string)
- value: required (number)
- is_active: required (boolean)
Example:
3HTTP status code 204
Succesfully updated the resource download_limit
delete /download_limit/{id}
Delete resource download_limit
/brand
Retrieve resources brand
Create a new resource brand
get /brand
Retrieve resources brand
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Brand
- id: required (string)
- name: required (string)
- is_deleted: required (boolean)
Example:
{ "id": 4, "name": "HUAWEI", "is_deleted": 0 }
Example:
{
"count": 8,
"list": "Brand[]"
}post /brand
Create a new resource brand
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- is_deleted: required (boolean)
Example:
{
"id": 4,
"name": "HUAWEI",
"is_deleted": 0
}HTTP status code 201
Succesfully created a new resource brand
Retrieve resources by filters
post /brand/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"name": "HUAWEI"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Brand
- id: required (string)
- name: required (string)
- is_deleted: required (boolean)
Example:
{ "id": 4, "name": "HUAWEI", "is_deleted": 0 }
Example:
{
"count": 4,
"list": "Brand[]"
}Update an existing resource brand
Delete resource brand
put /brand/{id}
Update an existing resource brand
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- is_deleted: required (boolean)
Example:
{
"id": 4,
"name": "HUAWEI",
"is_deleted": 0
}HTTP status code 204
Succesfully updated the resource brand
delete /brand/{id}
/model
Retrieve resources model
Create a new resource model
get /model
Retrieve resources model
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Model
- id: required (string)
- name: required (string)
- equation: required (string)
- brands_id: required (number)
- is_deleted: required (boolean)
Example:
{ "id": 4, "name": "RG2804WT", "equation": "MAC +1", "brands_id": 1, "is_deleted": 0 }
Example:
{
"count": 8,
"list": "Model[]"
}post /model
Create a new resource model
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- equation: required (string)
- brands_id: required (number)
- is_deleted: required (boolean)
Example:
{
"id": 4,
"name": "RG2804WT",
"equation": "MAC +1",
"brands_id": 1,
"is_deleted": 0
}HTTP status code 201
Succesfully created a new resource model
Retrieve resources by filters
post /model/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"name": "brands_id"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Model
- id: required (string)
- name: required (string)
- equation: required (string)
- brands_id: required (number)
- is_deleted: required (boolean)
Example:
{ "id": 4, "name": "RG2804WT", "equation": "MAC +1", "brands_id": 1, "is_deleted": 0 }
Example:
{
"count": 4,
"list": "Model[]"
}Update an existing resource model
Delete resource model
put /model/{id}
Update an existing resource model
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- equation: required (string)
- brands_id: required (number)
- is_deleted: required (boolean)
Example:
{
"id": 4,
"name": "RG2804WT",
"equation": "MAC +1",
"brands_id": 1,
"is_deleted": 0
}HTTP status code 204
Succesfully updated the resource model
delete /model/{id}
/user
Retrieve resources user
Create a new resource user
get /user
Retrieve resources user
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: User
- id: required (string)
- username: required (string)
- roles: required (object)
Example:
{ "id": 4, "username": "orange", "roles": [ "ROLE_OPERARIO" ] }
Example:
{
"count": 8,
"list": "User[]"
}post /user
Create a new resource user
Body
Media type: application/json
Type: object
Properties- id: required (string)
- username: required (string)
- roles: required (object)
Example:
{
"id": 4,
"username": "orange",
"roles": [
"ROLE_OPERARIO"
]
}HTTP status code 201
Succesfully created a new resource user
Retrieve resources by filters
post /user/all
Retrieve resources by filters
Body
Media type: application/json
Type: object
Properties- page: required (number)
- rows: required (number)
- search: required (object)
Example:
{
"page": 1,
"rows": 50,
"search": {
"name": "ope"
}
}HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: User
- id: required (string)
- username: required (string)
- roles: required (object)
Example:
{ "id": 4, "username": "orange", "roles": [ "ROLE_OPERARIO" ] }
Example:
{
"count": 4,
"list": "User[]"
}Update an existing resource user
Delete resource user
put /user/{id}
Update an existing resource user
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- username: required (string)
- roles: required (object)
Example:
{
"id": 4,
"username": "orange",
"roles": [
"ROLE_OPERARIO"
]
}HTTP status code 204
Succesfully updated the resource user
delete /user/{id}
/profile
Retrieve resources profile
Create a new resource profile
get /profile
Retrieve resources profile
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Profile
- id: required (string)
- name: required (string)
- description: required (string)
- menus: required (object)
Example:
{ "id": 4, "name": "ROLE_OPERARIO", "menus": [ { "id": 4, "name": "Planes", "icon": "dash", "menus_id": 1, "alias": "app_plan_list", "description": "Planes", "is_leaf": "f", "orden": 1 } ] }
Example:
{
"count": 8,
"list": "Profile[]"
}post /profile
Create a new resource profile
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- description: required (string)
- menus: required (object)
Example:
{
"id": 4,
"name": "ROLE_OPERARIO",
"menus": [
{
"id": 4,
"name": "Planes",
"icon": "dash",
"menus_id": 1,
"alias": "app_plan_list",
"description": "Planes",
"is_leaf": "f",
"orden": 1
}
]
}HTTP status code 201
Succesfully created a new resource profile
Retrieve resources by filters
post /profile/all
Retrieve resources by filters
Body
Media type: application/json
Type: ProfileSearchModel
HTTP status code 200
Succesfully retrieved resources
Body
Media type: application/json
Type: object
Properties- count: required (string)
- list: required (array of object)
Items: Profile
- id: required (string)
- name: required (string)
- description: required (string)
- menus: required (object)
Example:
{ "id": 4, "name": "ROLE_OPERARIO", "menus": [ { "id": 4, "name": "Planes", "icon": "dash", "menus_id": 1, "alias": "app_plan_list", "description": "Planes", "is_leaf": "f", "orden": 1 } ] }
Example:
{
"count": 4,
"list": "Profile[]"
}Update an existing resource profile
Delete resource profile
put /profile/{id}
Update an existing resource profile
URI Parameters
- id: required (string)
Body
Media type: application/json
Type: object
Properties- id: required (string)
- name: required (string)
- description: required (string)
- menus: required (object)
Example:
{
"id": 4,
"name": "ROLE_OPERARIO",
"menus": [
{
"id": 4,
"name": "Planes",
"icon": "dash",
"menus_id": 1,
"alias": "app_plan_list",
"description": "Planes",
"is_leaf": "f",
"orden": 1
}
]
}HTTP status code 204
Succesfully updated the resource profile
delete /profile/{id}
Delete resource profile