Georreferenciamento

georreferenciamento/audit/:georreferenciamento-id

Obter informações de interações no registro de Georreferenciamento

GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/audit/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento-id": "Código" } }
Query Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamentoAudits": { "description": "Auditoria", "type": "@ManyOf", "schema": { "created": "Data\/Hora", "description": "Alterações", "authorUser": { "description": "Auditoria", "type": "@OneOf", "schema": { "id": "Código", "name": "Nome" } } } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

georreferenciamento/collection

Coleção de Georreferenciamento com informações resumidas e possibilidade de filtro

GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Query Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. georreferenciamento.id, georreferenciamento.created, georreferenciamento.updated, integrationStatus.name, branch.name, georreferenciamento.internalKey, georreferenciamento.occurrence, georreferenciamento.operatorCpf, georreferenciamento.responseProtocol, georreferenciamento.name", "order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC", "filter-id": "Código", "filter-created-start": "Data de Cadastro", "filter-created-end": "Data de Cadastro", "filter-updated-start": "Data de Atualização", "filter-updated-end": "Data de Atualização", "filter-integrationStatus-id": "Situação", "filter-branch-id": "Filial", "filter-internalKey-contains": "Identificador do Registro", "filter-occurrence-start": "Data\/Hora de Ocorrência", "filter-occurrence-end": "Data\/Hora de Ocorrência", "filter-operatorCpf-contains": "CPF do Operador", "filter-responseProtocol-contains": "Protocolo de Resposta", "filter-name-contains": "Nome do Equipamento" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamentos": { "description": "Georreferenciamento", "type": "@ManyOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "internalKey": "Identificador do Registro", "occurrence": "Data\/Hora de Ocorrência", "operatorCpf": "CPF do Operador", "responseProtocol": "Protocolo de Resposta", "name": "Nome do Equipamento" } }, "total": "Total de Registros", "page": "Página Carregada", "pages": "Total de Páginas", "pagination": "Páginação", "order-by": "Atributo de Ordenação", "order-type": "Tipo de Ordenação" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

georreferenciamento/create

Criar um(a) Georreferenciamento. Um envio em imediato por Balanças/Catracas/Gates/Cameras do recinto e a posição Geográfica onde estão armazenados respectivamente. Estas informações podem ser utilizadas por outros eventos da API.

POST
http://cftv.barradorio.com.br:8080/api/georreferenciamento/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "branch": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação" } }, "internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres", "occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório", "operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres", "name": "Nome do Equipamento precisa ser um texto, Nome do Equipamento é obrigatório, Nome do Equipamento precisa ter 100 caracteres", "area": "Area do Equipamento precisa ser um texto, Area do Equipamento precisa ter 50 caracteres", "active": "Ativo precisa ser verdadeiro ou falso, Ativo é obrigatório", "azimuteCamera": "Azimute (P\/ Cameras) precisa ser um número", "equipmentType": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação" } }, "latitude": "Latitude (Ponto 1) precisa ser um texto, Latitude (Ponto 1) precisa ter 10 caracteres", "longitude": "Longitude (Ponto 1) precisa ser um texto, Longitude (Ponto 1) precisa ter 10 caracteres", "latitude2": "Latitude (Ponto 2) precisa ser um texto, Latitude (Ponto 2) precisa ter 10 caracteres", "longitude2": "Longitude (Ponto 2) precisa ser um texto, Longitude (Ponto 2) precisa ter 10 caracteres", "latitude3": "Latitude (Ponto 3) precisa ser um texto, Latitude (Ponto 3) precisa ter 10 caracteres", "longitude3": "Longitude (Ponto 3) precisa ser um texto, Longitude (Ponto 3) precisa ter 10 caracteres", "latitude4": "Latitude (Ponto 4) precisa ser um texto, Latitude (Ponto 4) precisa ter 10 caracteres", "longitude4": "Longitude (Ponto 4) precisa ser um texto, Longitude (Ponto 4) precisa ter 10 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

georreferenciamento/delete/:georreferenciamento-id

Deletar Georreferenciamento

DELETE
http://cftv.barradorio.com.br:8080/api/georreferenciamento/delete/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.delete]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

georreferenciamento/edit/:georreferenciamento-id

Editar um(a) Georreferenciamento. Um envio em imediato por Balanças/Catracas/Gates/Cameras do recinto e a posição Geográfica onde estão armazenados respectivamente. Estas informações podem ser utilizadas por outros eventos da API.

POST
http://cftv.barradorio.com.br:8080/api/georreferenciamento/edit/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento-id": "Código" } }
Body Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "branch": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação" } }, "internalKey": "Identificador do Registro precisa ser um texto, Identificador do Registro é obrigatório, Identificador do Registro precisa ter 80 caracteres", "occurrence": "Data\/Hora de Ocorrência precisa ser data e hora (Y-m-d H:i:s), Data\/Hora de Ocorrência é obrigatório", "operatorCpf": "CPF do Operador precisa ter apenas dígitos, CPF do Operador é obrigatório, CPF do Operador precisa ter 11 caracteres", "name": "Nome do Equipamento precisa ser um texto, Nome do Equipamento é obrigatório, Nome do Equipamento precisa ter 100 caracteres", "area": "Area do Equipamento precisa ser um texto, Area do Equipamento precisa ter 50 caracteres", "active": "Ativo precisa ser verdadeiro ou falso, Ativo é obrigatório", "azimuteCamera": "Azimute (P\/ Cameras) precisa ser um número", "equipmentType": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação" } }, "latitude": "Latitude (Ponto 1) precisa ser um texto, Latitude (Ponto 1) precisa ter 10 caracteres", "longitude": "Longitude (Ponto 1) precisa ser um texto, Longitude (Ponto 1) precisa ter 10 caracteres", "latitude2": "Latitude (Ponto 2) precisa ser um texto, Latitude (Ponto 2) precisa ter 10 caracteres", "longitude2": "Longitude (Ponto 2) precisa ser um texto, Longitude (Ponto 2) precisa ter 10 caracteres", "latitude3": "Latitude (Ponto 3) precisa ser um texto, Latitude (Ponto 3) precisa ter 10 caracteres", "longitude3": "Longitude (Ponto 3) precisa ser um texto, Longitude (Ponto 3) precisa ter 10 caracteres", "latitude4": "Latitude (Ponto 4) precisa ser um texto, Latitude (Ponto 4) precisa ter 10 caracteres", "longitude4": "Longitude (Ponto 4) precisa ser um texto, Longitude (Ponto 4) precisa ter 10 caracteres" } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

georreferenciamento/get/:georreferenciamento-id

Obter Georreferenciamento com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/georreferenciamento/get/:georreferenciamento-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [georreferenciamento.georreferenciamento.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Georreferenciamento", "type": "@OneOf", "schema": { "georreferenciamento": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "integrationStatus": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "branch": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "internalKey": "Identificador do Registro", "occurrence": "Data\/Hora de Ocorrência", "operatorCpf": "CPF do Operador", "responseProtocol": "Protocolo de Resposta", "name": "Nome do Equipamento", "area": "Area do Equipamento", "active": "Ativo", "azimuteCamera": "Azimute (P\/ Cameras)", "equipmentType": { "description": "Georreferenciamento", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "latitude": "Latitude (Ponto 1)", "longitude": "Longitude (Ponto 1)", "latitude2": "Latitude (Ponto 2)", "longitude2": "Longitude (Ponto 2)", "latitude3": "Latitude (Ponto 3)", "longitude3": "Longitude (Ponto 3)", "latitude4": "Latitude (Ponto 4)", "longitude4": "Longitude (Ponto 4)", "georreferenciamentoIntegration": { "description": "Integração", "type": "@ManyOf", "schema": { "id": "Código", "sentDatetime": "Data\/Hora", "sentUrl": "URL", "sentMethod": "Método", "sentAuthToken": "Autenticação", "sentBody": "Mensagem de Envio", "responseStatus": "Status de Resposta", "responseBody": "Mensagem de Resposta", "responseProtocol": "Protocolo de Resposta", "retry": "Nova Tentativa" } } } } } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message