← HomeFleetPay / Schema

RevisarDemandaSolicitacaoTransporteRequest

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

demand_revision_modestringOptional

complement adds deliveries/vacancies; total_revision replaces the window's planned total without silently cancelling active acceptances; incorporate_into_work_unit incorporates deliveries into the same day-rate/shift without generating duplicate day-rate.

"complement" · "total_revision" · "incorporate_into_work_unit"
expected_demand_versioninteger | nullOptional

Expected current version of the demand schedule for concurrency control (409 DEMAND_VERSION_CONFLICT if mismatched).

demand_schedule_typestring | nullOptional
"variable" · "fixed_scheduled" · "mixed" · null
operational_base_codestring | nullOptional
window_shift_codestring | nullOptional
deliveries_countinteger | nullOptional
minimum0
required_vacancies_countinteger | nullOptional
minimum0
deliveries_per_driver_ruleinteger | nullOptional

Explicit conversion rule from delivery count to vacancies/drivers when required_vacancies_count is not provided directly.

minimum1
work_unit_keystring | nullOptional
Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "properties": {
    "demand_revision_mode": {
      "type": "string",
      "enum": [
        "complement",
        "total_revision",
        "incorporate_into_work_unit"
      ],
      "default": "total_revision",
      "description": "`complement` soma entregas/vagas; `total_revision` substitui o total planejado da janela sem cancelar silenciosamente aceites ativos; `incorporate_into_work_unit` incorpora entregas na mesma diária/turno sem gerar diária duplicada."
    },
    "expected_demand_version": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Versão atual esperada da programação de demanda para controle de concorrência (`409 DEMAND_VERSION_CONFLICT` se divergir)."
    },
    "demand_schedule_type": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "variable",
        "fixed_scheduled",
        "mixed",
        null
      ]
    },
    "operational_base_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "window_shift_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "deliveries_count": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "required_vacancies_count": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "deliveries_per_driver_rule": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 1,
      "description": "Regra explícita de conversão de quantidade de entregas em vagas/motoristas quando `required_vacancies_count` não é informado diretamente."
    },
    "work_unit_key": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}