[POST] .../v1/personaldoctype/get
Returns personal document types. Use this method to retrieve personal document types used by customer personal document records and their value mask validation. The request supports filters by ids and returns result with an array of active PersonalDocType records containing id, name, mask and last_update. The method checks the current request user and requires personal document type select permission; missing body, denied permission, invalid filters and storage errors are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| ids | int | Personal document type IDs. |
Request Example
{
"filters": [
{
"Field": "ids",
"Operator": "Equal",
"Value": "string"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of PersonalDocType | Result object. |
Response Example
{
"ok": true,
"result": [
{
"id": 1,
"last_update": 1,
"mask": "string",
"name": "string"
}
]
}