Create

PUT /V1/company/role/{id}

Create or update a role for a selected company.

Path parameters

id string Required

Body

role object Required

Role data transfer object interface.
Hide role attributes Show role attributes object
- id integer
  
  Role id.
- role_name string
  
  Role name.
- permissions array[object] Required
  
  Permission interface.
  Hide permissions attributes Show permissions attributes object
  
  Permission interface.
  
  id integer
  
  Id.
  
  role_id integer
  
  Role id.
  
  resource_id string Required
  
  Resource id.
  
  permission string Required
  
  Permission.
- company_id integer
  
  Company id.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Company\Api\Data\RoleInterface

Responses

200

200 Success.
Hide response attributes Show response attributes object
Role data transfer object interface.
- id integer
  
  Role id.
- role_name string
  
  Role name.
- permissions array[object] Required
  
  Permission interface.
  
  Hide permissions attributes Show permissions attributes object
  
  Permission interface.
  
  id integer
  
  Id.
  
  role_id integer
  
  Role id.
  
  resource_id string Required
  
  Resource id.
  
  permission string Required
  
  Permission.
- company_id integer
  
  Company id.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Company\Api\Data\RoleInterface
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

PUT /V1/company/role/{id}

curl \
 -X PUT https://magento2.winkelstraat.mac/rest/all/V1/company/role/{id} \
 -d '{"role":{"id":42,"role_name":"string","permissions":[{"id":42,"role_id":42,"resource_id":"string","permission":"string"}],"company_id":42,"extension_attributes":{}}}'

Request examples

{
  "role": {
    "id": 42,
    "role_name": "string",
    "permissions": [
      {
        "id": 42,
        "role_id": 42,
        "resource_id": "string",
        "permission": "string"
      }
    ],
    "company_id": 42,
    "extension_attributes": {}
  }
}

Response examples (200)

{
  "id": 42,
  "role_name": "string",
  "permissions": [
    {
      "id": 42,
      "role_id": 42,
      "resource_id": "string",
      "permission": "string"
    }
  ],
  "company_id": 42,
  "extension_attributes": {}
}

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}