O objeto Cidade (snap_mall__cidade__c) contém todas as informações de cadastro da cidade que serão utilizadas para o cadastro do shopping, no objeto Shopping.

Para criação de uma cidade se faz necessário previamente possuir cadastrado na base : Estado

Campos de Cidade

Rótulo do campo	Nome de API	Tipo de dados	Obrigatório	Descrição
Cidade	Name	Texto(80)	X	Informação de identificação da cidade
Criado por	CreatedById	Pesquisa(Usuário)	X	Preenchimento automático com o usuário de sistema que realizou a criação do cadastro ou usuário da integração
Estado	snap_mall__estado__c	Detalhes do mestre(Estado)	X	ID do estado cadastrado no objeto Estado
ID Externo	snap_mall__id_externo2__c	Texto(80) (ID externo) (Não-diferenciação exclusiva de maiúsculas e minúsculas)		ID do sistema ERP, que poderá ser informado no momento da inserção da conta, para futuras atualizações, através deste ID
Última modificação feita por	LastModifiedById	Pesquisa(Usuário)	X	Informação do usuário de sistema que realizou a ultima modificação ou usuário da integração

Criar Cidade:

Método : POST

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

Descrição: Método de criação de uma Cidade(snap_mall__cidade__c), informando todos os campos utilizados para um tipo.

Request
{ "Name":"São Paulo", "snap_mall__estado__c":"a021J00000UcpKk", "snap_mall__id_externo2__c":"987654321" }

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

Atualizar Cidade:

Método :PATCH

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

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__cidade__c/snap_mall__id_externo2__c/ (Id externo)

Descrição:

Método de atualização de uma Cidade(snap_mall__cidade__c) de qualquer tipo, informando no body apenas os campos que se deseja atualizar.

Existem duas possibilidades de atualização da Cidade: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

O método PATCH pode ser utilizado par Upsert, em caso do Id externo informado não existir na base e contiver todos os campos obrigatórios no body.

Request
{ "Name":"Sao Paulo" }

Response

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

Deletar Cidade:

Método : DELETE

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

URI com ID externo: https://{{dominio}}/services/data/{{versao}}/sobjects/snap_mall__cidade__c/snap_mall__id_externo2__c/ (Id externo)

Descrição: Método de deleção de uma Cidade(snap_mall__cidade__c) de qualquer tipo. Existem duas possibilidades de deleção da Cidade: Um com Id Salesforce o outro com o Id Externo, a diferenciação desta chamada vai ser na URI.

Request

Body de deleção é vazio.

Response

Response de deleção retorna vazio.

Browser not supported