Listar estados

Los estados se pueden listar a partir de un form group (conjunto de versiones de un formulario) o del id de un formulario. Para ello enviar la query correspondiente en la petición de tipo GET.

GET https://api.persat.com.ar/v1/digital-forms-states

Siempre se debe enviar form_id o form_group.

Query Parameters

Name

Type

Description

form_id

Number

Identificador del formulario

form_group

Number

Identificador del grupo de formulario

without_deleted

Boolean

Si se deben excluir los estados eliminados. Por defecto es false

Headers

Name

Type

Description

Authorization*

String

Bearer API_KEY

{
    "success": true,
    "data": {
        "form_group": 14,
        "states": [
            {
                "color": "ORANGE",
                "deleted": false,
                "id": 14,
                "name": "A revisar"
            },
            {
                "color": "BLUE",
                "deleted": false,
                "id": 26,
                "name": "Listo"
            },
            {
                "color": "RED",
                "deleted": false,
                "id": 27,
                "name": "Cancelado"
            },
            {
                "color": "GREEN",
                "deleted": false,
                "id": 28,
                "name": "Aprobado"
            }
        ]
    }
}

{
    "success": true,
    "data": {
        "form_group": 14,
        "states": [
            {
                "color": "ORANGE",
                "deleted": false,
                "id": 14,
                "name": "A revisar"
            },
            {
                "color": "BLUE",
                "deleted": false,
                "id": 26,
                "name": "Listo"
            },
            {
                "color": "RED",
                "deleted": false,
                "id": 27,
                "name": "Cancelado"
            },
            {
                "color": "GREEN",
                "deleted": false,
                "id": 28,
                "name": "Aprobado"
            }
            {
                "color": "LIGHT_BLUE",
                "deleted": true,
                "id": 29,
                "name": "Aprobado y facturado"
            }
        ]
    }
}

{
    "success": false,
    "error": {
        "status": 404,
        "type": "NOT_FOUND",
        "userMessage": "No hay un formulario con id: 123123"
    }
}

{
    "success": false,
    "error": {
        "status": 404,
        "type": "NOT_FOUND",
        "userMessage": "No existe el form_group: 1923"
    }
}

{
    "success": false,
    "error": {
        "status": 400,
        "type": "BAD_REQUEST",
        "userMessage": "Es necesario que haya form_id o form_group"
    }
}

Analizando la Respuesta

form_group: es un número. Identificador del grupo de formulario(conjunto de versiones de un formulario).

Last updated 3 months ago

{ "success": true, "data": { "form_group": 14, "states": [ { "color": "ORANGE", "deleted": false, "id": 14, "name": "A revisar" }, { "color": "BLUE", "deleted": false, "id": 26, "name": "Listo" }, { "color": "RED", "deleted": false, "id": 27, "name": "Cancelado" }, { "color": "GREEN", "deleted": false, "id": 28, "name": "Aprobado" } ] } }