Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Algumas regras na API poderão ser adicionadas pelo Layout genérico Web, o mesmo deverá ser adicionada no MV_PLLAYIN. Por exemplo: MV_PLLAYIN = PPLINCBEN, a api irá utilizar as configurações contidas nessa layout genérico.

...

Parâmetro

Obrigatório

Tipo

Descrição

pkNãoCaracterValor da chave primaria do alias do modelo em encodado em base64, esse valor será obtido ao consulta consultar todos os protocolos.

Exemplo

...

Url

Método

Header Content-Type

Descrição

https://<url>:<porta>/rest/fwmodel/PLIncBenModel/[pk]

PUTapplication/jsonRealiza a alteração de um protocolo de inclusão já existente na analise de beneficiários. (Somente os protocolos que não foram analisados ou finalizados poderão ser excluídosalterados).

Parâmetro <PK> obtido através dos métodos POST ou GET.

...

O JSON de envio do PUT é o mesmo realizado no POST, o que irá mudar é o atributo operation com o valor e o valor dos campos que irá irão ser alteradoalterados.

O retorno da API será o mesmo do POST. Caso realizado a alteração com sucesso, será retornado o protocolo como se tivesse realizado um GET com a pk correspondente ao protocolo. Caso ocorra alguma validação será apresentada a critica. 

...

Url

Método

Header Content-Type

Descrição

https://<url>:<porta>/rest/fwmodel/PLIncBenModel/[pk]

DELETEapplication/jsonRealiza a deleção exclusão de um protocolo já existente na analise de beneficiários. (Somente os protocolos que não foram analisados ou finalizados poderão ser excluídos).

...