voltar

API Referências: Filial | Consultar

post /api/Filial/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,
          Bairro: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          Cidade: string,
          Cnpj: string,
          Complemento: string,
          DescricaoCodigoGoogleMaps: string,
          Detalhe: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          ExibirSite: bit,
          Fax: string,
          Hash: uniqueidentifier,
          Imagem: string,
          Matriz: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Ordenacao: int,
          Privado: bit,
          Ramal: string,
          RazaoSocial: string,
          Residencia: string,
          Subtitulo: string,
          Telefone: string,
          Titulo: string,
          UrlAmigavel: 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: Filial | Excluir

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

post /api/Filial/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,
          Cep: string,
          Cnpj: string,
          Complemento: string,
          DescricaoCodigoGoogleMaps: string,
          Detalhe: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          ExibirSite: bit,
          Fax: string,
          Hash: uniqueidentifier,
          Matriz: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Ordenacao: int,
          Privado: bit,
          Ramal: string,
          Residencia: string,
          Subtitulo: string,
          Telefone: string,
          Titulo: string,
          UrlAmigavel: 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: Filial | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     Bairro: varchar,
     CamposAtualizados: nvarchar,
     Categoria: int,
     Cep: varchar,
     Cidade: varchar,
     Cnpj: varchar,
     Complemento: varchar,
     ConsultarPorCampo: varchar,
     DescricaoCodigoGoogleMaps: varchar,
     Detalhe: varchar,
     Email: varchar,
     Empresa: varchar,
     Endereco: varchar,
     EstadoFederal: uniqueidentifier,
     ExibirSite: bit,
     Fax: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Imagem: varchar,
     Matriz: bit,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Ordenacao: int,
     Privado: bit,
     Ramal: varchar,
     RazaoSocial: varchar,
     Residencia: varchar,
     RetornarDataSet: bit,
     Subtitulo: varchar,
     Telefone: varchar,
     Titulo: varchar,
     UrlAmigavel: 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/filial?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: Filial | ListarRelatorioPrincipal

post /api/Filial/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,
          Filial: uniqueidentifier,
          Hash: uniqueidentifier,
          Ordenacao: int,
          Titulo: 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: Filial | Pesquisar

post /api/Filial/Pesquisar?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Categoria: varchar,
     Codigo: varchar,
     Hashtag: varchar,
     IdEmpresa: varchar,
     Termo: 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,
          Bairro: string,
          Cadastro: datetime,
          Categoria: int,
          Cep: string,
          Cidade: string,
          Cnpj: string,
          Complemento: string,
          DescricaoCodigoGoogleMaps: string,
          Detalhe: string,
          Email: string,
          Empresa: uniqueidentifier,
          Endereco: string,
          EstadoFederal: uniqueidentifier,
          ExibirSite: bit,
          Fax: string,
          Filial: uniqueidentifier,
          Imagem: string,
          Matriz: bit,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Ordenacao: int,
          Privado: bit,
          Ramal: string,
          RazaoSocial: string,
          Residencia: string,
          Subtitulo: string,
          Telefone: string,
          Timestamp: timestamp,
          Titulo: string,
          UrlAmigavel: 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: Filial | Cidades

post /api/Filial/Cidades?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Estado: varchar,
     IdEmpresa: varchar,
}

 json required

Response


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

array json
{
     [
          Cidade: 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: Filial | Estados

post /api/Filial/Estados?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     IdEmpresa: varchar,
}

 json required

Response


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

array json
{
     [
          Codigo: uniqueidentifier,
          Estado: string,
          Titulo: string,
          Uf: 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: Filial | ListarFiliais

post /api/Filial/ListarFiliais?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

Obs: ListarFiliais 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: Filial | PorEstadoCidade

post /api/Filial/PorEstadoCidade?token=[SEU-TOKEN-SECRETO]&json=[JSON]

Request

Querystring parameters names Type
token string required
json

{
     Cidade: varchar,
     Estado: varchar,
     IdEmpresa: varchar,
}

 json required

Response


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

array json
{
     [
          Cidade: string,
          Detalhe: string,
          Email: string,
          Endereco: string,
          GoogleMaps: string,
          Imagem: string,
          NumeroResidencial: string,
          Telefone: string,
          Titulo: string,
          Uf: string,
          UrlAmigavel: 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