A API de Custom Entity é responsável pela manutenção de cadastros customizáveis e valores para os cadastros. É nela que vamos conseguir consultar os cadastros customizáveis, além de consultar, incluir e atualizar os registros dos cadastros customizáveis.
Descrição de um Cadastro Customizável
OBS: Para atualização de cadastro, somente o identificador alternativo é obrigatório.
| Campo | Valor | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| description | texto | 100 | Sim | Descrição do cadastro customizável. |
| alternativeIdentifier | texto | 100 | Não | Identificador que possibilita a relação com o outros sistemas(legados). |
| id | numérico | 10 | Não | Identificador interno do cadastro customizável no uMov.me |
| active | true/false | Não | Indica se um cadastro customizável está no estado ativo ou não. Pode receber valores "true" ou "false" | |
| labelDescription | texto | 100 | Não | Label que será utilizado para a descrição do registro no cadastro customizável |
| descriptionAlternativeIdentifier | texto | 100 | Não | Label que será utilizado para o identificador alternativo do registro no cadastro customizável |
| customFields | lista | Não | Lista com os campos customizáveis vinculados no cadastro customizável |
Importante: Somente é possível consultar os cadastros customizáveis via API. Não é possível criar ou editar os cadastros customizáveis. Somente é possível incluir e editar os registros dos cadastros customizáveis.
Busca Por Lista de Cadastros Customizáveis
GET /CenterWeb/api/{$apiKey}/customEntity.xml
Se preferir ainda, pode refinar as pesquisas enviando parâmetros na requisição, para isso é necessário adicionar parâmetros igual realizamos em uma requisição HTTP:
- description: pesquisar por um determinado cadastro customizável com descrição = 134
Enviar parâmetros para a API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:
A resposta da requisição será uma mensagem contendo o total de registros retornados em uma lista simples, sem detalhes de cada registro retornado, contendo para cada entrada, Id do registro no uMov.me e o link, que pode ser usado para recuperar os dados específicos deste registro.
Busca de um Cadastro Customizável específico
GET /CenterWeb/api/{$apiKey}/customEntity/{$id}.xml
Esta operação serve para puxar informações de um cadastro customizável no sistema. Veja o exemplo de retorno de uma entidade abaixo (considerando uma requisição feita em XML):
| Campo | Valor | Tam. | Obrig. | Descrição |
|---|---|---|---|---|
| description | texto | 100 | Sim | Descrição do registro do cadastro customizável. |
| alternativeIdentifier | texto | 10 | Não | Identificador que possibilita a relação com o outros sistemas(legados). |
| id | numérico | 10 | Não | Identificador interno do registro do cadastro customizável no uMov.me |
| active | true/false | Não | Indica se um cadastro customizável está no estado ativo ou não. Pode receber valores "true" ou "false" | |
| customFields | lista | Não | Relação de valores dos campos customizáveis vinculados ao cadastro customizável. Todos os campos customizáveis vinculados ao cadastro aparecerão na consulta. A consulta, atualização e inclusão do campo customizável deve ser feita através do identificador alternativo do campo. |
Busca Por Lista de Registros do Cadastro Customizável
GET /CenterWeb/api/{$apiKey}/customEntity/{id cadastro}/customEntityEntry.xml
Se preferir ainda, pode refinar as pesquisas enviando parâmetros na requisição, para isso é necessário adicionar parâmetros igual realizamos em uma requisição HTTP:
- description: pesquisar por um determinado registro do cadastro customizável com descrição = 134.
- Sempre deve ser informado o id do cadastro que deseja buscar os registros
Enviar parâmetros para a API uMov.me é simples assim. Veja um exemplo, do resultado de uma requisição que foi feita em XML:
Busca de um Registro do Cadastro Customizável específico
GET /CenterWeb/api/{$apiKey}/customEntity/{id cadastro}/customEntityEntry/{id cadastro}.xml
Esta operação serve para puxar informações de um cadastro customizável no sistema.
Veja o exemplo de retorno de uma entidade abaixo utilizando o id interno do cadastro e registro (considerando uma requisição feita em XML):
Esta operação serve para puxar informações de um cadastro customizável no sistema.
Veja o exemplo de retorno de uma entidade abaixo utilizando o id alternativo do cadastro e registro (considerando uma requisição feita em XML):
Utilizando id interno:
POST /CenterWeb/api/{$apiKey}/customEntity/{id cadastro}/customEntityEntry.xml
Utilizando identificador alternativo:
POST /CenterWeb/api/{$apiKey}/customEntity/alternativeIdentifier/{id alternativo cadastro}/customEntityEntry.xml
Esta operação serve para incluir um registro para o cadastro customizável no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação de um novo registro no ambiente em questão. Confira a descrição de um registro de cadastro customizável para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
Utilizando id interno:
POST /CenterWeb/api/{$apiKey}/customEntity/{id cadastro}/customEntityEntry/{id registro}.xml
Utilizando identificador alternativo:
POST /CenterWeb/api/{$apiKey}/customEntity/{id alternativo cadastro}/customEntityEntry/alternativeIdentifier/{id alternativo registro}.xml
Esta operação serve para alterar um registro do cadastro customizável no sistema.
Inclusão e atualização em Lote de Registro de Cadastro Customizável
POST /CenterWeb/api/{$apiKey}/batch/customEntity/alternativeIdentifier/{IdAlternativo}/customEntityEntries.xml
Esta operação serve para incluir ou atualizar vários registros para o cadastro customizável no sistema. Existe um mínimo de informações que o sistema espera receber para poder realizar a criação ou atualização de um registro no ambiente em questão. Confira a descrição de um registro de cadastro customizável para identificar os campos obrigatórios. Veja um exemplo da requisição com dados em XML:
Comentários
0 comentário
Por favor, entre para comentar.