Atualizar Situação de Histórico de Setor

PUT 
/historicoSetores/atualizarSituacao

Envie data como uma lista não vazia de registros. Use situacao=2 para integrado ou situacao=3 para erro. Para situacao=3, observacao deve estar preenchida. Verifique updated em cada item: success=true no resultado geral não significa que todos os itens foram atualizados. total é a quantidade de itens processados. Se observacao for omitida, seu valor será apagado. Se a integração por empresa da folha estiver habilitada, informe codEmpresa na query.

Request

Query Parameters

application/json

Body

Body

required

data

object[]

required

Possible values: >= 1

Array [

seqRegistro int64required

]

integrado

Exemplo de resultado

{
  "data": [
    {
      "seqRegistro": 12345,
      "situacao": "2"
    }
  ]
}

erro

Exemplo de resultado

{
  "data": [
    {
      "seqRegistro": 12345,
      "situacao": "3",
      "observacao": "Erro ao processar registro"
    }
  ]
}

Responses

200

Resultado da atualização; verifique updated em cada item.

application/json

Schema

Schema

anyOf

AtualizacaoSituacaoLoteResponse

success boolean

total integer

data

object[]

Array [

updated boolean

seqRegistro int64

situacao string

observacao stringnullable

cause stringnullable

errors

object[]

nullable

Array [

cause string

]

]

AtualizacaoSemDadosResponse

message stringrequired

Example (from schema)

{}

sucesso

Exemplo de resultado

{
  "success": true,
  "total": 1,
  "data": [
    {
      "updated": true,
      "seqRegistro": 12345,
      "situacao": "2",
      "observacao": null
    }
  ]
}

registroAusente

Exemplo de resultado

{
  "success": true,
  "total": 1,
  "data": [
    {
      "updated": false,
      "seqRegistro": 12345,
      "cause": "Registro não encontrado."
    }
  ]
}

erroSemObservacao

Exemplo de resultado

{
  "success": true,
  "total": 1,
  "data": [
    {
      "updated": false,
      "seqRegistro": 12345,
      "cause": "Observação deve ser informada ao atualizar situação para status de erro."
    }
  ]
}

semDados

Exemplo de resultado

{
  "success": false,
  "message": "Parâmetros inválidos."
}

400

Empresa ausente ou inválida quando a integração por empresa da folha estiver habilitada.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

empresaAusente

Exemplo de resultado

{
  "message": "Operação Negada. Parâmetro codEmpresa ausente na requisição."
}

Loading...