Регистрация заявки на изменение
персональных данных и документа,
удостоверяющего личность (BP.71.1)
Константин Гусев
2018/06/01 07:45

Оглавление

Характеристики API

Название характеристики

Значение

Проект

48241 Единое окно
58712+57559+62328+62488 Анонимные абоненты

Протокол

HTTPS (RESTful)

Номер бизнес-процесса

BP.71.1

Формат

JSON, XML

Тип

Асинхронный

Формат запроса

PATCH .../partyManagement/individual/{[MTS_ID/ROW_ID]}/
Accept: application/vnd.api.public.Individual+json; version=2.0
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]
EventId= [Код сообщения]

}

{
"gender":"male",
"identifiedBy": {
"type":"IndividualDocumentIdentification",
"documentType":"Паспорт гражданина РФ",
"documentSeries":"4506",
"documentNo":"765432",
"issuedBy":"УФМС",
"issueDate":"22.02.2001",
"issuingAuthorityID":"772-353",
"issuingCountry":"RU"
}

PATCH .../partyManagement/individual/{[MTS_ID/ROW_ID]}/
Accept: application/vnd.api.public.Individual+json; version=2.0
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]
EventId= [Код сообщения]

}

{
"otherName": {
"familyName":"[Фамилия]",
"givenName":"[Имя]",
"middleName":"[Отчество]"
},
"birthDate": "[Дата рождения]",
"identifiedBy": {
"type":"IndividualDocumentIdentification",
"documentType":"Паспорт гражданина РФ",
"documentSeries":"[Серия паспорта]",
"documentNo":"[Номер паспорта]",
"issuedBy":"[Кем выдан]",
"issueDate":"[Дата выдачи]",
"issuingAuthorityID":"[Код подразделения]",
"issuingCountry":"RU"
}

PUT .../partyManagement/individual/
Accept: application/vnd.api.public.Individual+json; version=2.0
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]
EventId= [Код сообщения]
[{
"id": "[MTS_ID/ROW_ID]",
"description":"[NEW]",
"otherName": {
"familyName":"[Фамилия]",
"givenName":"[Имя]",
"middleName":"[Отчество]"
},
"birthDate": "[Дата рождения]",
"identifiedBy": {
"type":"IndividualDocumentIdentification",
"documentType":"Паспорт гражданина РФ",
"documentSeries":"[Серия паспорта]",
"documentNo":"[Номер паспорта]",
"issuedBy":"[Кем выдан]",
"issuedDate":"[Дата выдачи]",
"issuingAuthorityID":"[Код подразделения]",
"issuingCountry":"RU"
},
"contactMedium": {
"type": "RegisteredAddress",
"addressType": "[Постоянная регистрация]",
"address": {
"type": "RussianBasicAddress",
"country": "RU",
"addressObject": {
"objectType": "Регион",
"name": "Московская область",
"addressObject": {
"objectType": "Район",
"name": "Одинцовский район",
"addressObject": {
"objectType": "Населенный пункт",
"name": "г. Одинцово",
"addressObject": {
"objectType": "Улица",
"name": "Можайское шоссе",
"addressObject": {
"type": "RussianBasicHouseObject",
"number": "[Номер дома]",
"zipCode": "[Индекс]",
"apartment": {
"number": "[Номер квартиры]"
}
}
}
}
}
}
},
"addressType": "[Временная регистрация]",

"validFor": {
"endDateTime":"[Дата окончания временной регистрации]"
},
"address": {
"type": "RussianBasicAddress",
"country": "RU",
"addressObject": {
"objectType": "Регион",
"name": "Московская область",
"addressObject": {
"objectType": "Район",
"name": "Одинцовский район",
"addressObject": {
"objectType": "Населенный пункт",
"name": "г. Одинцово",
"addressObject": {
"objectType": "Улица",
"name": "Новая улица",
"addressObject": {
"type": "RussianBasicHouseObject",
"number": "[Номер дома]",
"zipCode": "[Индекс]",
"apartment": {
"number": "[Номер квартиры]"
}
}
}
}
}
}
}
},
"partyRole": {
"type": "ProductUser",
"agreement": {
"documentNumber":"[Номер контракта]"
},
"product": {
"productCharacteristic": {
"name": "MSISDN",
"value": "[MSISDN]"
}
}
}
},
…,
{
"id": "[MTS_ID/ROW_ID]",
"description":"[NEW]",
"otherName": {
"familyName":"[Фамилия]",
"givenName":"[Имя]",
"middleName":"[Отчество]"
},
"birthDate": "[Дата рождения]",
"identifiedBy": {
"type":"IndividualDocumentIdentification",
"documentType":"Паспорт гражданина РФ",
"documentSeries":"[Серия паспорта]",
"documentNo":"[Номер паспорта]",

"issuedBy":"[Кем выдан]",
"issuedDate":"[Дата выдачи]",
"issuingAuthorityID":"[Код подразделения]",
"issuingCountry":"RU"

},
"contactMedium": {
"type": "RegisteredAddress",
"addressType": "[Постоянная регистрация]",
"address": {
"type": "RussianBasicAddress",
"country": "RU",
"addressObject": {
"objectType": "Регион",
"name": "Московская область",
"addressObject": {
"objectType": "Район",
"name": "Одинцовский район",
"addressObject": {
"objectType": "Населенный пункт",
"name": "г. Одинцово",
"addressObject": {
"objectType": "Улица",
"name": "Можайское шоссе",
"addressObject": {
"type": "RussianBasicHouseObject",
"number": "[Номер дома]",
"zipCode": "[Индекс]",
"apartment": {
"number": "[Номер квартиры]"
}
}
}
}
}
}
},
"addressType": "[Временная регистрация]",
"validFor": {
"endDateTime":"[Дата окончания временной регистрации]"
},
"address": {
"type": "RussianBasicAddress",
"country": "RU",
"addressObject": {
"objectType": "Регион",
"name": "Московская область",
"addressObject": {
"objectType": "Район",
"name": "Одинцовский район",
"addressObject": {
"objectType": "Населенный пункт",
"name": "г. Одинцово",
"addressObject": {
"objectType": "Улица",
"name": "Новая улица",
"addressObject": {
"type": "RussianBasicHouseObject",
"number": "[Номер дома]",
"zipCode": "[Индекс]",
"apartment": {

"number": "[Номер квартиры]"
}
}
}
}
}
}
}
},
"partyRole": {
"type": "ProductUser",
"agreement": {
"documentNumber":"[Номер контракта]"
},
"product": {
"productCharacteristic": {
"name": "MSISDN",
"value": "[MSISDN]"
}
}
}
}]
Формат ответа

202: Accepted
Content-Type: application/json
Content-Version: application/vnd.api.public.Individual+json; version=2.0
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]
EventId = [Код сообщения]
Формат ответа (изменения не требуются)

200: OK
Content-Type: application/json
Content-Version: application/vnd.api.public.Individual+json; version=2.0
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]
EventId = [Код сообщения]
Формат ошибки

400 : Bad Request || 404 : Not Found
Content-Type: application/json
Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]

}

{
"errorCode": "[RequestResultInfo.Result]",
"errorMessage": "[Описание ошибки Foris]",
"sourceID": "[Система-источник]"

Формат ошибки (передача SOAP FAULT)

500 : Internal Server Error
Content-Type: application/json

Login = [Логин]
Channel.Id = [Канал запроса]
ReplyTo = [URL сервиса для коллбека]

}

{
"errorCode": "[faultcode]",
"errorMessage": "[faultstring]",
"sourceID": "[Система-источник]"

Формат callback

POST [URL сервиса для коллбека]
Content-type: application/json

}

{
"eventID":"[Код сообщения]",
"eventType":"IndividualUpdateNotification",
"eventTime":"2017-10-13T16:24:33+03:00",

Формат ответа на callback

201: Created
Content-type: application/json
Формат ошибки при получении callback

500: Internal Server Error
Content-type: application/json
Формат callback с передачей неуспешного результата обработки заявки

POST [URL сервиса для коллбека]
Content-type: application/json

}

{
"eventID":"[Код сообщения]",
"eventType":"IndividualUpdateNotification",
"eventTime":"2017-10-13T16:24:33+03:00",
"event": {
"exception": {
"errorCode": "[Errors.Error.ErrorCode]",
"errorMessage": "[Errors.Error.ErrorMessage]",
"sourceID": "[Система-источник]"
}
}

Возврат в Оглавление
Возврат в группу Предоставление общей информации абоненту