voltar

API Referências: MensagemPersonalizada | Consultar

post /api/MensagemPersonalizada/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,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Default: bit,
          Empresa: uniqueidentifier,
          Entidade: uniqueidentifier,
          Identificador: string,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          PalavraChave: string,
          Privado: bit,
          Publicado: bit,
          Referente: uniqueidentifier,
          ReferenteDescricao: string,
          TipoMensagemPersonalizada: uniqueidentifier,
          Titulo: string,
          UrlAmigavel: string,
          UsarModeloPadrao: bit,
          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: MensagemPersonalizada | Excluir

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

post /api/MensagemPersonalizada/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,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Default: bit,
          Empresa: uniqueidentifier,
          Entidade: uniqueidentifier,
          Identificador: string,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          PalavraChave: string,
          Privado: bit,
          Publicado: bit,
          Referente: uniqueidentifier,
          TipoMensagemPersonalizada: uniqueidentifier,
          Titulo: string,
          UrlAmigavel: string,
          UsarModeloPadrao: bit,
          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: MensagemPersonalizada | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Assunto: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     ConsultarPorCampo: varchar,
     Default: bit,
     Empresa: varchar,
     Entidade: uniqueidentifier,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Identificador: varchar,
     Mensagem: text,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     PalavraChave: varchar,
     Privado: bit,
     Publicado: bit,
     Referente: uniqueidentifier,
     RetornarDataSet: bit,
     TipoMensagemPersonalizada: uniqueidentifier,
     Titulo: varchar,
     UrlAmigavel: varchar,
     UsarModeloPadrao: bit,
     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/mensagempersonalizada?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: MensagemPersonalizada | CarregarPorIdentificador

post /api/MensagemPersonalizada/CarregarPorIdentificador?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     CdIdentificador: varchar,
     IdEmpresa: 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,
          Assunto: string,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Default: bit,
          Empresa: uniqueidentifier,
          Entidade: uniqueidentifier,
          Identificador: string,
          Mensagem: text,
          MensagemPersonalizada: uniqueidentifier,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          PalavraChave: string,
          Privado: bit,
          Publicado: bit,
          Referente: uniqueidentifier,
          Timestamp: timestamp,
          TipoMensagemPersonalizada: uniqueidentifier,
          Titulo: string,
          UrlAmigavel: string,
          UsarModeloPadrao: bit,
          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: MensagemPersonalizada | FormatarMensagem

post /api/MensagemPersonalizada/FormatarMensagem?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assunto: varchar,
     AssuntoFinal: varchar,
     Empresa: varchar,
     FonteDados: varchar,
     Identificador: varchar,
     Mensagem: nvarchar,
     MensagemFinal: nvarchar,
}

 json required

Response


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

array json
{
     [
          NovoTexto: 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: MensagemPersonalizada | ListarRelatorioPrincipal

post /api/MensagemPersonalizada/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
{
     [
          Assunto: string,
          AutonumeracaoEmpresa: int,
          Default: string,
          DefaultValor: bit,
          Entidade: string,
          Hash: uniqueidentifier,
          Identificador: string,
          MensagemPersonalizada: uniqueidentifier,
          Referente: string,
          ReferenteValor: uniqueidentifier,
          Singular: string,
          Titulo: string,
          UrlPaginaForm: string,
          UsarModeloPadrao: string,
          UsarModeloPadraoValor: 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