Embedded Files
Objetivo
Objetivo
Retornar os documentos de um diretório configurado para o sistema de Originação.
Descrição do Serviço
Descrição do Serviço
O sistema deve retornar a lista de documentos contidos no diretório informado pelo parâmetro "DIRETORIO" da requisição. Esse diretório deverá ser configurado no sistema de arquivos do SCCI dentro do diretório "ORIGINACAO". Se o parâmetro não for informado ou for igual a "Obrigatórios", então o serviço irá retornar o conteúdo do diretório "ORIGINAÇÃO/Obrigatórios/" respeitando a seguinte lógica:
Os arquivos que pertencem diretamente ao diretório "Obrigatórios" deverão entrar na lista.
Esse diretório conterá três outros diretórios: FGTS, Seguros, União estável. No diretório Seguros estarão os diretórios relacionados às respectivas Seguradoras, que deverão ser nomeados de acordo com o "CO_SEGURADORA" configurado no sistema, devendo conter em cada diretório a apólice correspondente. Dessa forma, apenas a apólice correspondente a seguradora da Operação informada na requisição através do "NU_PRETENDENTE" deverá ser incluída na lista.
Os documentos contidos nos diretórios FGTS deverão ser apresentados na lista se algum pretendente da operação utilizar o FGTS.
Os documentos contidos no diretório União Estável deverão constar na lista caso algum pretendente possuir União Estável.
Interface do serviço
Interface do serviço
Requisição
Requisição
Método: GET
url: rest/w/woriginacao/documentosOriginacao
Parâmetros:
NU_PRETENDENTE : número da operação/pretendente
DIRETORIO : nome do diretório onde
Resposta
Resposta
Casos de sucesso
Parâmetro "DIRETORIO" não é passado. O serviço retorna a lista de documentos contidos no diretório Originação de acordo com a lógica citada acima.
{
"dados": {
"documentos": [
{
"NU_DOCUMENTO": 123,
"NO_DOCUMENTO": " "
},
{
"NU_DOCUMENTO": 124,
"NO_DOCUMENTO": " "
},
...
]
},
"success": true
}
Parâmetro "DIRETORIO" é passado em branco. O serviço retorna a lista de documentos contidos no diretório Originação de acordo com a lógica citada acima.
{
"dados": {
"documentos": [
{
"NU_DOCUMENTO": 123,
"NO_DOCUMENTO": " "
},
{
"NU_DOCUMENTO": 124,
"NO_DOCUMENTO": " "
},
...
]
},
"success": true
}
Parâmetro "DIRETORIO" é passado com diretório existente e diferente de "Obrigatórios". Por exemplo, "DIRETORIO":"FichaDeAvaliacao", onde "FichaDeAvaliacao" é um diretório válido. Contém a lista de Documentos do diretório FichaDeAvaliacao. Os arquivos existentes em subdiretórios deverão ser incluídos.
{
"dados": {
"documentos": [
{
"NU_DOCUMENTO": 127,
"NO_DOCUMENTO": " "
},
{
"NU_DOCUMENTO": 129,
"NO_DOCUMENTO": " "
},
...
]
},
"success": true
}
Parâmetro DIRETORIO é passado igual a "Obrigatórios"
{
"dados": {
"documentos": [
{
"NU_DOCUMENTO": 123,
"NO_DOCUMENTO": " "
},
{
"NU_DOCUMENTO": 124,
"NO_DOCUMENTO": " "
},
...
]
},
"success": true
}
Caso de falha
DIRETORIO é passado porém o diretório não existe. Retornar a mensagem de erro. Ex.: "DIRETORIO" : "Inexistente"
{
"success" : false,
"message" : "Diretório 'Inexistente' não encontrado"
}
Page updated
Report abuse