Tipo de Referência (Rest)

Visão geral

Através do serviço RMSRestDataServer, via RESTful, o usuário poderá acessar o dataserver de Tipo de Referência (BibTipoRefData) para a realização de requisições de consulta, inclusão, alteração ou exclusão de dados.  

Essas requisições são disponibilizadas através dos métodos: GET, PUT, POST e DELETE e são, sempre, utilizados os valores das chaves primárias como índice para que elas sejam realizadas.

No link Serviços RESTful no RM é possível obter todas as informações sobre os serviços disponibilizados.

Se necessário clique aqui para obter ajuda na configuração do Host.

Consulta

Para a realização de uma consulta, é necessária a utilização do método GET. 

Através desse método, é possível realizar a consulta de apenas um tipo de referência ou de uma lista de tipos de referência.

Para a requisição de informações de um tipo de referência será necessário passar os valores da chave primária do tipo de referência: CODCOLIGADA e CODIGO.

Retornando uma lista e tipos de referência:

Para a consulta de uma lista de tipos de referência, é necessário a utilização da URL:

HTTP://<SERVIDOR>:<HTTPORT>/rmsrestdataserver/rest/BibTipoRefData

É possível, nessa consulta, utilizar filtros para a limitação da quantidade de informações retornadas e, também, para restringir o resultado.

Através do link Serviço GetAll é possível obter mais informações de como utilizar os filtros disponíveis.

Exemplo: 

http://localhost:8051/rmsrestdataserver/rest/BibTipoRefData?start=3&limit=2

{
   "messages": [],
   "length": 5,
   "data":    [
            {
         "id": "1$_$4",
         "CODCOLIGADA": 1,
         "CODIGO": 4,
         "DESCRICAO": "Tipo de Referência",
         "SIMBOLO": "TR"
      }
   ]
}

Retornando apenas um tipo de referência:

Para realizar a consulta de um tipo de referência, será necessário a utilização dos valores de chave primária do tipo de referência:

Exemplo:

http://localhost:8051/rmsrestdataserver/rest/BibTipoRefData/1$_$5

O valor informado no final da URL "1$_$0000108" se refere aos valores da coligada e do codigo do tipo de Referência.

Esse valores são separados pelos caracteres "$" e "_".

Para a realização dessa requisição, deverá ser utilizado o método: GET.

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$5",
      "CODCOLIGADA": 1,
      "CODIGO": 5,
      "DESCRICAO": "Tipo de Ref",
      "SIMBOLO": "TiR"
   }
}

CADASTRO

Cadastrando um tipo de referência:

Para realizar o cadastro de um tipo de referência é necessário que sejam passados, entre um conjunto de chaves, todos os campos que serão inseridos e no cabeçalho da mensagem deverão ser incluídos os campos CODCOLIGADA, CODFILIAL e CODUNIDADE para criação do contexto em que o tipo de referência será incluso.

URL que será utilizada para cadastro do tipo de referência: http://localhost:8051/rmsrestdataserver/rest/BibTipoRefData

Para a realização dessa requisição, deverá ser utilizado o método: POST.

Segue o exemplo de um conjunto mínimo de informações necessárias para cadastro de um tipo de referência:

{
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Ref",
      "SIMBOLO": "TiR"
}

Caso esteja utilizando a aplicação SoapUI, as informações do cabeçalho podem ser informadas conforme abaixo:

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$12",
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Ref",
      "SIMBOLO": "TiR"
   }
}

Alterações

Atualizando informações do tipo de referência:

Para realizar a atualização de cadastro de um tipo de referência é necessário que sejam passados, entre um conjunto de chaves, todos os campos que serão alterados, assim como, a tag ID que informará qual tipo de referência será alterado.

No cabeçalho da mensagem, também, deverão ser incluídos os campos CODCOLIGADA, CODFILIAL e CODUNIDADE para criação do contexto em que o tipo de referencia será incluso.

URL que será utilizada para cadastro do tipo de referência: http://localhost:8051/rmsrestdataserver/rest/BibTipoRefData/1$_$12

Para a realização dessa requisição, deverá ser utilizado o método: PUT.

Segue o exemplo de um conjunto de informações de um tipo de referência que serão alterados:

{
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Refer",
      "SIMBOLO": "TiR"
}

Exemplo da resposta:

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$12",
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Refer",
      "SIMBOLO": "TiR"
   }
}

Exclusões

Excluindo o tipo de referência:

A exclusão de um tipo de referência seguirá a mesma ideia da alteração, onde precisaremos passar as chaves do tipo de referência a ser excluído, assim como o corpo da mensagem com suas informações.

 No cabeçalho da mensagem, também, deverão ser incluídos os campos CODCOLIGADA, CODFILIAL e CODUNIDADE para criação do contexto.

URL que será utilizada para cadastro do tipo de referência: http://localhost:8051/rmsrestdataserver/rest/BibTipoRefData/1$_$12

Para a realização dessa requisição, deverá ser utilizado o método: DELETE.

Segue o exemplo de um conjunto de informações de um tipo de referência que serão alterados:

{
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Refer",
      "SIMBOLO": "TiR"
}

Resposta da mensagem:

{
   "messages": [],
   "length": 1,
   "data":    {
      "id": "1$_$12",
      "CODCOLIGADA": 1,
      "CODIGO": 12,
      "DESCRICAO": "Tipo de Refer",
      "SIMBOLO": "TiR"
   }
}