Obter uma lista de suas solicitações | Documentação | IP Geolocation Bulk API | WhoisXML API

Obter uma lista de suas solicitações

POST https://ip-geolocation.whoisxmlapi.com/api/bgservice/request/list

Exemplo de solicitação CURL

curl https://ip-geolocation.whoisxmlapi.com/api/bgservice/request/list -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "page": 1, "onlyIds": false, "perPage": 10, "sort": "desc", "format": "json"}'

Exemplo de corpo de solicitação POST

{
    "apiKey": "YOUR_API_KEY",
    "page": 1,
    "format": "json",
    "onlyIds": false,
    "perPage": 10,
    "sort": "desc"
}

Parâmetros de entrada

apiKey

Obrigatório. Obtenha sua chave de API pessoal na página Meus produtos.

page

Opcional. Inteiro.

Usado para paginar os conjuntos de resultados em conjunto com 'perPage'.

Valor padrão: 1.

onlyIds

Opcional. Booleano.

Quando for verdadeiro, somente a lista de IDs será retornada.

Valor padrão: true.

perPage

Opcional. Inteiro.

Limita cada página do conjunto de resultados a esse número de solicitações.

Mín: 10; Máximo: 50.

Valor padrão: 10

sort

Opcional. String.

Especifique a ordem das solicitações na resposta.

Valores permitidos: "asc", "desc".

Valor padrão: "desc".

format

Opcional. String.

Usado para especificar o formato da resposta.

Valores permitidos: "xml", "json", "csv".

Valor padrão: "json".

Saída de amostra

{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596
            },
            {
                "id": 595
            },
            {
                "id": 544
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.
{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596,
                "date_start": "1528377253",
                "total_terms": 3,
                "invalid_terms": 0,
                "processed_terms": 3,
                "failed_terms": 0,
                "ready": 1
            },
            {
                "id": 595,
                "date_start": "1528377227",
                "total_terms": 20,
                "invalid_terms": 0,
                "processed_terms": 20,
                "failed_terms": 0,
                "ready": 1
            },
            {
                "id": 544,
                "date_start": "1528204702",
                "total_terms": 500,
                "invalid_terms": 0,
                "processed_terms": 500,
                "failed_terms": 0,
                "ready": 1
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.

Parâmetros de entrada

response

O objeto de resposta.

Contém o campo "data" com uma matriz de dados das solicitações do usuário em caso de sucesso.

Os campos "from" e "to" representam o intervalo de IDs do conjunto de resultados das solicitações retornadas para a página atual.

'per_page' é o tamanho das páginas e 'total' é o número de solicitações no conjunto de resultados.

A 'current_page' e a 'last_page' correspondem ao número de páginas no conjunto de resultados.

No caso de um erro, ele contém sua descrição no campo "error". Se houver vários erros, suas descrições serão retornadas na matriz "errors".

data

Matriz.

Uma lista dos elementos de informação de suas solicitações (se "onlyIds" for verdadeiro, cada elemento terá apenas o campo "id" ).

data[k].id

O objeto de resposta.

ID da solicitação.

data[k].date_start

Cordas.

Representação em cadeia de caracteres do carimbo de data/hora Unix de início da solicitação.

data[k].total_terms

Inteiro.

O total do número de termos (IPs, e-mails, nomes de domínio) na solicitação.

data[k].invalid_terms

Inteiro.

Número de termos inválidos.

data[k].processed_terms

Inteiro.

Número de termos já processados.

data[k].failed_terms

Inteiro.

Número de termos que não puderam ser processados.

data[k].ready

Inteiro.

1 se o processamento tiver sido concluído, 0 - caso contrário.

from

Inteiro.

ID mínima da solicitação na página atual do conjunto de dados.

to

Inteiro.

ID máxima da solicitação na página atual do conjunto de dados.

per_page

Inteiro.

Número máximo de solicitações para cada página do conjunto de resultados.

total

Inteiro.

O número total de solicitações no conjunto de resultados.

current_page

Inteiro.

Número da página atual no conjunto de resultados.

last_page

Inteiro.

O número da última página do conjunto.

error

Cordas.

Descrição do erro.

errors

Matriz.

Várias mensagens de erro.