http://cftv.barradorio.com.br:8080/api/branch/audit/:branch-id

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch-id": "Código" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100." } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branchAudits": { "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" } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

http://cftv.barradorio.com.br:8080/api/branch/collection

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado
get branch/collection/options/pu-role - Opções de Perfil
get branch/collection/options/pu-crt-type - Opções de Tipo de Certificado

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "page": "Página", "pagination": "Paginação. Máximo 100.", "order-by": "Atributo de Ordenação. branch.id, branch.name, branch.cnpj, portalUnicoRole.name, branch.puIdentityRecinto, branch.puIdentityRfb, crtType.name, branch.puProduction", "order-type": "Tipo de Ordenação no Atributo. ASC ou DESC. Padrão DESC", "filter-id": "Código", "filter-name-contains": "Nome", "filter-cnpj-contains": "CNPJ", "filter-puRole-id": "Perfil", "filter-puIdentityRecinto-contains": "Código do Recinto", "filter-puIdentityRfb-contains": "Código da RFB", "filter-puCrtType-id": "Tipo de Certificado", "filter-puProduction": "Produção" } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branchs": { "description": "Filial", "type": "@ManyOf", "schema": { "id": "Código", "name": "Nome", "cnpj": "CNPJ", "puRole": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puIdentityRecinto": "Código do Recinto", "puIdentityRfb": "Código da RFB", "puCrtType": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puProduction": "Produçã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" } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

http://cftv.barradorio.com.br:8080/api/branch/create

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado
get branch/create/options/pu-role - Opções de Perfil
get branch/create/options/pu-crt-type - Opções de Tipo de Certificado
post filesystem/write - Escrever um arquivo no sistema de arquivos da aplicação.

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.create]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch": { "description": "Filial", "type": "@OneOf", "schema": { "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 80 caracteres", "cnpj": "CNPJ precisa ter apenas dígitos, CNPJ é obrigatório, CNPJ precisa ter 14 caracteres", "puRole": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puIdentityRecinto": "Código do Recinto precisa ser um texto, Código do Recinto é obrigatório, Código do Recinto precisa ter 15 caracteres", "puIdentityRfb": "Código da RFB precisa ser um texto, Código da RFB é obrigatório, Código da RFB precisa ter 15 caracteres", "puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Certificado é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação", "puCrtType": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado é obrigatório, Senha do Certificado precisa ter 25 caracteres", "puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s), Validade do Certificado é obrigatório", "puEmailNotify": "E-mail de Notificação precisa ser um texto, E-mail de Notificação é obrigatório, E-mail de Notificação precisa ter 180 caracteres", "puProduction": "Produção precisa ser verdadeiro ou falso, Produção é obrigatório", "addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres", "addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres", "addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres", "addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres", "addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres", "addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres", "addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres" } } } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

http://cftv.barradorio.com.br:8080/api/branch/delete/:branch-id

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.delete]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch-id": "Código" } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "message": "Mensagem" } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

http://cftv.barradorio.com.br:8080/api/branch/edit/:branch-id

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado
get branch/edit/options/pu-role - Opções de Perfil
get branch/edit/options/pu-crt-type - Opções de Tipo de Certificado
post filesystem/write - Escrever um arquivo no sistema de arquivos da aplicação.

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.edit]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch-id": "Código" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch": { "description": "Filial", "type": "@OneOf", "schema": { "name": "Nome precisa ser um texto, Nome é obrigatório, Nome precisa ter 80 caracteres", "cnpj": "CNPJ precisa ter apenas dígitos, CNPJ é obrigatório, CNPJ precisa ter 14 caracteres", "puRole": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puIdentityRecinto": "Código do Recinto precisa ser um texto, Código do Recinto é obrigatório, Código do Recinto precisa ter 15 caracteres", "puIdentityRfb": "Código da RFB precisa ser um texto, Código da RFB é obrigatório, Código da RFB precisa ter 15 caracteres", "puCrt": "Certificado precisa ser um texto, Certificado precisa ter 180 caracteres, Certificado é obrigatório, Trata-se do nome do arquivo que está salvo no sistema de arquivos da aplicação", "puCrtType": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação" } }, "puCrtPassword": "Senha do Certificado precisa ser um texto, Senha do Certificado é obrigatório, Senha do Certificado precisa ter 25 caracteres", "puCrtValidity": "Validade do Certificado precisa ser data e hora (Y-m-d H:i:s), Validade do Certificado é obrigatório", "puEmailNotify": "E-mail de Notificação precisa ser um texto, E-mail de Notificação é obrigatório, E-mail de Notificação precisa ter 180 caracteres", "puProduction": "Produção precisa ser verdadeiro ou falso, Produção é obrigatório", "addressZipcode": "CEP precisa ser um texto, CEP precisa ter 8 caracteres", "addressUf": "UF precisa ser um texto, UF precisa ter 120 caracteres", "addressCity": "Cidade precisa ser um texto, Cidade precisa ter 80 caracteres", "addressDistrict": "Bairro precisa ser um texto, Bairro precisa ter 80 caracteres", "addressStreet": "Rua precisa ser um texto, Rua precisa ter 120 caracteres", "addressNumber": "Número precisa ser um texto, Número precisa ter 12 caracteres", "addressComplements": "Complemento precisa ser um texto, Complemento precisa ter 40 caracteres" } } } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "id": "Código", "message": "Mensagem" } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message

http://cftv.barradorio.com.br:8080/api/branch/get/:branch-id

post authentication/user/login - Autenticação de usuário
post authentication/user/info - Informações de usuário autenticado

Requer autenticação de usuário e acesso em um recurso específico.
internal middleware parameters [branch.branch.read]{ "description": "Autenticação", "type": "@OneOf", "schema": { "token": "Token de autenticação de usuário" } }

{ "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch-id": "Código" } }

{ "type": "success", "content": "@" } where output @ is { "description": "Registro do(a) Filial", "type": "@OneOf", "schema": { "branch": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Código", "name": "Nome", "cnpj": "CNPJ", "puRole": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puIdentityRecinto": "Código do Recinto", "puIdentityRfb": "Código da RFB", "puCrt": "Certificado", "puCrtType": { "description": "Filial", "type": "@OneOf", "schema": { "id": "Identificação", "name": "Descrição" } }, "puCrtPassword": "Senha do Certificado", "puCrtValidity": "Validade do Certificado", "puEmailNotify": "E-mail de Notificação", "puProduction": "Produção", "addressZipcode": "CEP", "addressUf": "UF", "addressCity": "Cidade", "addressDistrict": "Bairro", "addressStreet": "Rua", "addressNumber": "Número", "addressComplements": "Complemento" } } } }

{ "type": "exception", "message": "@" } where ouput exception @ is equal the string message