Взаимодействие веб-сервиса ББО с веб-сервисом поставщика
Структура запроса данных для ББО:
{
"fn": "service.getReportData",
"args": {
"org": [],
"collection": []
}
}
где:
- org - список организаций, для которых нужно предоставить данные.
- collection - список коллекций, данные по указанным организациям
Пример запроса для отчета "Сведения об обучающихся из числа коренных малочисленных народов Севера в ДОО".
Запрашиваются данные по двум организациям. Данные нужно предоставить по коллекции studentInfoKmnsDoo.
{
"fn": "service.getReportData",
"args": {
"attestPeriod": "2016",
"date": "2017-05-22",
"org": [
{
"org": "org-1105",
"code": "org-1105",
"name": "МБДОУ д/с «Аист»",
"inn": "8617010243",
"ogrn": "1028601683450",
"orgStruct": "legalEntity"
},
{
"org": "org-1106",
"code": "org-1106",
"name": "МБДОУ № 18 «Мишутка»",
"inn": "8602169312",
"ogrn": "1108602003454",
"orgStruct": "legalEntity",
"terr": "terr-1101"
}
],
"collection": ["studentInfoKmnsDoo"]
}
}
В запросе добавлены параметры отчета:
- attestPeriod - период аттестации (учебный год)
- date - отчетная дата. Актуальность данных на эту дату. Например формирование списка обучающихся в соответствии с книгой движения обучающихся.
Ответ на запрос. Сообщение об ошибке:
{
"error": "Error message"
}
Ответ на запрос. Передача данных для отчета.
{
"data": "base64"
}
где base64 это:
- Архив zip в кодировке base64
- Архив содержит файлы
- Каждый файл это коллекция. Для коллекции studentInfoKmnsDoo файл называется studentInfoKmnsDoo.json
Пример возвращаемых данных. Файл studentInfoKmnsDoo.json:
{
"studentInfoKmnsDoo": [
{
"org": "org-1105",
"kmnsNum": 3,
"studentNum": 100,
"hantyNum": 1,
"mantiNum": 1,
"nenciNum": 1
},
{
"org": "org-1106",
"kmnsNum": 6,
"studentNum": 150,
"hantyNum": 3,
"mantiNum": 2,
"nenciNum": 1
}
]
}
Схема коллекции studentInfoKmnsDoo:
{
"type": "object",
"title": "Сведения об обучающихся из числа коренных малочисленных народов Севера в ДОО",
"additionalProperties": false,
"properties": {
"org": {
"title": "Организация",
"$ref": "#/definitions/org.ref"
},
"kmnsNum": {
"title": "Число КМНС",
"type": "number"
},
"studentNum": {
"title": "Количество детей, посещающих ДОО",
"type": "number"
},
"hantyNum": {
"title": "Ханты",
"type": "number"
},
"mantiNum": {
"title": "Манти",
"type": "number"
},
"nenciNum": {
"title": "Ненци",
"type": "number"
},
"studentNumOut": {
"title": "Количество детей, не посещающих ДОО",
"type": "number"
},
"hantyNumOut": {
"title": "Ханты",
"type": "number"
},
"mantiNumOut": {
"title": "Манти",
"type": "number"
},
"nenciNumOut": {
"title": "Ненци",
"type": "number"
},
"studentNumCamp": {
"title": "стойбищах",
"type": "number"
},
"hantyNumCamp": {
"title": "Ханты",
"type": "number"
},
"mantiNumCamp": {
"title": "Манти",
"type": "number"
},
"nenciNumCamp": {
"title": "Ненци",
"type": "number"
},
"hasNativeLanguage": {
"title": "изучается родной язык",
"type": "boolean"
},
"kmnsNumNativeLanguage": {
"title": "Количество детей КМНС, изучающих родной язык",
"type": "number"
},
"pedNumNativeLanguage": {
"title": "Количество педагогов, использующих родной язык в образовательной деятельности",
"type": "number"
},
"hasNativeLiterature": {
"title": "изучается родная литература",
"type": "number"
},
"kmnsNumNativeLiterature": {
"title": "Количество детей КМНС, изучающих родную литературу",
"type": "number"
},
"pupilPlanKmnsNum": {
"title": "Количество планируемых первоклассников из числа КМНС",
"type": "number"
},
},
"required": ["org"]
}