voltar

API Referências: EstadoFederal | Consultar

post /api/EstadoFederal/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
{
     [
          Uf: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Empresa: uniqueidentifier,
          Estado: string,
          Hash: uniqueidentifier,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: 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: EstadoFederal | Excluir

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

post /api/EstadoFederal/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
{
     [
          Uf: string,
          AcessoLiberado: text,
          Alteracao: datetime,
          Autonumeracao: int,
          AutonumeracaoEmpresa: int,
          Cadastro: datetime,
          Categoria: int,
          Empresa: uniqueidentifier,
          Hash: uniqueidentifier,
          Notificavel: bit,
          ObservacoesAdicionais: text,
          Privado: 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: EstadoFederal | Salvar

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

Request

Querystring parameters names Type
token string required
json

{
     AcessoLiberado: text,
     CamposAtualizados: nvarchar,
     Categoria: int,
     ConsultarPorCampo: varchar,
     Empresa: varchar,
     Estado: varchar,
     Hash: varchar,
     HashAplicado: uniqueidentifier,
     Modo: varchar,
     Notificavel: bit,
     ObservacoesAdicionais: text,
     Privado: bit,
     RetornarDataSet: bit,
     Uf: char,
     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/estadofederal?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: EstadoFederal | ListarRelatorioPrincipal

post /api/EstadoFederal/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,
          Estado: string,
          EstadoFederal: uniqueidentifier,
          Hash: uniqueidentifier,
          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