Obter itens

Obter itens #

Obtém todos os itens de diretório que correspondem ao filtro fornecido.

GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}& campos={CAMPOS}

Hand Left warning
Lembre-se de URL Codifique todos os parâmetros que estão sendo passados no ' filtro' parâmetro.
Document note
Ao pesquisar em ' phoneX' campos, os números são armazenados em E.164 formato.

Exemplo #

Essa solicitação consultará todos os itens com um campo de telefone contendo +44XXXXXXXXXX

Color Wand tip
As pesquisas são feitas usando um CONTAINS consulta

Pedir # 

GET [https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=& campos=telefone1& campos=telefone2& campos=telefone3& campos=telefone4](https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items?filter%2B44XXXXXXXXXX=&fields=phone1&fields=phone2&fields=phone3&fields=phone4) HTTP/1.1
Autorização: Portador {TOKEN}

Resposta # 

HTTP/1.1 200 OK
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: xx
{
    "page_size": 1,
	"dados": [ {
            "id": "00000000-0000-0000-0000-0000000000123",
            "campos": {
                "title": "Sr.",
                "fullName": "CRM2",
                "nomedaempresa": "Empresa",
                "jobTitle": "Cargo",
                "phone1": "+44XXXXXXXXXX",
                "email": "Endereço de e-mail",
                "campo1": "campo1",
                "campo2": "campo2",
                "crmId": "00000000-0000-0000-0000-0000000000001"
            }
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000123",
            "fields": {
                "title": "Mr",
                "fullName": "CRM2",
                "companyName": "Company",
                "jobTitle": "Job Title",
                "phone1": "+44XXXXXXXXXX",
                "email": "Email Address",
                "field1": "field1",
                "field2": "field2",
                "crmId": "00000000-0000-0000-0000-000000000001"
            }
        }
    ],
	"status": "sucesso",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Erros #

Desautorizado #

Quando o token não é fornecido, é inválido ou expirado 

HTTP/1.1 401 Não autorizado

Solicitação incorreta #

Quando o filtro ou os campos fornecidos não estão no formato correto 

HTTP/1.1 400 Solicitação incorreta
Data: Qui, 06 de fevereiro de 2020 12:45:27 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 149
{
	"erro": 400,
	"message": "O valor '<directory id>' não é válido.",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:45:27.5903465Z"
}

Não encontrado #

Quando não há itens de diretório encontrados para corresponder ao filtro fornecido. 

HTTP/1.1 404 Não encontrado
Data: Qui, 06 de fevereiro de 2020 12:46:58 GMT
Tipo de conteúdo: aplicativo / json; conjunto de caracteres=utf-8
Comprimento do conteúdo: 95
{
	"erro": 404,
	"message": "Não encontrado",
	"status": "erro",
	"carimbo de data/hora": "2020-02-06T12:46:58.7669535Z"
}