Árvore de páginas

Versões comparadas

Chave

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

...

Bloco de código
languagec#
themeMidnight
titleRetorno dos Opcionais
linenumberstrue
collapsetrue
{
   "id": "DETAILOPC",
   "modeltype": "GRID",
   "optional": 1,
   "struct": [
       {
            "id": "MATRICULA",
            "order": 1
       },
       {
            "id": "RESULT",
            "order": 2
       }
   ],
   "items": [
       {
            "id": 1,
            "deleted": 0,
            "fields": [
                {
                    "id": "MATRICULA",
                    "value": "00010001000152008"
                },
                {
                    "id": "RESULT",
                    "value": "[{\"product\":\"9896\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}},{\"product\":\"9897\",\"version\":\"001\",\"response\":                       					\"success\":true,\"message\":\"\"}}]"
                }
            ]
       },
       {
            "id": 2,
            "deleted": 0,
            "fields": [
                {
                    "id": "MATRICULA",
                    "value": "00010001000152016"
                },
                {
                    "id": "RESULT",
                    "value": "[{\"product\":\"9896\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}},{\"product\":\"9897\",\"version\":\"001\",\"response\":{\"success\":true,\"message\":\"\"}}]"
               }
           ]
       }
    ]
}

...


Pontos de Entrada PLOPCPJ e PLOPCPF

Foram desenvolvidos dois pontos de entrada que permitem definir regras para determinar se um opcional deve ou não ser gravado, em complemento ao parâmetro MV_PLCAROP.

...

Os pontos de entrada recebem como parâmetro (PARAMIXB) um objeto JSON com os seguintes atributos:

AtributoDescrição
beneficiaryRegistrationMatrícula do beneficiário em que o opcional será gravado.
entityType

Tipo de entidade: PJ (Pessoa Jurídica) ou PF (Pessoa Física).

optionalCode

Código do opcional (produto) que está sendo processado no momento.

optionalVersion

Código da versão do opcional (produto) que está sendo processado.


O retorno deve ser um objeto JSON com a seguinte estrutura:

AtributoDescrição
success.T. caso deva gravar o opcional; .F. caso não deva gravar o opcional.
message

No caso de não permitir a gravação, uma mensagem da justificativa pode ser inserida, essa mensagem será visível no response do endpoint.

Bloco de código
languagedelphi
themeMidnight
titleExemplo de Utilização
linenumberstrue
#Include 'Totvs.ch'   

User Function PLOPCPF()
	
	Local oJRet := JsonObject():new()
	
	If paramixm["beneficiaryRegistration"] == "00010001000153004" .AND. ;
	   paramixm["entityType "]	           == "F"                 .AND. ;    
	   paramixm["optionalCode"]	           == "1234"              .AND. ;    
	   paramixm["optionalVersion"]	       == "001" 

		oJRet["success"] := .F.
		oJRet["message"] := "Beneficiário sem opcional"
	Else
		oJRet["success"] := .T.
		oJRet["message"] := ""
	EndIf
	
Return oJRet

04. DEMAIS INFORMAÇÕES

Alteração de dicionário SX3 (X3_VALID):

ArquivoCampoTítuloValidação
BT3BT3_TIPVINVinculado?Pertence("01")

05. 05. ASSUNTOS RELACIONADOS


Para informações detalhadas sobre o funcionamento do endpoint, consulte a documentação oficial disponível no link abaixo:

...