voltar

API Referências: Contato | CriarOportunidade

post /api/Contato/CriarOportunidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Assunto: varchar,
     Bairro: varchar,
     Cep: varchar,
     Cidade: varchar,
     Complemento: varchar,
     Concordado: varchar,
     DescricaoAdicional: nvarchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: varchar,
     FormaContato: varchar,
     Mensagem: nvarchar,
     Notificavel: bit,
     Referente: varchar,
     Residencia: varchar,
     Telefone: varchar,
     Titulo: 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: Contato | LimparLixo

post /api/Contato/LimparLixo?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: LimparLixo 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: Contato | ListarRelatorioPrincipal

post /api/Contato/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,
          Cadastro: string,
          CadastroValor: datetime,
          Contato: uniqueidentifier,
          Email: string,
          FormaContato: string,
          Hash: uniqueidentifier,
          Referente: string,
          ReferenteSubDescricao: string,
          ReferenteValor: uniqueidentifier,
          Telefone: string,
          Titulo: string,
          UrlPaginaForm: string,
          UsuarioResponsavel: string,
          UsuarioResponsavelImagem: string,
          UsuarioResponsavelValor: 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: Contato | Consultar

post /api/Contato/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
{
     [
          AceitaNewsletter: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          ArquivoAnexo: string,
          ArquivoAnexo2: string,
          Assunto: string,
          Atendido: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Bairro: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          Cidade: string,
          Complemento: string,
          Concordado: bit,
          ContatoMatriz: bit,
          ContatoUnificado: uniqueidentifier,
          DescricaoAdicional: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          FormaContato: string,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          OportunidadeCopiada: uniqueidentifier,
          Privado: bit,
          Referente: uniqueidentifier,
          ReferenteDescricao: string,
          ReferenteTipo: string,
          Residencia: string,
          Telefone: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioAlteracaoDescricao: string,
          UsuarioAlteracaoEmail: string,
          UsuarioCriacao: uniqueidentifier,
          UsuarioCriacaoDescricao: string,
          UsuarioCriacaoEmail: string,
          UsuarioResponsavel: 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: Contato | Excluir

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

post /api/Contato/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
{
     [
          AceitaNewsletter: bit,
          AcessoLiberado: text,
          Alteracao: datetime,
          Assunto: string,
          Atendido: bit,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          Complemento: string,
          Concordado: bit,
          ContatoMatriz: bit,
          ContatoUnificado: uniqueidentifier,
          DescricaoAdicional: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          FormaContato: string,
          Hash: uniqueidentifier,
          Mensagem: text,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          OportunidadeCopiada: uniqueidentifier,
          Privado: bit,
          Referente: uniqueidentifier,
          Residencia: string,
          Telefone: string,
          Titulo: string,
          UsuarioAlteracao: uniqueidentifier,
          UsuarioCriacao: uniqueidentifier,
          UsuarioResponsavel: 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: Contato | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AceitaNewsletter: bit,
     AcessoLiberado: text,
     ArquivoAnexo: varchar,
     ArquivoAnexo2: varchar,
     Assunto: varchar,
     Atendido: bit,
     Bairro: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Complemento: varchar,
     Concordado: bit,
     ConsultarPorCampo: varchar,
     ContatoMatriz: bit,
     ContatoUnificado: uniqueidentifier,
     DescricaoAdicional: varchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: uniqueidentifier,
     FormaContato: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Mensagem: text,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     OportunidadeCopiada: uniqueidentifier,
     Privado: bit,
     Referente: uniqueidentifier,
     Residencia: varchar,
     RetornarDataSet: bit,
     Telefone: varchar,
     Titulo: varchar,
     UsuarioAlteracao: uniqueidentifier,
     UsuarioCriacao: uniqueidentifier,
     UsuarioResponsavel: 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/contato?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