Запрос служит для получения данных о доступных профилях владельца ключей. SIM-карта может содержать несколько ключей, каждый из которых связан с так называемым профилем владельца ключа. Набор полей в профиле может варьироваться и зависит выбранного поставщика услуг мобильной электронной подписи.
Ниже представлены примеры профилей, которое используются в решениях операторов Lifecell и Vodafone.
URL-адрес запроса
https://localhost:9094/api/v1/mssp/{msspId}/profiles
Метод
PUT
Параметры запроса
msspId | String | Идентификатор ПУМЭП. Может быть получен с использованием запроса Получение списка поддерживаемых ПУМЭП |
Настраиваемые заголовки запроса
Content-Type | application/json |
Параметры JSON объекта запроса
Имя | Тип | Описание | Допустимые значения |
---|---|---|---|
phoneNumber | String | Номер телефона | Строка с номером телефона, который связан с SIM-картой, данные профилей владельца ключей которой необходимо получить |
Ответ
Код ответа | Content-type | Допустимые параметры | Пример содержимого |
---|---|---|---|
200 | application/json | Array | [ |
400 | application/json | message | { |
500 | application/json | message failureCause | { |
Параметры JSON объекта ответа
Параметр | Тип данных | Описание |
---|---|---|
message | String | Описание результата проведения операции |
Array | Array | Массив профилей владельца ключей |
failureCause | String | Дополнительная иформация об ошибке:
Наличие всех, одного или нескольких типов дополнительной информации в поле "failureCause" необязательно. |
Поля элемента Массив профилей владельца ключей
Поле | Тип данных | Описание |
---|---|---|
organization | String | Название организации |
title | String | Название профиля |
positionId | String | Идентификатор должности владельца профиля |
service | String | Идентификатор сервиса, который связан с выработкой электронной подписи. Для решений Lifecell и Vodafone допустимыми значеними идентификатора сервиса при необходимости выработки электронной подписи с использованием национальных криптоалгоритмов являются:
Профили со значениями идентификатора сервиса, которые отличны от указанных выше, не включаются в ответ. |
Пример кода на JavaScript + jQuery 2.2.4
$.ajax({ url: "https://localhost:9094/api/v1/mssp/IdHubTest1/profiles", type: "PUT", dataType: "json", contentType: "application/json", data: JSON.stringify({phoneNumber : "380934000227"}) }).done(function (jsonResponse, textStatus, xhr) { message = jsonResponse.message; }).fail(function (xhr) { try { var jsonResponse = JSON.parse(xhr.responseText); message = jsonResponse.message; failureCause = jsonResponse.failureCause; } catch (e) { message = (xhr.responseText == undefined) ? "Ошибка при получении профилей владельцев ключей." : xhr.responseText; } })