Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

O objeto Participante do contrato (snap_mall__participante_contrato__c) contém todas as informações de cadastro do participante do contrato.

Para criação de um Participante do contrato se faz necessário previamente possuir cadastrado na base : Contrato, Contato e Conta

Campos de Participante do contrato

Rótulo do campoNome de APITipo de dadosObrigatórioDescrição
Contasnap_mall__conta__cPesquisa(Conta)XID da conta cadastrado no objeto conta
Contatosnap_mall__contato__cPesquisa(Contato)XID do contato cadastrado no objeto contato
Contratosnap_mall__contrato__cDetalhes do mestre(Contrato)XID do contrato cadastrado no objeto contrato
Criado porCreatedByIdPesquisa(Usuário)XPreenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração
Papelsnap_mall__papel__cLista de opçõesX

Lista de papeis do participante no contrato

Opções disponíveis

  • Representante da empresa
  • Pessoa fisica
  • Fiador
Participante do contratoNameNumeração automáticaX
Preenchimento automático na inclusão de uma participante do contrato
Última modificação feita porLastModifiedByIdPesquisa(Usuário)XInformação do usuário de sistema que realizou a ultima modificação ou usuário da integração


Criar Participante do contrato:

                Método : POST

                URI: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__participante_contrato__c/

                Descrição: Método de criação de um Participante do contrato(snap_mall__participante_contrato__c), informando todos os campos utilizados por um participante do contrato.


Request
{
"snap_mall__contrato__c":"a07o00000024EPz",
"snap_mall__papel__c":"Representante da empresa",
"snap_mall__conta__c":"001o0000005y8pP",
"snap_mall__contato__c":"0031J00001MNYIu"
}


Response
{
"id": "a0U1J00000B8I3pUAF",
"success": true,
"errors": []
}


Atualizar Participante do contrato:

               Método :PATCH

               URI com ID salesforce:https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__participante_contrato__c/ (Id do registro salesforce)

               Descrição: 

Método de atualização de um Participante do contrato(snap_mall__participante_contrato__c)  de qualquer tipo, informando no body apenas os  campos que se deseja atualizar. 


Request
{
"snap_mall__papel__c":"Fiador"
}


Response

Response em caso de sucesso da atualização retornará vazio.


Deletar Participante do contrato:

Método : DELETE

URI com ID salesforce: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__participante_contrato__c/ (Id do registro salesforce)

Descrição: Método de deleção de um Participante do contrato(snap_mall__participante_contrato__c) de qualquer tipo.



Request

Body de deleção é vazio.

Response

Response de deleção retorna vazio.