Поиск

Метод

GET https://login.company.com/blitz/api/v1/users

Поиск учетной записи.

URL-параметры

В query передается поисковый запрос в формате Resource Query Language (RQL). Операции:

• and – одновременное выполнение поисковых условий;

• or – альтернативное выполнение поисковых условий (например, поиск по разным атрибутам);

• eq – проверка условия равенства.

При выполнении поиска по атрибуту, имеющему строковое значение, рекомендуется явно специфицировать тип значения. Например, string:02142527602.

Внимание

Если поисковый атрибут является строкой, содержащей специальные символы, такие как &|()=<>,, то необходимо придерживаться следующего алгоритма экранирования и кодирования параметров:

1. Выполнить кодирование всех значений атрибутов – экранировать присутствующие в параметрах специальные символы. Например, если выполняется поиск по телефону +7(999)1234567, то значение параметра должно быть преобразовано к значению +7%28999%291234567.

2. Собрать общую строку для передачи в качестве параметра query в запрос. Например, phone_number=+7%28999%291234567.

3. Выполнить URL-Encode значения параметра. Например, получится такое значение параметра – phone_number%3D%2B7%2528999%25291234567.

Примеры

Простой поисковый запрос

Запрос

GET /blitz/api/v1/users?query=eq(phone_number.string:79991234567) HTTP/1.1
Authorization: Basic YXBwX2lkOmFwcF9zZWNyZXQ=

Ответ

[
   {
      "instanceId":"Mzg5…nU",
      "attrs":{
         "sub":"854436f6-af58-4a3f-8cb7-c2c441eb4a76",
         "family_name":"Иванов",
         "given_name":"Иван",
         "middle_name":"Иванович",
         "phone_number":"79991234567",
      }
   }
]

Сложный поисковый запрос

Запрос

GET /blitz/api/v1/users?query=or(eq(phone_number,string:79991234567),eq(phone_number,string:79991112233)) HTTP/1.1
Authorization: Basic YXBwX2lkOmFwcF9zZWNyZXQ=

Поиск по строке, содержащей специальные символы

Запрос

GET /blitz/api/v1/users?query=phone_number%3D%2B7%2528999%25291234567 HTTP/1.1
Authorization: Basic YXBwX2lkOmFwcF9zZWNyZXQ=