Períodos

Request

Payload

{warning} Payload

É necessário seguir a hierarquia exibido no exemplo abaixo.

{
  "period_fields": {
    "initial_date": "2021-01-01",
    "final_date": "2021-01-31",
    "syntax_date": "last_month",
    "timezone": -3
  }
}

Attributes

initial_date: '2021-01-01' (date_format:Y-m-d) - "Data inicial" 
final_date: '2021-01-31' (date_format:Y-m-d) - "Data final" 
syntax_date: 'last_month' (string) - "Data relativo ao dia atual"  
timezone: -3 (required, int) - "Número do timezone"

initial_date: É requerido quando o campo syntax_date for vazio.

final_date: É requerido quando o campo initial_date for vazio.

syntax_date: É requerido quando o campo initial_date for vazio. O campo terá que conter apenas uma dessas chaves de valores:

  • now
  • today
  • yesterday
  • tomorrow
  • last_week
  • this_week
  • last_month
  • this_month
  • last_year
  • this_year

Resource

{
  "period_fields": {
    "label": "Período",
    "name": "period_fields",
    "fields": [
      {
        "label": "Data de início",
        "type": "date",
        "name": "initial_date",
        "value": null,
        "options": null
      },
      {
        "label": "Data de término",
        "type": "date",
        "name": "final_date",
        "value": null,
        "options": null
      },
      {
        "label": "Período relativo",
        "type": "select",
        "name": "syntax_date",
        "value": null,
        "options": {
          "Agora": "now",
          "Hoje": "today",
          "Ontem": "yesterday",
          "Amanhã": "tomorrow",
          "Semana Passada": "last_week",
          "Semana atual": "this_week",
          "Mês Passado": "last_month",
          "Mês atual": "this_month"
        }
      },
      {
        "label": "Timezone",
        "type": "select",
        "name": "timezone",
        "value": -3,
        "options": {
          "GMT -5": -5,
          "GMT -4": -4,
          "GMT -3": -3,
          "GMT -2": -2,
          "GMT -1": -1,
          "GMT +0": 0
        }
      }
    ]
  }
}

Validation

{warning} Response 422 (application/json)

{
  "period_fields.initial_date": [
    "O campo data inicial é obrigatório quando Data relativo não está presente."
  ],
  "period_fields.final_date": [
    "O campo data final é obrigatório quando Data inicial está presente."
  ],
  "period_fields.syntax_date": [
    "O campo data inicial relativo é obrigatório quando Data inicial não está presente."
  ],
  "period_fields.timezone": [
    "O campo fuso horário é obrigatório."
  ]
}