# Get Role List - DescribeCharacterList

## Overview

Get Role List






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeCharacterList`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.genesissai.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Offset** | int | Offset of the role list, default is 0 |No|
| **Limit** | int | Maximum number of role lists, default is 20 |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **CharacterSet** | array[[*CharacterSet*](#characterset)] | Examples of role lists in JSON format, see each parameter in the following ResponseItem |**Yes**|
| **TotalCount** | int | Total Number of Roles |**Yes**|

#### Data Model


#### CharacterSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **CharacterId** | string | Role ID |**Yes**|
| **CharacterName** | string | Role Name |**Yes**|
| **CharacterDescription** | string | Role Description |**Yes**|
| **Modifiable** | boolean | Modifiability |**Yes**|
| **PermissionSet** | array[[*PermissionSet*](#permissionset)] | Permission List |**Yes**|

#### PermissionSet

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Add** | array[string] | Product list with added permissions |**Yes**|
| **Del** | array[string] | Product list with delete permissions |**Yes**|
| **Mod** | array[string] | Product list with modification permissions |**Yes**|
| **Get** | array[string] | Product list with query permissions |**Yes**|

## Example

### Request Example
    
```
https://api.genesissai.com/?Action=DescribeCharacterList
&Offset=0
&Limit=7
```

### Response Example
    
```json
{
  "Action": "DescribeCharacterListResponse",
  "CharacterSet": [
    {
      "CharacterDescription": "管理员",
      "CharacterId": "Admin",
      "CharacterName": "Admin",
      "Modifiable": false,
      "PermissionSet": {
        "Add": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST",
          "ULB",
          "UMARKET",
          "UMEM",
          "UNET",
          "USEC",
          "UVIDEO",
          "UHADOOP",
          "UKAFKA",
          "UDW",
          "UDSET",
          "UAI",
          "UAI-TRAINING",
          "ULIVE",
          "UDOCKER",
          "UHUB",
          "UWAF",
          "UDDB",
          "UHIDS",
          "DBAUDIT",
          "UK8S",
          "PATHX",
          "UKMS",
          "UES",
          "UFLINK"
        ],
        "Del": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST",
          "ULB",
          "UMARKET",
          "UMEM",
          "UNET",
          "USEC",
          "UVIDEO",
          "UHADOOP",
          "UKAFKA",
          "UDW",
          "UDSET",
          "UAI",
          "UAI-TRAINING",
          "ULIVE",
          "UDOCKER",
          "UHUB",
          "UWAF",
          "UDDB",
          "UHIDS",
          "DBAUDIT",
          "UK8S",
          "PATHX",
          "UKMS",
          "UES",
          "UFLINK"
        ],
        "Get": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST",
          "ULB",
          "UMARKET",
          "UMEM",
          "UNET",
          "USEC",
          "UVIDEO",
          "UHADOOP",
          "UKAFKA",
          "UDW",
          "UDSET",
          "UAI",
          "UAI-TRAINING",
          "ULIVE",
          "UDOCKER",
          "UHUB",
          "UWAF",
          "UDDB",
          "UHIDS",
          "DBAUDIT",
          "UK8S",
          "PATHX",
          "UKMS",
          "UES",
          "UFLINK"
        ],
        "Mod": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST",
          "ULB",
          "UMARKET",
          "UMEM",
          "UNET",
          "USEC",
          "UVIDEO",
          "UHADOOP",
          "UKAFKA",
          "UDW",
          "UDSET",
          "UAI",
          "UAI-TRAINING",
          "ULIVE",
          "UDOCKER",
          "UHUB",
          "UWAF",
          "UDDB",
          "UHIDS",
          "DBAUDIT",
          "UK8S",
          "PATHX",
          "UKMS",
          "UES",
          "UFLINK"
        ]
      }
    },
    {
      "CharacterDescription": "",
      "CharacterId": "lptabl",
      "CharacterName": "test",
      "Modifiable": true,
      "PermissionSet": {
        "Add": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST"
        ],
        "Del": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST"
        ],
        "Get": [
          "HYBRID",
          "PHOST",
          "UCDN",
          "UDB",
          "UDDP",
          "UDISK",
          "UFILE",
          "UHOST"
        ],
        "Mod": null
      }
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}
```