Merge "[RICPLT-2787] Complete automation tests for US"
[ric-plt/e2mgr.git] / Swagger / E2Manager_API.yaml
1 # ========================LICENSE_START=================================
2 # O-RAN-SC
3 #
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
9 #
10 #      http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ========================LICENSE_END===================================
18
19 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
20 # platform project (RICP).
21
22
23 openapi: 3.0.0
24 info:
25   title: E2 Manager Service
26   description: E2 Manager Service APIs
27   version: 3.0.3
28 servers:
29   - url: 'http://{apiRoot}/v1'
30     variables:
31       apiRoot:
32         default: 'localhost:3800'
33 paths:
34   /nodeb/x2-setup:
35     post:
36       summary: X2 Setup
37       tags:
38         - nodeb
39       operationId: x2Setup
40       requestBody:
41         content:
42           application/json:
43             schema:
44               $ref: '#/components/schemas/SetupRequest'
45         required: true
46       responses:
47         '200':
48           description: Success
49         '400':
50           description: Invalid input
51           content:
52             application/problem+json:
53               schema:
54                 $ref: '#/components/schemas/ErrorResponse'
55         '500':
56           description: Internal error
57           content:
58             application/problem+json:
59               schema:
60                 $ref: '#/components/schemas/ErrorResponse'
61   /nodeb/endc-setup:
62     post:
63       tags:
64         - nodeb
65       summary: ENDC Setup
66       operationId: endcSetup
67       requestBody:
68         content:
69           application/json:
70             schema:
71               $ref: '#/components/schemas/SetupRequest'
72         required: true
73       responses:
74         '200':
75           description: Success
76         '400':
77           description: Invalid input
78           content:
79             application/json:
80               schema:
81                 $ref: '#/components/schemas/ErrorResponse'
82         '500':
83           description: Internal Error
84           content:
85             application/problem+json:
86               schema:
87                 $ref: '#/components/schemas/ErrorResponse'
88   '/nodeb/{ranName}':
89     get:
90       tags:
91         - nodeb
92       summary: Get RAN by name
93       operationId: getNb
94       parameters:
95         - name: ranName
96           in: path
97           required: true
98           description: Name of RAN to return
99           schema:
100             type: string
101       responses:
102         '200':
103           description: Successful operation
104           content:
105             application/json:
106               schema:
107                 $ref: '#/components/schemas/GetNodebResponse'
108         '400':
109           description: The specified RAN name is invalid
110           content:
111             application/json:
112               schema:
113                 $ref: '#/components/schemas/ErrorResponse'
114         '404':
115           description: A RAN with the specified name was not found
116           content:
117             application/problem+json:
118               schema:
119                 $ref: '#/components/schemas/ErrorResponse'
120         '500':
121           description: Internal Error
122           content:
123             application/problem+json:
124               schema:
125                 $ref: '#/components/schemas/ErrorResponse'
126   /nodeb/shutdown:
127     put:
128       tags:
129         - nodeb
130       summary: >-
131         Close all connections to the RANs
132       responses:
133         '204':
134           description: Successful operation
135         '500':
136           description: Internal Error
137           content:
138             application/problem+json:
139               schema:
140                 $ref: '#/components/schemas/ErrorResponse'
141   /nodeb/ids:
142     get:
143       tags:
144         - nodeb
145       summary: Get RANs identities list
146       operationId: getNodebIdList
147       responses:
148         '200':
149           description: Successful operation
150           content:
151             application/json:
152               schema:
153                 type: array
154                 items:
155                   $ref: '#/components/schemas/NodebIdentity'
156         '500':
157           description: Internal Error
158           content:
159             application/problem+json:
160               schema:
161                 $ref: '#/components/schemas/ErrorResponse'
162   /nodeb/{ranName}/reset:
163     put:
164       tags:
165         - nodeb
166       summary: >-
167         Upon receipt of this message, 'ranName' shall abort any other ongoing procedures over X2 between the RIC and the RAN. The RAN shall delete all the context information related to the RIC, except the application level configuration data exchanged during the X2 Setup or eNB Configuration Update procedures, and release the corresponding resource.  
168       operationId: reset
169       parameters:
170         - name: ranName
171           in: path
172           required: true
173           description: Name of RAN to return
174           schema:
175             type: string
176       requestBody:
177         content:
178           application/json:
179             schema:
180               $ref: '#/components/schemas/ResetRequest'
181         required: false
182       responses:
183         '204':
184           description: Successful operation
185         '400':
186           description: Invalid input (invalid cause, RAN in wrong state)
187           content:
188             application/problem+json:
189               schema:
190                 $ref: '#/components/schemas/ErrorResponse'
191         '404':
192           description: A RAN with the specified name was not found
193           content:
194             application/problem+json:
195               schema:
196                 $ref: '#/components/schemas/ErrorResponse'
197         '500':
198           description: Internal Error
199           content:
200             application/problem+json:
201               schema:
202                 $ref: '#/components/schemas/ErrorResponse'
203
204   /health:
205     get:
206       tags:
207         - Health Check
208       summary: E2 Manager Service Health Check
209       responses:
210         '200':
211           description: OK
212   /e2t/list:
213     get:
214       tags:
215         - e2t
216       summary: Gets a list of all E2T Instances address and their associated RANs
217       responses:
218         '200':
219           description: Successful operation
220           content:
221             application/json:
222               schema:
223                 type: array
224                 items:
225                   $ref: '#/components/schemas/E2tIdentity'
226         '500':
227           description: Internal Error
228           content:
229             application/problem+json:
230               schema:
231                 $ref: '#/components/schemas/ErrorResponse'
232 components:
233   schemas:
234     SetupRequest:
235       type: object
236       required:
237         - ranIp
238         - ranPort
239         - ranName
240       properties:
241         ranIp:
242           type: string
243         ranPort:
244           type: integer
245           format: uint16
246         ranName:
247           type: string
248     ResetRequest:
249       type: object
250       required:
251         - cause
252       properties:
253         cause:
254           type: string
255           enum: [misc:control-processing-overload,
256 misc:hardware-failure,
257 misc:om-intervention,
258 misc:not-enough-user-plane-processing-resources,
259 misc:unspecified,
260 protocol:transfer-syntax-error,
261 protocol:abstract-syntax-error-reject,
262 protocol:abstract-syntax-error-ignore-and-notify,
263 protocol:message-not-compatible-with-receiver-state,
264 protocol:semantic-error,
265 protocol:unspecified,
266 protocol:abstract-syntax-error-falsely-constructed-message,
267 transport:transport-resource-unavailable,
268 transport:unspecified,
269 radioNetwork:handover-desirable-for-radio-reasons,
270 radioNetwork:time-critical-handover,
271 radioNetwork:resource-optimisation-handover,
272 radioNetwork:reduce-load-in-serving-cell,
273 radioNetwork:partial-handover,
274 radioNetwork:unknown-new-eNB-UE-X2AP-ID, 
275 radioNetwork:unknown-old-eNB-UE-X2AP-ID, 
276 radioNetwork:unknown-pair-of-UE-X2AP-ID,
277 radioNetwork:ho-target-not-allowed,
278 radioNetwork:tx2relocoverall-expiry,
279 radioNetwork:trelocprep-expiry,
280 radioNetwork:cell-not-available,
281 radioNetwork:no-radio-resources-available-in-target-cell,
282 radioNetwork:invalid-MME-GroupID,
283 radioNetwork:unknown-MME-Code,
284 radioNetwork:encryption-and-or-integrity-protection-algorithms-not-supported,
285 radioNetwork:reportCharacteristicsEmpty,
286 radioNetwork:noReportPeriodicity,
287 radioNetwork:existingMeasurementID,
288 radioNetwork:unknown-eNB-Measurement-ID,
289 radioNetwork:measurement-temporarily-not-available,
290 radioNetwork:unspecified,
291 radioNetwork:load-balancing,
292 radioNetwork:handover-optimisation,
293 radioNetwork:value-out-of-allowed-range,
294 radioNetwork:multiple-E-RAB-ID-instances,
295 radioNetwork:switch-off-ongoing,
296 radioNetwork:not-supported-QCI-value,
297 radioNetwork:measurement-not-supported-for-the-object,
298 radioNetwork:tDCoverall-expiry,
299 radioNetwork:tDCprep-expiry,
300 radioNetwork:action-desirable-for-radio-reasons,
301 radioNetwork:reduce-load,
302 radioNetwork:resource-optimisation,
303 radioNetwork:time-critical-action,
304 radioNetwork:target-not-allowed,
305 radioNetwork:no-radio-resources-available,
306 radioNetwork:invalid-QoS-combination,
307 radioNetwork:encryption-algorithms-not-aupported,
308 radioNetwork:procedure-cancelled,
309 radioNetwork:rRM-purpose,
310 radioNetwork:improve-user-bit-rate,
311 radioNetwork:user-inactivity,
312 radioNetwork:radio-connection-with-UE-lost,
313 radioNetwork:failure-in-the-radio-interface-procedure,
314 radioNetwork:bearer-option-not-supported,
315 radioNetwork:mCG-Mobility,
316 radioNetwork:sCG-Mobility,
317 radioNetwork:count-reaches-max-value,
318 radioNetwork:unknown-old-en-gNB-UE-X2AP-ID,
319 radioNetwork:pDCP-Overload]
320     NodebIdentity:
321       properties:
322         globalNbId:
323           properties:
324             nbId:
325               type: string
326             plmnId:
327               type: string
328           type: object
329         inventoryName:
330           type: string
331       type: object
332     GetNodebResponse:
333       properties:
334         connectionStatus:
335           oneOf:
336             - type: string
337             - type: integer
338         enb:
339           properties:
340             enbType:
341               oneOf:
342                 - type: string
343                 - type: integer
344             guGroupIds:
345               items:
346                 type: string
347               type: array
348             servedCells:
349               items:
350                 properties:
351                   bandwidthReducedSi:
352                     oneOf:
353                       - type: string
354                       - type: integer
355                   broadcastPlmns:
356                     items:
357                       type: string
358                     type: array
359                   cellId:
360                     type: string
361                   choiceEutraMode:
362                     properties:
363                       fdd:
364                         properties:
365                           dlTransmissionBandwidth:
366                             oneOf:
367                               - type: string
368                               - type: integer
369                           dlearFcn:
370                             type: integer
371                           ulTransmissionBandwidth:
372                             oneOf:
373                               - type: string
374                               - type: integer
375                           ulearFcn:
376                             type: integer
377                         additionalProperties: false
378                         type: object
379                       tdd:
380                         properties:
381                           additionalSpecialSubframeExtensionInfo:
382                             properties:
383                               additionalSpecialSubframePatternsExtension:
384                                 oneOf:
385                                   - type: string
386                                   - type: integer
387                               cyclicPrefixDl:
388                                 oneOf:
389                                   - type: string
390                                   - type: integer
391                               cyclicPrefixUl:
392                                 oneOf:
393                                   - type: string
394                                   - type: integer
395                             additionalProperties: false
396                             type: object
397                           additionalSpecialSubframeInfo:
398                             properties:
399                               additionalSpecialSubframePatterns:
400                                 oneOf:
401                                   - type: string
402                                   - type: integer
403                               cyclicPrefixDl:
404                                 oneOf:
405                                   - type: string
406                                   - type: integer
407                               cyclicPrefixUl:
408                                 oneOf:
409                                   - type: string
410                                   - type: integer
411                             additionalProperties: false
412                             type: object
413                           earFcn:
414                             type: integer
415                           specialSubframeInfo:
416                             properties:
417                               cyclicPrefixDl:
418                                 oneOf:
419                                   - type: string
420                                   - type: integer
421                               cyclicPrefixUl:
422                                 oneOf:
423                                   - type: string
424                                   - type: integer
425                               specialSubframePatterns:
426                                 oneOf:
427                                   - type: string
428                                   - type: integer
429                             additionalProperties: false
430                             type: object
431                           subframeAssignment:
432                             oneOf:
433                               - type: string
434                               - type: integer
435                           transmissionBandwidth:
436                             oneOf:
437                               - type: string
438                               - type: integer
439                         additionalProperties: false
440                         type: object
441                     additionalProperties: false
442                     type: object
443                   csgId:
444                     type: string
445                   eutraMode:
446                     oneOf:
447                       - type: string
448                       - type: integer
449                   freqBandIndicatorPriority:
450                     oneOf:
451                       - type: string
452                       - type: integer
453                   mbmsServiceAreaIdentities:
454                     items:
455                       type: string
456                     type: array
457                   mbsfnSubframeInfos:
458                     items:
459                       properties:
460                         radioframeAllocationOffset:
461                           type: integer
462                         radioframeAllocationPeriod:
463                           oneOf:
464                             - type: string
465                             - type: integer
466                         subframeAllocation:
467                           type: string
468                         subframeAllocationType:
469                           oneOf:
470                             - type: string
471                             - type: integer
472                       additionalProperties: false
473                       type: object
474                     type: array
475                   multibandInfos:
476                     items:
477                       type: integer
478                     type: array
479                   neighbourInfos:
480                     items:
481                       properties:
482                         earFcn:
483                           type: integer
484                         ecgi:
485                           type: string
486                         pci:
487                           type: integer
488                         tac:
489                           type: string
490                       additionalProperties: false
491                       type: object
492                     type: array
493                   numberOfAntennaPorts:
494                     oneOf:
495                       - type: string
496                       - type: integer
497                   pci:
498                     type: integer
499                   prachConfiguration:
500                     properties:
501                       highSpeedFlag:
502                         type: boolean
503                       prachConfigurationIndex:
504                         type: integer
505                       prachFrequencyOffset:
506                         type: integer
507                       rootSequenceIndex:
508                         type: integer
509                       zeroCorrelationZoneConfiguration:
510                         type: integer
511                     additionalProperties: false
512                     type: object
513                   tac:
514                     type: string
515                 additionalProperties: false
516                 type: object
517               type: array
518           additionalProperties: false
519           type: object
520         failureType:
521           oneOf:
522             - type: string
523             - type: integer
524         globalNbId:
525           properties:
526             nbId:
527               type: string
528             plmnId:
529               type: string
530           additionalProperties: false
531           type: object
532         gnb:
533           properties:
534             servedNrCells:
535               items:
536                 properties:
537                   nrNeighbourInfos:
538                     items:
539                       properties:
540                         choiceNrMode:
541                           properties:
542                             fdd:
543                               properties:
544                                 dlarFcnFreqInfo:
545                                   properties:
546                                     frequencyBands:
547                                       items:
548                                         properties:
549                                           nrFrequencyBand:
550                                             type: integer
551                                           supportedSulBands:
552                                             items:
553                                               type: integer
554                                             type: array
555                                         additionalProperties: false
556                                         type: object
557                                       type: array
558                                     nrArFcn:
559                                       oneOf:
560                                         - type: integer
561                                     sulInformation:
562                                       properties:
563                                         sulArFcn:
564                                           oneOf:
565                                             - type: integer
566                                         sulTransmissionBandwidth:
567                                           properties:
568                                             ncnrb:
569                                               oneOf:
570                                                 - type: string
571                                                 - type: integer
572                                             nrscs:
573                                               oneOf:
574                                                 - type: string
575                                                 - type: integer
576                                           additionalProperties: false
577                                           type: object
578                                       additionalProperties: false
579                                       type: object
580                                   additionalProperties: false
581                                   type: object
582                                 ularFcnFreqInfo:
583                                   properties:
584                                     frequencyBands:
585                                       items:
586                                         properties:
587                                           nrFrequencyBand:
588                                             type: integer
589                                           supportedSulBands:
590                                             items:
591                                               type: integer
592                                             type: array
593                                         additionalProperties: false
594                                         type: object
595                                       type: array
596                                     nrArFcn:
597                                       oneOf:
598                                         - type: integer
599                                     sulInformation:
600                                       properties:
601                                         sulArFcn:
602                                           oneOf:
603                                             - type: integer
604                                         sulTransmissionBandwidth:
605                                           properties:
606                                             ncnrb:
607                                               oneOf:
608                                                 - type: string
609                                                 - type: integer
610                                             nrscs:
611                                               oneOf:
612                                                 - type: string
613                                                 - type: integer
614                                           additionalProperties: false
615                                           type: object
616                                       additionalProperties: false
617                                       type: object
618                                   additionalProperties: false
619                                   type: object
620                               additionalProperties: false
621                               type: object
622                             tdd:
623                               properties:
624                                 arFcnNrFreqInfo:
625                                   properties:
626                                     frequencyBands:
627                                       items:
628                                         properties:
629                                           nrFrequencyBand:
630                                             type: integer
631                                           supportedSulBands:
632                                             items:
633                                               type: integer
634                                             type: array
635                                         additionalProperties: false
636                                         type: object
637                                       type: array
638                                     nrArFcn:
639                                       oneOf:
640                                         - type: integer
641                                     sulInformation:
642                                       properties:
643                                         sulArFcn:
644                                           oneOf:
645                                             - type: integer
646                                         sulTransmissionBandwidth:
647                                           properties:
648                                             ncnrb:
649                                               oneOf:
650                                                 - type: string
651                                                 - type: integer
652                                             nrscs:
653                                               oneOf:
654                                                 - type: string
655                                                 - type: integer
656                                           additionalProperties: false
657                                           type: object
658                                       additionalProperties: false
659                                       type: object
660                                   additionalProperties: false
661                                   type: object
662                               additionalProperties: false
663                               type: object
664                           additionalProperties: false
665                           type: object
666                         configuredStac:
667                           type: string
668                         nrCgi:
669                           type: string
670                         nrMode:
671                           oneOf:
672                             - type: string
673                             - type: integer
674                         nrPci:
675                           type: integer
676                         stac5g:
677                           type: string
678                       additionalProperties: false
679                       type: object
680                     type: array
681                   servedNrCellInformation:
682                     properties:
683                       cellId:
684                         type: string
685                       choiceNrMode:
686                         properties:
687                           fdd:
688                             properties:
689                               dlFreqInfo:
690                                 properties:
691                                   frequencyBands:
692                                     items:
693                                       properties:
694                                         nrFrequencyBand:
695                                           type: integer
696                                         supportedSulBands:
697                                           items:
698                                             type: integer
699                                           type: array
700                                       additionalProperties: false
701                                       type: object
702                                     type: array
703                                   nrArFcn:
704                                     oneOf:
705                                       - type: integer
706                                   sulInformation:
707                                     properties:
708                                       sulArFcn:
709                                         oneOf:
710                                           - type: integer
711                                       sulTransmissionBandwidth:
712                                         properties:
713                                           ncnrb:
714                                             oneOf:
715                                               - type: string
716                                               - type: integer
717                                           nrscs:
718                                             oneOf:
719                                               - type: string
720                                               - type: integer
721                                         additionalProperties: false
722                                         type: object
723                                     additionalProperties: false
724                                     type: object
725                                 additionalProperties: false
726                                 type: object
727                               dlTransmissionBandwidth:
728                                 properties:
729                                   ncnrb:
730                                     oneOf:
731                                       - type: string
732                                       - type: integer
733                                   nrscs:
734                                     oneOf:
735                                       - type: string
736                                       - type: integer
737                                 additionalProperties: false
738                                 type: object
739                               ulFreqInfo:
740                                 properties:
741                                   frequencyBands:
742                                     items:
743                                       properties:
744                                         nrFrequencyBand:
745                                           type: integer
746                                         supportedSulBands:
747                                           items:
748                                             type: integer
749                                           type: array
750                                       additionalProperties: false
751                                       type: object
752                                     type: array
753                                   nrArFcn:
754                                     oneOf:
755                                       - type: integer
756                                   sulInformation:
757                                     properties:
758                                       sulArFcn:
759                                         oneOf:
760                                           - type: integer
761                                       sulTransmissionBandwidth:
762                                         properties:
763                                           ncnrb:
764                                             oneOf:
765                                               - type: string
766                                               - type: integer
767                                           nrscs:
768                                             oneOf:
769                                               - type: string
770                                               - type: integer
771                                         additionalProperties: false
772                                         type: object
773                                     additionalProperties: false
774                                     type: object
775                                 additionalProperties: false
776                                 type: object
777                               ulTransmissionBandwidth:
778                                 properties:
779                                   ncnrb:
780                                     oneOf:
781                                       - type: string
782                                       - type: integer
783                                   nrscs:
784                                     oneOf:
785                                       - type: string
786                                       - type: integer
787                                 additionalProperties: false
788                                 type: object
789                             additionalProperties: false
790                             type: object
791                           tdd:
792                             properties:
793                               nrFreqInfo:
794                                 properties:
795                                   frequencyBands:
796                                     items:
797                                       properties:
798                                         nrFrequencyBand:
799                                           type: integer
800                                         supportedSulBands:
801                                           items:
802                                             type: integer
803                                           type: array
804                                       additionalProperties: false
805                                       type: object
806                                     type: array
807                                   nrArFcn:
808                                     oneOf:
809                                       - type: integer
810                                   sulInformation:
811                                     properties:
812                                       sulArFcn:
813                                         oneOf:
814                                           - type: integer
815                                       sulTransmissionBandwidth:
816                                         properties:
817                                           ncnrb:
818                                             oneOf:
819                                               - type: string
820                                               - type: integer
821                                           nrscs:
822                                             oneOf:
823                                               - type: string
824                                               - type: integer
825                                         additionalProperties: false
826                                         type: object
827                                     additionalProperties: false
828                                     type: object
829                                 additionalProperties: false
830                                 type: object
831                               transmissionBandwidth:
832                                 properties:
833                                   ncnrb:
834                                     oneOf:
835                                       - type: string
836                                       - type: integer
837                                   nrscs:
838                                     oneOf:
839                                       - type: string
840                                       - type: integer
841                                 additionalProperties: false
842                                 type: object
843                             additionalProperties: false
844                             type: object
845                         additionalProperties: false
846                         type: object
847                       configuredStac:
848                         type: string
849                       nrMode:
850                         oneOf:
851                           - type: string
852                           - type: integer
853                       nrPci:
854                         type: integer
855                       servedPlmns:
856                         items:
857                           type: string
858                         type: array
859                       stac5g:
860                         type: string
861                     additionalProperties: false
862                     type: object
863                 additionalProperties: false
864                 type: object
865               type: array
866           additionalProperties: false
867           type: object
868         ip:
869           type: string
870         nodeType:
871           oneOf:
872             - type: string
873             - type: integer
874         port:
875           type: integer
876         ranName:
877           type: string
878         setupFailure:
879           properties:
880             criticalityDiagnostics:
881               properties:
882                 informationElementCriticalityDiagnostics:
883                   items:
884                     properties:
885                       ieCriticality:
886                         oneOf:
887                           - type: string
888                           - type: integer
889                       ieId:
890                         type: integer
891                       typeOfError:
892                         oneOf:
893                           - type: string
894                           - type: integer
895                     additionalProperties: false
896                     type: object
897                   type: array
898                 procedureCode:
899                   type: integer
900                 procedureCriticality:
901                   oneOf:
902                     - type: string
903                     - type: integer
904                 triggeringMessage:
905                   oneOf:
906                     - type: string
907                     - type: integer
908               additionalProperties: false
909               type: object
910             miscellaneousCause:
911               oneOf:
912                 - type: string
913                 - type: integer
914             networkLayerCause:
915               oneOf:
916                 - type: string
917                 - type: integer
918             protocolCause:
919               oneOf:
920                 - type: string
921                 - type: integer
922             timeToWait:
923               oneOf:
924                 - type: string
925                 - type: integer
926             transportLayerCause:
927               oneOf:
928                 - type: string
929                 - type: integer
930           additionalProperties: false
931           type: object
932       additionalProperties: false
933       type: object
934     ErrorResponse:
935       type: object
936       required:
937         - errorCode
938         - errorMessage
939       properties:
940         errorCode:
941           type: string
942           description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
943         errorMessage:
944           type: string
945           description: Human readable text
946     E2tIdentity:
947       type: object
948       required:
949         - e2tAddress
950         - ranNames
951       properties:
952         e2tAddress:
953           type: string
954         ranNames:
955           items:
956             type: string
957           type: array
958     E2tErrorResponse:
959       type: object
960       required:
961         - errorCode
962         - errorMessage
963       properties:
964         errorCode:
965           type: string
966           description: '500 - RNIB error, 501 - internal problem'
967         errorMessage:
968           type: string
969           description: Human readable text