Records

Listar Registros do Formulario

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulario

Parâmetros de consulta

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: createdAt

dirstringOpcionalDefault: desc

Respostas

200

Records listed

application/json

currentPageinteger · int32Opcional

perPageinteger · int32Opcional

totalinteger · int64Opcional

404

Form was not found

application/json

422

A query param was invalid

application/json

500

An internal server error was thrown

application/json

get/forms/{formId}/records

GET /api/b2b/forms/{formId}/records HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "currentPage": 1,
  "perPage": 1,
  "total": 1,
  "items": [
    {
      "id": "text",
      "origin_record": "text",
      "data": [
        {
          "id": "text",
          "field_id": "text",
          "field_description": "text",
          "field_type": "text",
          "control": "text",
          "value": {}
        }
      ]
    }
  ]
}

Criar Registro do Formulário

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

Corpo

origin_recordstringOpcional

Respostas

201

Criado

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

404

Form was not found

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/forms/{formId}/records

POST /api/b2b/forms/{formId}/records HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "origin_record": "text",
  "data": [
    {
      "field_id": "text",
      "control": "CEP",
      "value": {}
    }
  ]
}

{
  "id": "text",
  "title": "text",
  "order": 1
}