Usuário

user/audit/:user-id

Obter informações de interações no registro de Usuário

GET
http://cftv.barradorio.com.br:8080/api/user/audit/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user-id": "Código" } }
Query Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "userAudits": { "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

user/collection

Coleção de Usuário com informações resumidas e possibilidade de filtro

GET
http://cftv.barradorio.com.br:8080/api/user/collection
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Query Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. user.id, user.name, user.email, person.name, crtType.name", "order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC", "filter-id": "Código", "filter-name-contains": "Nome", "filter-email-contains": "E-mail", "filter-person-id": "Pessoa", "filter-puCrtType-id": "Tipo de Certificado" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "users": { "description": "Usuário", "type": "@ManyOf", "schema": { "id": "Código", "name": "Nome", "email": "E-mail", "person": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puCrtType": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "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

user/create

Criar um(a) Usuário

POST
http://cftv.barradorio.com.br:8080/api/user/create
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
Body Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user": { "description": "Usuário", "type": "@OneOf", "schema": { "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 160 caracteres", "email": "E-mail precisa ser um texto, E-mail é obrigatório, E-mail precisa ter 160 caracteres", "userActive": "Usuário Ativo precisa ser verdadeiro ou falso, Usuário Ativo é obrigatório", "person": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação" } }, "userMaster": "Usuário Gerente precisa ser verdadeiro ou falso, Usuário Gerente é obrigatório", "puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação", "puCrtType": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado precisa ter 25 caracteres", "puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s)", "userAccessProfile": { "description": "Perfil de Acesso", "type": "@ManyOf", "schema": { "accessProfile": { "description": "Perfil de Acesso", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "userResource": { "description": "Recursos Customizados", "type": "@ManyOf", "schema": { "resource": { "description": "Recursos Customizados", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

user/delete/:user-id

Deletar Usuário

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

user/edit/:user-id

Editar um(a) Usuário

POST
http://cftv.barradorio.com.br:8080/api/user/edit/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user-id": "Código" } }
Body Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user": { "description": "Usuário", "type": "@OneOf", "schema": { "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 160 caracteres", "email": "E-mail precisa ser um texto, E-mail é obrigatório, E-mail precisa ter 160 caracteres", "userActive": "Usuário Ativo precisa ser verdadeiro ou falso, Usuário Ativo é obrigatório", "person": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação" } }, "userMaster": "Usuário Gerente precisa ser verdadeiro ou falso, Usuário Gerente é obrigatório", "puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação", "puCrtType": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado precisa ter 25 caracteres", "puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s)", "userAccessProfile": { "description": "Perfil de Acesso", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "accessProfile": { "description": "Perfil de Acesso", "type": "@OneOf", "schema": { "id": "Identificação" } } } }, "userResource": { "description": "Recursos Customizados", "type": "@ManyOf", "schema": { "id": "Código precisa ser um número, Chave primária de identificação do registro gerada automaticamente", "resource": { "description": "Recursos Customizados", "type": "@OneOf", "schema": { "id": "Identificação" } } } } } } } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

user/get/:user-id

Obter Usuário com todos os detalhes de suas informações

GET
http://cftv.barradorio.com.br:8080/api/user/get/:user-id
Header Input
Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [user.user.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }
URI Input
{ "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user-id": "Código" } }
Output
{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Usuário", "type": "@OneOf", "schema": { "user": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Código", "created": "Data de Cadastro", "updated": "Data de Atualização", "name": "Nome", "email": "E-mail", "userActive": "Usuário Ativo", "person": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "userMaster": "Usuário Gerente", "puCrt": "Certificado", "puCrtType": { "description": "Usuário", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puCrtPassword": "Senha do Certificado", "puCrtValidity": "Validade do Certificado", "userAccessProfile": { "description": "Perfil de Acesso", "type": "@ManyOf", "schema": { "id": "Código", "accessProfile": { "description": "Perfil de Acesso", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } }, "userResource": { "description": "Recursos Customizados", "type": "@ManyOf", "schema": { "id": "Código", "resource": { "description": "Recursos Customizados", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } } } } } } } }
Output Exception
{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message