sgrProcuraCidade
Lista as cidades cadastradas de acordo com os parâmetros pesquisados.
PARÂMETROS
Campo | Tipo | Req.? | Descrição |
---|---|---|---|
chaveacesso | string | Sim | Chave retornada pelo método sgrLogin. |
tipopesquisa | string | Sim | Informar ‘N’ para pesquisar pelo nome da cidade, ou ’C’ para consultar um código. |
parametro | string | Não | Parâmetro utilizado na pesquisa. Se for pesquisar pelo nome (tipopesquisa = n), e o parâmetro for nulo, lista todas as cidades. A passagem de parâmetro é obrigatória na pesquisa pelo código (tipopesquisa = c). |
RETORNO DO MÉTODO:
ReturnDataset: Se os parâmetros estiverem corretos, a propriedade irá apresentar:
Campo | Tipo | Descrição |
---|---|---|
CDCID | inteiro | Código da Cidade |
DSCIDADE | string | Nome da Cidade |
DSUF | string | Sigla do Estado |
CDPAIS | inteiro | Código do País |
DSPAIS | string | Nome do País |
CDIBGE | inteiro | Código IBGE da cidade |
ReturnDescription: Se houver erro na execução do método, a propriedade irá apresentar:
Erro | Descrição |
---|---|
Tipo de parâmetro inválido! | Deve ser 'C' para pesquisar pelo código, ou ‘N’ pelo nome. |
Não existem cidades com o parâmetro informado! |