Liberar cliente
Libera a un cliente: deja de serlo del distribuidor y conserva sus timbres y sus datos; el distribuidor ya no ve sus documentos. Exige confirm en true; sin él no se hace nada. Devuelve {released: true}. Errores: invalid_input, not_found si no es cliente, invalid_state si su cuenta está cerrada, forbidden.
Alcance (scope): cefidia:write · Características: Destructiva, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
client |
texto | Sí | Id o nombre de uno de los clientes de list_clients. |
confirm |
texto | Sí | Debe ser true: el usuario pidió liberarlo. |
Esquema de entrada (JSON Schema)¶
{
"additionalProperties": false,
"properties": {
"client": {
"description": "Id o nombre de uno de los clientes de list_clients.",
"maxLength": 300,
"title": "Client",
"type": "string"
},
"confirm": {
"const": true,
"description": "Debe ser true: el usuario pidió liberarlo.",
"title": "Confirm",
"type": "boolean"
}
},
"required": [
"client",
"confirm"
],
"title": "ReleaseClientInput",
"type": "object"
}