voltar

API Referências: Aluno | AlunosInativosListarRelatorioPrincipal

post /api/Aluno/AlunosInativosListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Aluno: uniqueidentifier,
          AutonumeracaoEmpresa: int,
          Email: string,
          Hash: uniqueidentifier,
          Telefone: string,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | AlunosTodosListarRelatorioPrincipal

post /api/Aluno/AlunosTodosListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          _StAtivo: bit,
          Aluno: uniqueidentifier,
          Ativo: string,
          AutonumeracaoEmpresa: int,
          Email: string,
          Hash: uniqueidentifier,
          Telefone: string,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | ListarRelatorioPrincipal

post /api/Aluno/ListarRelatorioPrincipal?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Empresa: varchar,
     Usuario: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          Aluno: uniqueidentifier,
          Ativo: string,
          AtivoValor: bit,
          AutonumeracaoEmpresa: int,
          Cliente: string,
          ClienteValor: uniqueidentifier,
          Email: string,
          Hash: uniqueidentifier,
          Responsavel1: string,
          Responsavel2: string,
          Telefone: string,
          Titulo: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | Consultar

post /api/Aluno/Consultar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Hash: varchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Ativo: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cadastro: smalldatetime,
          Categoria: int,
          Cep: string,
          Cidade: string,
          Cliente: uniqueidentifier,
          Complemento: string,
          DescricaoAdicional: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          ExibirSite: bit,
          Hash: uniqueidentifier,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Residencia: string,
          Responsavel1: string,
          Responsavel2: string,
          Telefone: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          VirtualCursoTurmaAluno: string,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | Excluir

post /api/Aluno/Excluir?token=[SEU-TOKEN-SECRETO]&Hash=[Hash]

Request

Querystring parameters names Type
token string required
Hash guid required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json null

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | Listar

post /api/Aluno/Listar?token=[SEU-TOKEN-SECRETO]

Request

Querystring parameters names Type
token string required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json
{
     [
          AcessoLiberado: text,
          Alteracao: datetime,
          Ativo: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: smalldatetime,
          Categoria: int,
          Cep: string,
          Cliente: uniqueidentifier,
          Complemento: string,
          DescricaoAdicional: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          ExibirSite: bit,
          Hash: uniqueidentifier,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Residencia: string,
          Telefone: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
     ]
}

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token

API Referências: Aluno | Salvar

post /api/Aluno/Salvar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Ativo: bit,
     Bairro: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Cliente: uniqueidentifier,
     Complemento: varchar,
     ConsultarPorCampo: varchar,
     DescricaoAdicional: varchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: uniqueidentifier,
     ExibirSite: bit,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Privado: bit,
     Residencia: varchar,
     Responsavel1: varchar,
     Responsavel2: varchar,
     RetornarDataSet: bit,
     Telefone: varchar,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
     VirtualCursoTurmaAluno: nvarchar,
}

 json required

Response


HttpResponse: OK
Property Type Default response
Status string ok
Code int 200
Success boolean true
Data

array json Consultar: https://api.tempbox.com.br/referencias/aluno?key=Consultar

HttpResponse: Error
Property Type Default response
Status string error
Code int 500
Success boolean false
Data array json null

HttpResponse: Unauthorized
Property Type Default response
Status string error
Code int 401
Success boolean false
Data array json null
Message string Invalid token