Administration Service: /roles

/roles

PUT https://api.abitmedia.app/administration/v1/roles

Actualización de rol

Autorizaciones

bearer: {accessToken}

Parámetros de ruta / Parámetros de consulta

Parámetros	Tipo	Requerido	Descripción
id	integer	Si	Identificador del recurso

Parámetros Formdata / Atributos objeto JSON

Parametros	Tipo	Requerido	Descripción
companyId	integer	No	Id de compañía para roles a medida
name	string	Si	Nombre del rol
permissions	object	Si	Objeto en el cual se especifica el módulo con las acciones correspondientes del mismo
status	smallint	No	0:inactivo 1:activo 2:eliminado. Por defecto 1

Ejemplos de código

JavaScript PHP Rails

var xmlHttp = new XMLHttpRequest();
xmlHttp.open("PUT", "https://api.abitmedia.app/administration/v1/roles", false);

// Make sure you set the appropriate headers
xmlHttp.setRequestHeader("Header Key", "Header Value");

var data = "# body is your JSON/ XML/ Text/ Form Query/ etc"
xmlHttp.send(data);

var response = xmlHttp.responseText;

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.abitmedia.app/administration/v1/roles");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 

// Make sure you set the nessary headers as a $headers array
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "put")
$body = '';
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

uri = URI.parse("https://api.abitmedia.app/administration/v1/roles")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Put.new(uri.request_uri)

# Make sure you set the appropriate headers
request["header"] = "header value"

# body is your JSON/ XML/ Text/ Form Query/ etc
request.set_form_data(body)

response = http.request(request)

Respuesta

200:

application/json

{
  "success": true,
  "status": 200,
  "message": "Recurso creado exitosamente",
  "data": {
    "id": 1,
    "companyId": 1,
    "name": "Cajero",
    "permissions": [
      {
        "moduleId": 1,
        "actions": {1, 2, 3, 4}
      }
    ],
    "status": 1,
    "createdAt": "2024-01-01 17:50:01",
    "updateAt": "2024-01-01 17:50:01"
  }
}

422:

application/json

{
  "success": false,
  "status": 422,
  "message": "Se encontró errores de validación en el recurso enviado",
  "data": [
      {
          "field": "attributo",
          "message": "mensaje de error"
      }
  ]
}

Otras acciones de endpoint

GET POST DELETE