voltar

API Referências: Mensagem | Consultar

post /api/Mensagem/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: string,
          Descricao: string,
          Destinatario: uniqueidentifier,
          Empresa: uniqueidentifier,
          ExcluidoDestinatario: bit,
          ExcluidoRemetente: bit,
          Hash: uniqueidentifier,
          Lido: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Referente: uniqueidentifier,
          Remetente: uniqueidentifier,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: 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: Mensagem | Excluir

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

post /api/Mensagem/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: string,
          Descricao: string,
          Destinatario: uniqueidentifier,
          Empresa: uniqueidentifier,
          ExcluidoDestinatario: bit,
          ExcluidoRemetente: bit,
          Hash: uniqueidentifier,
          Lido: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: bit,
          Referente: uniqueidentifier,
          Remetente: uniqueidentifier,
          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: Mensagem | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     CamposAtualizados: nvarchar,
     Categoria: varchar,
     ConsultarPorCampo: varchar,
     Descricao: nvarchar,
     Destinatario: uniqueidentifier,
     Empresa: varchar,
     ExcluidoDestinatario: bit,
     ExcluidoRemetente: bit,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Lido: bit,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Privado: bit,
     Referente: uniqueidentifier,
     Remetente: uniqueidentifier,
     RetornarDataSet: bit,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     ValorConsultaPorCampo: varchar,
}

 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/mensagem?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: Mensagem | ExcluirMensagens

post /api/Mensagem/ExcluirMensagens?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     HashMensagens: nvarchar,
     IdCliente: 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: Mensagem | ListarRelatorioPrincipal

post /api/Mensagem/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,
          Hash: uniqueidentifier,
          Mensagem: 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: Mensagem | MarcarLido

post /api/Mensagem/MarcarLido?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Estado: varchar,
     HashMensagens: nvarchar,
     IdCliente: 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: Mensagem | Recentes

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

Request

Querystring parameters names Type
token string required
json

{
     Cliente: varchar,
     IdEmpresa: varchar,
}

 json required

Response


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

array json
{
     [
          BreveDescricao: string,
          Cadastro: datetime,
          Descricao: string,
          Hash: uniqueidentifier,
          Imagem: string,
          Lido: string,
          Link: string,
          Momento: string,
          Nome: uniqueidentifier,
          Remetente: string,
          Tabela: string,
          Titulo: string,
          Username: 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