{"openapi":"3.0.1","info":{"title":"1847.mobc-simService-s-rest-v1","description":"ВТБ Онлайн - обслуживание абонентов ВТБ Мобайл","contact":{"name":"Liberov Alexey","url":"https://wiki.corp.dev.vtb/pages/viewpage.action?pageId=1192887878","email":"liberov@vtb.ru"},"version":"1.0.0"},"servers":[{"url":"https://mobc-sim-service.ss5-genr02-mobc-integration-test.apps.ss5-genr02.test.vtb.ru/secapi/rb/SimService/v1","description":"K3"},{"url":"https://mobc-sim-service.rs5-genr03-mobc-preprod.apps.rs5-genr03.test.vtb.ru/secapi/rb/SimService/v1","description":"K4"},{"url":"https://mobc-sim-service.ps5-rozb02-mobc-prod.apps.ps5-rozb02.region.vtb.ru/secapi/rb/SimService/v1","description":"PROD"}],"tags":[{"name":"DossierController","description":"Выполнение операций с продуктовым досье ФЛ"},{"name":"BarcodeController","description":"Выполнение операции получения штрих-кода"},{"name":"PostSalesProcessesController","description":"Выполнение сервисных процедур по завершению сценариев продажи и обслуживания"},{"name":"FrameDataController","description":"Выполнение процесса сбора и предоставления данных для Фрейма"}],"paths":{"/postsales/processes":{"post":{"tags":["PostSalesProcessesController"],"summary":"Вызов одного из 5ти сценариев","description":"Выполнение сервисных процедур по завершению сценариев продажи и обслуживания","operationId":"call","parameters":[{"name":"MDM_ID","in":"header","description":"идентификатор клиента в МДМ","required":true,"schema":{"maxLength":21,"minLength":1,"type":"string"}},{"name":"SYSTEM_FROM","in":"header","description":"Идентификатор вызывающей системы, всегда равно VTB_MOBILE","required":true,"schema":{"maxLength":10,"minLength":10,"type":"string"}},{"name":"SYSTEM_TO","in":"header","description":"Идентификатор вызываемой системы, всегда равно MOBC","required":true,"schema":{"maxLength":4,"minLength":4,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioRequest"}}},"required":true},"responses":{"200":{"description":"Результат выполнения","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioResponse"}}}},"400":{"description":"Ошибка обработки входных данных, объект переданный в body запроса не валидный","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}}}}},"/frame/data":{"post":{"tags":["FrameDataController"],"summary":"Предоставление данных для Фрейма","description":"Выполнение процесса сбора и предоставления данных для Фрейма","operationId":"getFrameData","parameters":[{"name":"Authorization","in":"header","description":"jwtToken","required":true,"schema":{"maxLength":500,"minLength":150,"type":"string"},"example":"Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiY2hhbm5lbCI6ImNoYW5uZWxfMSIsInNjb3BlIjoiRUNNX1VTRVIiLCJpYXQiOjE1MTYyMzkwMjIsImlzcyI6Imh0dHA6Ly9pc3N1ZXIyIiwiY3R4aSI6ImE2YjFjOWQ3LWE3Y2UtNGFlZi04YjUzLTc5NzEwYzc3YTAwMiJ9.YllKKhjFrPsu_Zoqp_bvd98dq6ZlYLzh0CpXsaaXm9DLxw1ens6GsKV_niwttO4sm57u_ZkevxtFLluNOdaf9A"},{"name":"MDM_ID","in":"header","description":"Идентификатор клиента в МДМ","required":true,"schema":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"example":12345678},{"name":"SYSTEM_FROM","in":"header","description":"Наименование системы потребителя","required":true,"schema":{"maxLength":20,"minLength":0,"type":"string"},"example":"VTB_MOBILE"},{"name":"SYSTEM_TO","in":"header","description":"Наименование системы поставщика","required":true,"schema":{"maxLength":20,"minLength":0,"type":"string"},"example":"MOBC"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrameDataRequest"}}},"required":true},"responses":{"200":{"description":"Успех. Данные предоставны","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrameDataResponse"}}}},"400":{"description":"Ошибка обработки входных данных, некорректные параметры запроса","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"500":{"description":"Внутренняя ошибка","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}}}}},"/dossier/register":{"post":{"tags":["DossierController"],"summary":"Регистрация продуктового досье","description":"Выполнение процесса регистрации заявлений и договоров, сформированных в рамках сценариев продажи и обслуживания Sim","operationId":"register","parameters":[{"name":"MDM_ID","in":"header","description":"Идентификатор клиента в МДМ","required":true,"schema":{"pattern":"[0-9]{5,30}","type":"string"},"example":"12345678"},{"name":"SYSTEM_FROM","in":"header","description":"Наименование системы потребителя","required":true,"schema":{"pattern":"VTB_MOBILE","type":"string"},"example":"VTB_MOBILE"},{"name":"SYSTEM_TO","in":"header","description":"Наименование системы поставщика","required":true,"schema":{"pattern":"MOBC","type":"string"},"example":"MOBC"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DossierData"}}},"required":true},"responses":{"200":{"description":"Документ успешно зарегистрирован","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisteredDossierResponse"}}}},"400":{"description":"Ошибка обработки входных данных, некорректные параметры запроса","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"408":{"description":"Превышено допустимое время обработки запроса","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"500":{"description":"Внутренняя ошибка сервиса","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"502":{"description":"Ошибки сторонних систем, полученные при осуществлении интеграции с ними","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}}}}},"/barcode":{"get":{"tags":["BarcodeController"],"summary":"Получение штрих-кода","description":"Выполнение операции по генерации и передаче штрих-кода","operationId":"getBarcode","parameters":[{"name":"MDM_ID","in":"header","description":"Идентификатор клиента в МДМ","required":true,"schema":{"pattern":"[0-9]{5,30}","type":"string"},"example":"12345678"},{"name":"SYSTEM_FROM","in":"header","description":"Наименование системы потребителя","required":true,"schema":{"pattern":"VTB_MOBILE","type":"string"},"example":"VTB_MOBILE"},{"name":"SYSTEM_TO","in":"header","description":"Наименование системы поставщика","required":true,"schema":{"pattern":"MOBC","type":"string"},"example":"MOBC"},{"name":"processType","in":"query","description":"Тип сценария, в рамках которого запрашивается щтрих-код","required":true,"schema":{"maxLength":100,"minLength":0,"type":"string"}}],"responses":{"200":{"description":"Операция выполнена успешно.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BarcodeResponse"}}}},"400":{"description":"Ошибка обработки входных данных.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}},"500":{"description":"Внутренняя ошибка","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInfo"}}}}}}}},"components":{"schemas":{"ErrorInfo":{"type":"object","properties":{"faultMessage":{"$ref":"#/components/schemas/FaultMessage"}},"additionalProperties":false,"description":"Объект для возврата ошибок"},"ErrorTechInfo":{"required":["mdmId","systemId","timeStamps"],"type":"object","properties":{"systemId":{"maxLength":255,"minLength":0,"type":"string","description":"Буквенное обозначение системы, которая отражает экран ошибки, согласно РИС","example":"EF"},"timeStamps":{"maxLength":20,"minLength":19,"pattern":"^(\\d{2}.\\d{2}.\\d{4} \\d{2}:\\d{2}:\\d{2})$","type":"string","description":"Точное время, возникновения ошибки","example":"03.03.2022 16:59:32"},"sessionId":{"maxLength":255,"minLength":0,"type":"string","description":"Id клиентской сессии","example":"26867c49-476c-436c-9b0c-47a95e57170b"},"mdmId":{"maxLength":255,"minLength":0,"type":"string","description":"Уникальный идентификатор клиента","example":"12345678"},"errorCode":{"maxLength":3,"type":"string","description":"Код ошибки","example":"404"},"operationId":{"maxLength":255,"minLength":0,"type":"string","description":"Тип процесса, в рамках которого произошла ошибка","example":"START_MOBC_SIM_REGISTRATION","enum":["START_MOBC_SIM_REGISTRATION","START_MOBC_SUBSCRIBER_PROFILE_VIEW","START_MOBC_SIM_REPLACE","START_MOBC_NUMBER_PORTABILITY","START_MOBC_CANCELLATION_OF_NUMBER_PORTABILITY","START_MOBC_DETAIL_VIEW","START_MOBC_CHANGE_PHONE_NUMBER","START_MOBC_SIM_LOCK","START_MOBC_SIM_UNLOCK","START_MOBC_TERMINATION_CONTRACT","START_MOBC_CANCELLATION_OF_TERMINATION_CONTRACT","START_MOBC_TARIFF_CHANGE","START_MOBC_ADDITIONAL_SERVICES_CONNECTION","START_MOBC_COMPENSATION_CONNECTION","START_MOBC_SEND_SMS_TO_SUBSCRIBER","START_MOBC_REFILL_BONUS_BALANCE","START_MOBC_REFUND"]},"traceId":{"maxLength":36,"type":"string","description":"Сквозной уникальный идентификатор процесса, подтягивается из библиотеки Zipkin через СС Трассировка","example":"63d0c67c-e334-11ec-8fea-0242ac120002"}},"additionalProperties":false,"description":"Объект с техническими параметрами ошибки выполнения запроса"},"FaultMessage":{"required":["status","text"],"type":"object","properties":{"status":{"maximum":511,"minimum":100,"type":"integer","description":"Статус ответа","format":"int32","example":222},"code":{"maxLength":3,"minLength":1,"type":"string","description":"Код ошибки (обязателен для ответов со статусом 222)","example":"001"},"action":{"type":"string","description":"Перечень доступных действий, для отрисовки кнопок (для ответов со статусом 222)","enum":["CONTINUE","REPEAT","CONFIRM","CLOSE","BACK"]},"text":{"maxLength":255,"minLength":20,"type":"string","description":"Описание ошибки","example":"Клиент не прошел проверку на присутствие в черных списках"},"description":{"maxItems":100,"minItems":0,"type":"array","items":{"maxLength":255,"type":"string","description":"Данные для  для описание действий по исправлению ошибки"}},"info":{"$ref":"#/components/schemas/ErrorTechInfo"}},"additionalProperties":false},"ScenarioResponse":{"type":"object","properties":{"scenarioResponseData":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ScenarioResponseData"}}},"additionalProperties":false,"description":"Объект для возврата результат вызова /service/scenario, контроллера ScenarioServiceController"},"ScenarioResponseData":{"type":"object","properties":{"codeStatus":{"maximum":511,"minimum":200,"type":"integer","description":"код ответа","format":"int32","example":200},"valueStatus":{"maxLength":50,"minLength":2,"type":"string","description":"статус ответа","example":"OK"},"scenarioType":{"type":"string","description":"тип сценарий, который был вызван","example":"CREATE_CROSS_REF","enum":["UPDATE_PHONE_NUMBER","CLOSE_PHONE_NUMBER","CREATE_CROSS_REF","DELETE_CROSS_REF","CHANGE_SIM_STATUS"]},"response":{"maxLength":50,"minLength":2,"type":"string","description":"результат ответа","example":"Bad Request"}},"additionalProperties":false},"ClosePhoneMessageRequest":{"required":["partyUId","person","updatePhone"],"type":"object","properties":{"partyUId":{"maxLength":30,"minLength":5,"type":"string","description":"Уникальный идентификатор клиента в МДМ","example":"1234567890"},"updatePhone":{"type":"boolean","description":"Обновление телефонов, равно true","example":true},"person":{"$ref":"#/components/schemas/Person"}},"additionalProperties":false,"description":"Объект для обработки сценария UPDATE_PHONE_NUMBER"},"ContactPhoneCommunication":{"required":["loginExternalSystem","nameExternalSystem","notFormFullPhone","phoneType","startDate","trustFlag","updateDate"],"type":"object","properties":{"notFormFullPhone":{"maxLength":11,"minLength":11,"pattern":"\\d{3}\\s\\d{7}","type":"string","description":"Неформализованный номер телефона: XXX XXXXXXX","example":"123 1234567"},"phoneType":{"maxLength":1,"minLength":0,"pattern":"6","type":"string","description":"Код типа телефона, всегда равно 6","example":"6"},"nameExternalSystem":{"maxLength":4,"minLength":4,"pattern":"MOBC","type":"string","description":"Наименование системы источника в которой производились изменения, всегда равно MOBC)","example":"MOBC"},"trustFlag":{"type":"boolean","description":"Флаг доверительной системы (всегда true)","example":true},"startDate":{"maxLength":10,"minLength":10,"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$","type":"string","description":"Дата начала действия, в формате YYYY-MM-DD, заполняется при обновлении телефона","example":"2022-06-06"},"loginExternalSystem":{"maxLength":100,"minLength":0,"type":"string","description":"Табельный номер сотрудника, инициировавшего вызов операции. Если операция инициирована в результате выполнения автоматических процессов без участия ФЛ - передавать значение \"system\"","example":"system"},"updateDate":{"maxLength":50,"minLength":0,"type":"string","description":"Дата изменения в системе источнике, в формате YYYY-MM-DDThh:mm:ss.fZ, заполняется на стороне системы","example":"2021-12-17T18:14:47.150Z"}},"additionalProperties":false,"description":"Информация по телефонам"},"ContactReference":{"required":["externalId","systemNumber"],"type":"object","properties":{"externalId":{"maxLength":20,"minLength":1,"type":"string","description":"EMS_ID абонента в системе ВТБ МОБАЙЛ"},"systemNumber":{"maxLength":4,"minLength":3,"pattern":"MOBC","type":"string","description":"Код системы, всегда равно MOBC"}},"additionalProperties":false},"DeliveryBatchSimRequest":{"required":["employeeId","iccid","shipmentstatus"],"type":"object","properties":{"iccid":{"maxLength":20,"minLength":20,"type":"string","description":"Уникальный ID для SIM карты","example":"12345678910111213142"},"employeeId":{"maxLength":20,"minLength":0,"type":"string","description":"Служебный номер сотрудника","example":"1234567"},"shipmentstatus":{"maxLength":3,"minLength":0,"pattern":"430","type":"string","description":"Статус SIM карты, всегда 430","example":"430"}},"additionalProperties":false,"description":"Объект для обработки сценария CHANGE_SIM_STATUS"},"ListContactReferenceRequest":{"type":"object","properties":{"listContactReference":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ContactReference"}}},"additionalProperties":false,"description":"Объект для обработки сценариев CREATE_CROSS_REF и DELETE_CROSS_REF"},"Person":{"type":"object","properties":{"contactPhoneCommunication":{"$ref":"#/components/schemas/ContactPhoneCommunication"}},"additionalProperties":false,"description":"Информация о ФЛ"},"ScenarioBodyResponse":{"maxProperties":4,"type":"object","additionalProperties":false,"description":"Тело запроса->объект для передачи сценарию","anyOf":[{"$ref":"#/components/schemas/DeliveryBatchSimRequest"},{"$ref":"#/components/schemas/UpdatePhoneMessageRequest"},{"$ref":"#/components/schemas/ClosePhoneMessageRequest"},{"$ref":"#/components/schemas/ListContactReferenceRequest"}]},"ScenarioObject":{"type":"object","properties":{"scenarioType":{"type":"string","description":"тип сценария, который необходимо вызвать","enum":["UPDATE_PHONE_NUMBER","CLOSE_PHONE_NUMBER","CREATE_CROSS_REF","DELETE_CROSS_REF","CHANGE_SIM_STATUS"]},"body":{"$ref":"#/components/schemas/ScenarioBodyResponse"}},"additionalProperties":false,"description":"Объект для класса ScenarioRequest - один ScenarioRequest может содержать массив ScenarioObject, т.е. можно вызывать одним запросом несколько сценариев сразу"},"ScenarioRequest":{"type":"object","properties":{"scenario":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ScenarioObject"}}},"additionalProperties":false,"description":"Коллекция содержащая набор вызываемых сценариев и входные параметры","x-example":{"scenario":[{"scenarioType":"CHANGE_SIM_STATUS","body":{"iccid":"12345678901234567890","employeeId":"1234567","shipmentStatus":430}},{"scenarioType":"CREATE_CROSS_REF","body":[{"externalId":"1234567890","systemNumber":"MOBC"}]},{"scenarioType":"DELETE_CROSS_REF","body":[{"externalId":"1234567890","systemNumber":"MOBC"}]},{"scenarioType":"UPDATE_PHONE_NUMBER","body":{"partyUId":"1234567890","updatePhone":true,"person":{"contactPhoneCommunication":{"notFormFullPhone":"123 1234567","phoneType":"6","nameExternalSystem":"MOBC","trustFlag":true,"startDate":"2022-06-03","loginExternalSystem":"user","updateDate":"2022-06-03T18:14:47.150Z"}}}},{"scenarioType":"CLOSE_PHONE_NUMBER","body":{"partyUId":"1234567890","updatePhone":true,"person":{"contactPhoneCommunication":{"notFormFullPhone":"123 1234567","phoneType":"6","nameExternalSystem":"MOBC","trustFlag":true,"startDate":"2022-06-03","loginExternalSystem":"user","updateDate":"2022-06-03T18:14:47.150Z"}}}}]}},"UpdatePhoneMessageRequest":{"required":["partyUId","person","updatePhone"],"type":"object","properties":{"partyUId":{"maxLength":30,"minLength":5,"type":"string","description":"Уникальный идентификатор клиента в МДМ","example":"1234567890"},"updatePhone":{"type":"boolean","description":"Обновление телефонов, равно true","example":true},"person":{"$ref":"#/components/schemas/Person"}},"additionalProperties":false,"description":"Объект для обработки сценария UPDATE_PHONE_NUMBER"},"ApplicationData":{"required":["consentClient","contactDataClient","dulDataClient","employee","locationDataClient","personDataClient","scenarioData"],"type":"object","properties":{"scenarioData":{"$ref":"#/components/schemas/ScenarioData"},"employee":{"$ref":"#/components/schemas/EmployeeItem"},"consentClient":{"$ref":"#/components/schemas/ConsentClient"},"personDataClient":{"$ref":"#/components/schemas/PersonData"},"dulDataClient":{"$ref":"#/components/schemas/DulData"},"locationDataClient":{"$ref":"#/components/schemas/LocationClientData"},"contactDataClient":{"$ref":"#/components/schemas/ContactDataClient"}},"additionalProperties":false,"description":"Объект заявки"},"ConsentClient":{"required":["consentGuid","creationBusinessDate"],"type":"object","properties":{"creationBusinessDate":{"maxLength":20,"minLength":19,"pattern":"^(\\d{2}-\\d{2}-\\d{4} \\d{2}:\\d{2}:\\d{2})$","type":"string","description":"Дата подписания согласия","example":"22-03-2022 10:25:31"},"consentGuid":{"maxLength":37,"minLength":10,"type":"string","description":"Уникальный идентификатор шаблона согласия (т.е. типа и версии шаблона)"}},"additionalProperties":false,"description":"Данные о согласии клиента на обработку ПДн"},"ContactDataClient":{"required":["completeNumber"],"type":"object","properties":{"completeNumber":{"maxLength":12,"minLength":6,"type":"string","description":"Номер телефона","format":"phone","example":"+76594562387"},"email":{"maxLength":50,"minLength":10,"type":"string","description":"Адрес электронной почты","format":"email","example":"test@mail.ru"}},"additionalProperties":false,"description":"Контактные данные клиента"},"DulData":{"required":["issueCode","issueCountryCode","issueDate","issueName","number","series","typeCodeDocument"],"type":"object","properties":{"series":{"maxLength":10,"minLength":4,"type":"string","description":"Серия ДУЛ, поле обязательное в зависимости от типа документа","example":"6345"},"number":{"maxLength":30,"minLength":6,"type":"string","description":"Номер ДУЛ, поле обязательное в зависимости от типа документа","example":"106347"},"issueCountryCode":{"maxLength":3,"minLength":3,"type":"string","description":"Страна выдачи","example":"645"},"typeCodeDocument":{"maxLength":30,"minLength":1,"type":"string","description":"Код типа документа","example":"1"},"issueName":{"maxLength":500,"minLength":19,"type":"string","description":"Кем выдан","example":" УФМС России по Приморскому краю в ЗАТО г. Фокино МРО УФМС России по Приморскому краю в Шкотовском муниципальном районе ЗАТО г"},"issueCode":{"maxLength":30,"minLength":7,"type":"string","description":"Код подразделения, поле обязательное в зависимости от типа документа","example":"550-003"},"issueDate":{"maxLength":10,"minLength":9,"type":"string","description":"Дата выдачи","format":"date","example":"0027-09-12"},"expirationDate":{"maxLength":10,"minLength":9,"type":"string","description":"Дата окончания, поле обязательное в зависимости от типа документа","format":"date","example":"0027-09-12"}},"additionalProperties":false,"description":"Информация о ДУЛ клиента"},"EmployeeItem":{"required":["employerId","filialId","firstName","lastName","pointOfSale","role"],"type":"object","properties":{"employerId":{"maximum":2147483646,"minimum":1,"type":"integer","description":"Идентификатор сотрудника","format":"int32","example":2131561},"role":{"maxLength":50,"minLength":10,"type":"string","description":"Роль сотрудника","example":"MOBC_TP_SALE"},"lastName":{"maxLength":100,"minLength":2,"type":"string","description":"Фамилия сотрудника","example":"Ёлкин"},"firstName":{"maxLength":100,"minLength":2,"type":"string","description":"Имя сотрудника","example":"Василий"},"patronymic":{"maxLength":100,"minLength":2,"type":"string","description":"Отчетво сотрудника","example":"Петрович"},"pointOfSale":{"maxLength":15,"minLength":1,"type":"string","description":"Код точки продажи, в которой создан документ","example":"3256"},"filialId":{"maxLength":5,"minLength":5,"type":"string","description":"Код филиала","example":"00000","default":"00000"}},"additionalProperties":false,"description":"Данные о сотруднике, производящем процесс"},"FrameDataResponse":{"required":["application"],"type":"object","properties":{"application":{"$ref":"#/components/schemas/ApplicationData"}},"additionalProperties":false,"description":"Объект исходных данных по заявке"},"LocationClientData":{"required":["country","house","kladr","okato","state","typeCodeAddr"],"type":"object","properties":{"typeCodeAddr":{"maxLength":2,"minLength":1,"type":"string","description":"Код типа адресса. Словарь TypeCodeAddrDictionary","example":"2"},"notFormAddrName":{"maxLength":500,"minLength":1,"type":"string","description":"Ненормализованный адрес","example":"5264554"},"country":{"maxLength":30,"minLength":1,"type":"string","description":"Страна","example":"Россия"},"zipCode":{"maxLength":30,"minLength":1,"type":"string","description":"Почтовый индекс","example":"660014"},"state":{"maxLength":30,"minLength":1,"type":"string","description":"Тип области (ОБЛ/КРАЙ)","example":"Резансая область"},"provinceType":{"maxLength":30,"minLength":1,"type":"string","description":"Регион (номер региона)","example":"Область...."},"province":{"maxLength":50,"minLength":1,"type":"string","description":"Область с типом (МОСКОВСКАЯ)","example":"МОСКОВСКАЯ..."},"regionType":{"maxLength":30,"minLength":1,"type":"string","description":"Тип района (Р-Н)"},"region":{"maxLength":100,"minLength":1,"type":"string","description":"Район с типом (КРАСНОГОРСКИЙ)"},"cityType":{"maxLength":30,"minLength":1,"type":"string","description":"Тип города (Г)"},"city":{"maxLength":100,"minLength":1,"type":"string","description":"Город с типом (КРАСНОГОРСК)"},"streetType":{"maxLength":30,"minLength":1,"type":"string","description":"Тип улицы (УЛ)"},"street":{"maxLength":100,"minLength":1,"type":"string","description":"Улица с типом (ЦВЕТАЕВОЙ)"},"locationType":{"maxLength":30,"minLength":1,"type":"string","description":"Тип населенного пункта (МКР)"},"location":{"maxLength":100,"minLength":1,"type":"string","description":"Населенный пункт с типом (ОПАЛИХА)"},"house":{"maxLength":10,"minLength":1,"type":"string","description":"Дом","example":"9"},"housing":{"maxLength":10,"minLength":1,"type":"string","description":"Корпус","example":"2"},"building":{"maxLength":10,"minLength":1,"type":"string","description":"Строение","example":"2"},"apartmentNumber":{"maxLength":10,"minLength":1,"type":"string","description":"Квартира/Офис","example":"33"},"kladr":{"maxLength":2,"minLength":1,"type":"string","description":"Код КЛАДР","example":"02"},"okato":{"maxLength":15,"minLength":12,"type":"string","description":"Код ОКАТО","example":"45 277 553 000"}},"additionalProperties":false,"description":"Информация о местонахождении клиента"},"PersonData":{"required":["accessActionDko","birthDateTime","birthPlace","emsId","firstName","firstNameLat","genderCode","lastName","lastNameLat","mdmId","middleName","nationalityCountryCode"],"type":"object","properties":{"mdmId":{"maxLength":32,"minLength":1,"type":"string","description":"ID клиента (MDM), равен partyUId","example":"12345678"},"emsId":{"maxLength":37,"minLength":10,"type":"string","description":"ID Клиента в EMS, поле обязятельно если заявка появилась в рамках процесса замены Sim или обслуживания, Нет, если заявка появилась в рамках процесса оформления Sim","example":"73535126594562387"},"iccid":{"maxLength":20,"minLength":20,"type":"string","description":"Номер ICCID Sim-карты, поле обязятельно если заявка появилась в рамках процесса замены Sim или обслуживания, Нет, если заявка появилась в рамках процесса оформления Sim","example":"73535126594562387583"},"accessActionDko":{"maxLength":5,"minLength":4,"type":"boolean","description":"Наличие ДКО у клиента, поле обязятельно если запущен процесс оформления Sim, Нет, если запущен иной процесс","example":false},"genderCode":{"maxLength":3,"minLength":1,"type":"string","description":"Пол Словарь GenderCodeDictionary","example":"1"},"birthDateTime":{"maxLength":20,"minLength":19,"type":"string","description":"Дата рождения","format":"date-time"},"birthPlace":{"maxLength":100,"minLength":5,"type":"string","description":"Место рождения","example":"Село Нижнекамское"},"lastName":{"maxLength":50,"minLength":2,"type":"string","description":"Фамилия сотрудника","example":"Ёлкин"},"firstName":{"maxLength":50,"minLength":2,"type":"string","description":"Имя сотрудника","example":"Василий"},"middleName":{"maxLength":50,"minLength":2,"type":"string","description":"Отчество сотрудника","example":"Петрович"},"lastNameLat":{"maxLength":100,"minLength":2,"type":"string","description":"Фамилия латиницей (в русскоязычном формате) Поле являеться если ФЛ = иностранный гражданин","example":"Василий"},"firstNameLat":{"maxLength":100,"minLength":2,"type":"string","description":"Имя латиницей (в русскоязычном формате) Поле являеться если ФЛ = иностранный гражданин","example":"Петрович"},"nationalityCountryCode":{"maxLength":3,"minLength":3,"type":"string","description":"Код гражданства словарь CountryCodeDictionary","example":"003"}},"additionalProperties":false,"description":"Данные о клиенте"},"ScenarioData":{"required":["applicationDateTime","applicationId","clientSessionId","operationId","operationName","regionId","regionName","traceId"],"type":"object","properties":{"applicationId":{"maxLength":37,"minLength":36,"type":"string","description":"Идентификатор заявки","format":"uuid","example":"ce309500-e2b8-11ec-8fea-0242ac120002"},"operationId":{"maxLength":55,"minLength":10,"type":"string","description":"Идентификатор сценария","example":"START_MOBC_REFUND"},"operationName":{"maxLength":29,"minLength":11,"type":"string","description":"Наименование сценария","example":"Возврат средств"},"clientSessionId":{"maxLength":72,"minLength":36,"type":"string","description":"Идентификатор клиенской сессии","example":"53e4567-e89b-12d3-a456-4266554400562"},"regionId":{"maxLength":2,"minLength":1,"type":"string","description":"Идентификатор региона","example":"55"},"regionName":{"maxLength":70,"minLength":3,"type":"string","description":"Имя региона","example":"Омск"},"applicationDateTime":{"maxLength":20,"minLength":19,"type":"string","description":"Дата и время создания заявки","format":"date-time"},"traceId":{"maxLength":37,"minLength":36,"type":"string","description":"Идентификатор трассировки выполнения процесса","example":"ce309500-e2b8-11ec-8fea-0242ac120002"}},"additionalProperties":false,"description":"Данные о процессе"},"FrameDataRequest":{"required":["applicationId","clientSessionId","processType"],"type":"object","properties":{"processType":{"type":"string","description":"Тип сценария, в рамках которого запрашиваются данные из заявки","enum":["START_MOBC_SIM_REGISTRATION","START_MOBC_SUBSCRIBER_PROFILE_VIEW","START_MOBC_SIM_REPLACE","START_MOBC_NUMBER_PORTABILITY","START_MOBC_CANCELLATION_OF_NUMBER_PORTABILITY","START_MOBC_DETAIL_VIEW","START_MOBC_CHANGE_PHONE_NUMBER","START_MOBC_SIM_LOCK","START_MOBC_SIM_UNLOCK","START_MOBC_TERMINATION_CONTRACT","START_MOBC_CANCELLATION_OF_TERMINATION_CONTRACT","START_MOBC_TARIFF_CHANGE","START_MOBC_ADDITIONAL_SERVICES_CONNECTION","START_MOBC_COMPENSATION_CONNECTION","START_MOBC_SEND_SMS_TO_SUBSCRIBER","START_MOBC_REFILL_BONUS_BALANCE","START_MOBC_REFUND"]},"clientSessionId":{"maxLength":36,"type":"string","description":"Идентификатор клиентской сессии","example":"ad7550ac-9e67-4d90-baac-e3277a553d67"},"applicationId":{"maxLength":36,"type":"string","description":"Идентификатор заявки","format":"uuid","example":"d39f16a7-5f83-4902-9860-023eea2032cc"}},"additionalProperties":false,"description":"Объект с входными параметрами, необходимыми для предоставления данных"},"ContractData":{"required":["barcodeNumber","contractDate","contractNum"],"type":"object","properties":{"contractNum":{"maxLength":30,"minLength":1,"type":"string","description":"Номер договора (заявления)","example":"012"},"contractDate":{"type":"string","description":"Дата договора (заявления)","format":"date-time"},"parentContractNum":{"maxLength":30,"minLength":1,"type":"string","description":"Обязательно, если с данным клиентом уже подписан договора обслуживания","example":"001"},"barcodeNumber":{"pattern":"[0-9]{30,50}","type":"string","description":"Штрихкод договора. Строка в формате BigInteger","example":"253698159505785428007157127485371077624"}},"additionalProperties":false,"description":"Объект, содержащий данные о регистрируем документе"},"RegisteredDossierResponse":{"required":["contract","hasNewBarcode","registeredDate"],"type":"object","properties":{"registeredDate":{"type":"string","description":"Дата регистрации досье","format":"date-time"},"contract":{"$ref":"#/components/schemas/ContractData"},"hasNewBarcode":{"type":"boolean","description":"Указатель на необходимость замены штрихкода новым","example":true},"newBarCode":{"maxLength":255,"minLength":0,"type":"string","description":"Штрихкод досье. Обязателен, если hasNewBarcode = true","example":"253698159505785428007157127485371077624"}},"additionalProperties":false,"description":"Результат процесса регистрации продуктового досье ФЛ"},"DossierData":{"required":["contract","employee","processType"],"type":"object","properties":{"processType":{"maxLength":255,"minLength":0,"type":"string","description":"Тип сценария, в рамках которого происходит регистрация досье ФЛ"},"employee":{"$ref":"#/components/schemas/EmployeeData"},"contract":{"$ref":"#/components/schemas/ContractData"}},"additionalProperties":false,"description":"Объект с входными параметрами, необходимыми для регистрации Досье ФЛ"},"EmployeeData":{"required":["filialId","id","manager","pointOfSale"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Идентификационный номер сотрудника","format":"int32","example":1234},"manager":{"pattern":"([А-Яа-я]{2,}\\s[А-Яа-я]{2,}\\s[А-Яа-я]{2,})","type":"string","description":"Фамилия Имя Отчетсво сотрудника","example":"Иванов Иван Иванович"},"pointOfSale":{"maxLength":255,"minLength":0,"type":"string","description":"Код точки продажи, в которой создан документ","example":"0077"},"filialId":{"maxLength":255,"minLength":0,"type":"string","description":"Код Филиала, в котором заведен продукт досье","example":"000000"}},"additionalProperties":false,"description":"Информация о сотруднике, инициализировавшем процесс регистрации продуктового досье"},"BarcodeResponse":{"required":["barcodeNumber"],"type":"object","properties":{"barcodeNumber":{"maxLength":255,"minLength":0,"type":"string","description":"Штрихкод в формате BigInteger","example":"253698159505785428007157127485371077624"}},"additionalProperties":false,"description":"Результат процесса генерации штрих-кода"}}}}