voltar

API Referências: Notificacao | Consultar

post /api/Notificacao/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,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          CategoriaNotificacao: uniqueidentifier,
          Descricao: string,
          Empresa: uniqueidentifier,
          Entidade: uniqueidentifier,
          Hash: uniqueidentifier,
          Lido: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          ReferenteResponsavel: uniqueidentifier,
          RegistroRelacionado: uniqueidentifier,
          Tipo: string,
          Titulo: string,
          UrlImagem: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          UsuarioNotificado: uniqueidentifier,
          Visualizado: bit,
     ]
}

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: Notificacao | Excluir

post /api/Notificacao/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: Notificacao | Listar

post /api/Notificacao/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,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          CategoriaNotificacao: uniqueidentifier,
          Descricao: string,
          Empresa: uniqueidentifier,
          Entidade: uniqueidentifier,
          Hash: uniqueidentifier,
          Lido: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          ReferenteResponsavel: uniqueidentifier,
          RegistroRelacionado: uniqueidentifier,
          Tipo: string,
          Titulo: string,
          UrlImagem: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          UsuarioNotificado: uniqueidentifier,
          Visualizado: bit,
     ]
}

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: Notificacao | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     CamposAtualizados: nvarchar,
     Categoria: int,
     CategoriaNotificacao: uniqueidentifier,
     ConsultarPorCampo: varchar,
     Descricao: nvarchar,
     Empresa: varchar,
     Entidade: uniqueidentifier,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Lido: bit,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Privado: bit,
     ReferenteResponsavel: uniqueidentifier,
     RegistroRelacionado: uniqueidentifier,
     RetornarDataSet: bit,
     Tipo: varchar,
     Titulo: nvarchar,
     UrlImagem: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     UsuarioNotificado: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
     Visualizado: bit,
}

 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/notificacao?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

API Referências: Notificacao | CampeonatoEnviarConvite

post /api/Notificacao/CampeonatoEnviarConvite?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: CampeonatoEnviarConvite não possui parâmetros. Logo, o parâmetro json pode ser enviado sem valor.
json 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: Notificacao | Enviar

post /api/Notificacao/Enviar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdCategoria: int,
     CdTipo: varchar,
     DsDescricao: varchar,
     DsTitulo: varchar,
     IdEmpresa: varchar,
     IdEntidade: varchar,
     IdRegistroRelacionado: varchar,
     IdUsuarioNotificado: varchar,
}

 json 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: Notificacao | ListarRelatorioPrincipal

post /api/Notificacao/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
{
     [
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Descricao: string,
          Hash: uniqueidentifier,
          Notificacao: uniqueidentifier,
          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: Notificacao | MegafutsGerarMensagem

post /api/Notificacao/MegafutsGerarMensagem?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdResponsavel: varchar,
     CodigoCategoriaNotificacao: varchar,
     IdCliente: varchar,
     IdEmpresa: varchar,
     IdRegistroRelacionado: varchar,
     Mensagem: nvarchar,
     Parametro0: nvarchar,
     Parametro1: nvarchar,
     Titulo: nvarchar,
}

 json 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: Notificacao | PorUsuario

post /api/Notificacao/PorUsuario?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdUsuario: varchar,
}

 json required

Response


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

array json
{
     [
          Alteracao: datetime,
          Cadastro: string,
          Descricao: string,
          Entidade: uniqueidentifier,
          ImagemAvatar: string,
          Lido: bit,
          Link: string,
          Notificacao: uniqueidentifier,
          RegistroRelacionado: uniqueidentifier,
          Titulo: string,
          UrlPaginaForm: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioNotificado: uniqueidentifier,
          Visualizado: bit,
     ]
}

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: Notificacao | Novas

post /api/Notificacao/Novas?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Cliente: varchar,
     IdEmpresa: varchar,
     Tipo: varchar,
}

 json required

Response


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

array json
{
     [
          Cadastro: datetime,
          Descricao: string,
          ImagemAvatar: string,
          Observacoes: text,
          Remetente: string,
          Tipo: string,
          Titulo: string,
          Url: string,
          Visualizado: bit,
     ]
}

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: Notificacao | Recentes

post /api/Notificacao/Recentes?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Cliente: varchar,
     IdEmpresa: varchar,
     Tipo: varchar,
}

 json required

Response


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

array json
{
     [
          Cadastro: datetime,
          Descricao: string,
          Hash: uniqueidentifier,
          Imagem: string,
          ImagemAvatar: string,
          Lido: string,
          Momento: string,
          Observacoes: text,
          Remetente: string,
          Tipo: string,
          Titulo: string,
          Url: 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