Skip to main content

POST Listar Tipos Anexos

Introdução

Retorna uma lista contendo os documentos que devem/podem ser enviados, de acordo com o produto selecionado.

Rota
/Proposta/tipo-anexos
Authorization
Token eyJ...
Headers Request
Accept application/json
Content-Type application/json

Detalhes da API

Campos obrigatórios e seus respectivos tipos

Campos
Campo Tipo Obrigatório Descrição
propostaId
 string | inteiro Sim É obtido através da rota, [POST] /Proposta
tipoModalidade
 string | inteiro Sim É obtido através da rota, [GET] /Contexto/proposta
tipoRenda
 string | inteiro Não É obtido através da rota, [GET] /Contexto/proposta

Exemplo de Requisição e Resposta

Exemplo de Request
curl 
curl --location 'https://app2-crefaz-api-external-stag.azurewebsites.net/api/Proposta/tipo-anexos' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "propostaId": 1028685798,
  "tipoRenda": 0,
  "tipoModalidade": 2 // SEMPRE ENVIAR 2
}'
Body da Requisição
body 
{
  "propostaId": 1028685798,
  "tipoRenda": 0,
  "tipoModalidade": 2
}
Exemplo de Response
sucesso 
{
  "success": true,
  "data": [
      {
        "id": 1,
        "produtoId": 6,
        "nome": "DOCUMENTO DE IDENTIFICAÇÃO",
        "tipoModalidade": 0,
        "tipoRenda": null,
        "obrigatorio": true
      },
      {
        "id": 48,
        "produtoId": 6,
        "nome": "FATURA DE ENERGIA",
        "tipoModalidade": 0,
        "tipoRenda": null,
        "obrigatorio": true
      },
      {
        "id": 50,
        "produtoId": 6,
        "nome": "OUTROS",
        "tipoModalidade": 0,
        "tipoRenda": null,
        "obrigatorio": false
      }
  ],
  "errors": null
}
erro 
{
  "success": false,
  "data": null,
  "errors": [
    "Proposta inexistente!"
  ]
}
Headers de Response (5)
Type Value
Content-Type

application/json; charset=utf-8
Date Fri, 04 Oct 2024 18:03:20 GMT
Server Kestrel
Transfer-Encoding chunked
Request-Context appId=cid-v1:d0033e30-cc70-4961-9727-b7389fb39348

No Comments
Back to top