RnisAPI_TypesAndValues.ttcn 14.4 KB
Newer Older
Yann Garcia's avatar
Yann Garcia committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
/**
 * @desc The ETSI MEC ISG MEC012 Radio Network Information API described using OpenAPI
 * @see http://www.etsi.org/deliver/etsi_gs/MEC/001_099/012/01.01.01_60/gs_mec012v010101p.pdf
 */
module RnisAPI_TypesAndValues {
  
  // LibCommon
  import from LibCommon_BasicTypesAndValues all;
  
  /**
   * @desc 
   * @member type_ A URI reference according to IETF RFC 3986 that identifies the problem type
   * @member title A short, human-readable summary of the problem type
   * @member status The HTTP status code for this occurrence of the problem
   * @member detail A human-readable explanation specific to this occurrence of the problem
   * @member instance A URI reference that identifies the specific occurrence of the problem
   */
  type record ProblemDetails {
    universal charstring type_,
    universal charstring title,
    UInt32 status,
    universal charstring detail,
    universal charstring instance
  } with {
    variant (type_) "name as 'type'";
  }

  /**
   * @desc 
   * @member timeStamp
   * @member appInsId
   * @member ecgi
   */
  type record PlmnInfo {
    TimeStamp timeStamp optional,
    AppInsId appInsId,
    Ecgi ecgi
  }

  type unsiversal charstring AppInsId;

  /**
   * @desc 
   * @member timeStamp
   * @member appInsId
   * @member requestId
   * @member cellUserInfo
   */
  type record RabInfo {
    TimeStamp timeStamp optional,
    AppInsId appInsId,
    RequestId requestId,
    CellUserInfo cellUserInfo optional
  }

  /**
   * @desc 
   * @member timeStamp
   * @member appInsId
   * @member ecgi
   */
  type record S1BearerInfo {
    TimeStamp timeStamp optional,
    S1UeInfo s1UeInfo
  }

  /**
   * @desc The information on users per cell
   * @member tempUeId
   * @member associateId
   * @member ecgi
   * @member s1BearerInfoDetailed
   */
  type record S1UeInfo {
   TempUeId tempUeId,
   AssociateId associateId optional,
   Ecgi ecgi,
   S1BearerInfoDetailed s1BearerInfoDetailed
  }

  /**
   * @desc Information on UEs in the specific cell
   * @member erabId The element that uniquely identifies a S1 bearer for a specific UE, as defined in ETSI TS 136 413
   * @member s1EnbInfo
   * @member sGwInfo
   */
  type record S1BearerInfoDetailed {
    ErabId erabId,
    S1EnbInfo s1EnbInfo,
    SGwInfo sGwInfo
  }

  type UInt32 ErabId;

  /**
   * @desc 
   * @member mmec MMEC as defined in ETSI TS 136 413
   * @member mtmsi M-TMSI as defined in ETSI TS 136 413
   */
  type record TempUeId {
    Mmec mmec,
    Mtmsi mtmsi
  }

  type universal charstring Mmec;

  type universal charstring Mtmsi;

  /**
   * @desc 
   * @member ipAddress eNB transport layer address of this S1 bearer
   * @member tunnelId eNB GTP-U TEID of this S1 bearer
   */
  type record S1EnbInfo {
    universal charstring ipAddress,
    universal charstring tunnelId
  }

  /**
   * @desc 
   * @member ipAddress SGW transport layer address of this S1 bearer
   * @member tunnelId SGW GTP-U TEID of this S1 bearer
   */
  type record SGwInfo {
    universal charstring ipAddress,
    universal charstring tunnelId
  }

  /**
   * @desc
   * @member seconds The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   * @member nanoSeconds The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
   */
  type record TimeStamp {
    UInt32 seconds,
    UInt32 nanoSeconds
  }

  /**
   * @desc Unique identifier for the mobile edge application instance",
   */
  type universal charstring AppInsId;

  /**
   * @desc Unique identifier allocated by the Mobile Edge application for the  Information request
   */
  type universal charstring RequestId;

  /**
   * @desc The information on users per cell
   * @member ecgi 
   * @member ueInfo
   */
  type record CellUserInfo {
    Ecgi ecgi,
    UeInfo ueInfo
  }

  /**
   * @desc E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413
   * @member ecgi 
   * @member ueInfo
   */
  type record Ecgi {
    Plmn plmn,
    CellId cellId
  }

  /**
   * @desc E-UTRAN CelI Global Identifier as defined in 3GPP TS 36.413
   * @member mcc The Mobile Country Code part of PLMN Identity as defined in 3GPP TS 36.413
   * @member mnc The Mobile Network Code part of PLMN Identity as defined in 3GPP TS 36.413
   */
  type record Plmn {
    universal charstring mcc,
    universal charstring mnc
  }

  /**
   * @desc The E-UTRAN Cell Identity as a bit string (size (28)), as defined in 3GPP TS 36.413
   */
  type record of octetstring CellId;

  /**
   * @desc Information on UEs in the specific cell
   * @member associateId
   * @member erabInfo
   */
  type record UeInfo {
    record of AssociateId associateId optional,
    record of ErabQosParameters erabInfo
  }

  /**
   * @desc Information on UEs in the specific cell
   * @member type Numeric value (0-255) corresponding to specified type of identifier
   * @member value Value for the identifier
   */
  type record AssociateId {
    AssociateId_type type_,
    UInt32 value_
  } with {
    variant (type_) "name as 'type'";
    variant (value_) "name as 'value'";
  }

  /**
   * @desc Numeric value (0-255) corresponding to specified type of identifier
   */
  type enumerated AssociateId_type {
    "RESERVED",
    "UE_IPV4_ADDRESS",
    "UE_IPV6_ADDRESS",
    "NATED_IP_ADDRESS",
    "GTP_TEID"
  }
  
  /**
   * @desc 
   * @member qci QoS Class Identifier as defined in TS 23.401
   * @member qci_information 
   */
  type record ErabQosParameters {
    UInt32 qci,
    QosInformation qci_information
  }
  
  /**
   * @desc 
   * @member erabGbrDl This IE indicates the maximum downlink E-RAB Bit Rate as defined in TS 23.401 for this bearer
   * @member erabGbrUl This IE indicates the maximum uplink E-RAB Bit Rate as defined in TS 23.401 for this bearer
   * @member erabGbrDl This IE indicates the guaranteed  downlink E-RAB Bit Rate as defined in TS 23.401 for this bearer
   * @member erabMbrUl This IE indicates the guaranteed  uplink E-RAB Bit Rate as defined in TS 23.401 for this bearer
   */
  type enumerated QosInformation {
    "erabGbrDl",
    "erabGbrUl",
    "erabMbrDl",
    "erabMbrUl"
  }

  /**
   * @desc 
   * @member _links
   * @member subscription 
   */
  type record SubscriptionLinkList {
    Link _links,
    Subscription subscription optional {
  }

  /**
   * @desc 
   * @member callbackReference 
   * @member filterCriteria 
   * @member expiryDeadline 
   */
  type record MeasRepUeSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssocTri filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record MeasRepUeSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocTri filterCriteria,
    TimeStamp expiryDeadline optional
  }
  
  /**
   * @desc
   * @member callbackReference
   * @member eventType
   * @member s1BearerSubscriptionCriteria
   * @member expiryDeadline
   */
  type record S1BearerSubscriptionPost {
    CallbackReference callbackReference,
    EventType eventType,
    S1BearerSubscriptionCriteria s1BearerSubscriptionCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member s1BearerSubscriptionCriteria
   * @member expiryDeadline
   */
  type record S1BearerSubscription {
    CallbackReference callbackReference,
    Link _links,
    S1BearerSubscriptionCriteria s1BearerSubscriptionCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   */
  type record RabEstSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocQci filterCriteria
  }
  
  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record RabEstSubscriptionPost {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocQci filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record RabModSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocQci filterCriteria,
    TimeStamp expiryDeadline optional
  }
  
  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record RabModSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssocQci filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record RabRelSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocQci filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record RabRelSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssocQci filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record CaReConfSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssoc filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record CaReConfSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssoc filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record CellChangeSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssocHo filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record CellChangeSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocHo filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record MeasTaSubscriptionPost {
    CallbackReference callbackReference,
    FilterCriteriaAssoc filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc
   * @member callbackReference
   * @member _links
   * @member filterCriteria
   * @member expiryDeadline
   */
  type record MeasTaSubscription {
    CallbackReference callbackReference,
    Link _links,
    FilterCriteriaAssocHo filterCriteria,
    TimeStamp expiryDeadline optional
  }

  /**
   * @desc URL selected by the Mobile Edge application to receive notifications on the subscribed RNIS information
   */
  type universal charstring CallbackReference;

  /**
   * @desc List of hyperlinks related to the resource
   * @member self_ URI referring to a resource
   */
  type record Link {
    LinkType self_,
Yann Garcia's avatar
Yann Garcia committed
474
475
  } with {
    variant (self_) "name as 'self'";
Yann Garcia's avatar
Yann Garcia committed
476
477
478
479
480
481
482
483
484
485
486
487
488
  }

  /**
   * @desc URI referring to a resource
   */
  type universal charstring LinkType;

  /**
   * @desc A link to a subscription
   * @member 
   * @member 
   */
  type record Subscription {
Yann Garcia's avatar
Yann Garcia committed
489
    LinkType href,
Yann Garcia's avatar
Yann Garcia committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
    SubscriptionType subscriptionType
  }

  /**
   * @desc Numeric value corresponding to specified type of subscription
   * @member 
   * @member 
   * @member 
   * @member 
   * @member 
   * @member 
   */
  type enumerated SubscriptionType {
    "RESERVED",
    "CELL_CHANGE",
    "RAB_ESTABLISHMENT",
    "RAB_MODIFICATION",
    "RAB_RELEASE",
    "MEAS_REPORT_UE",
    "MEAS_TIMING_ADVANCE",
    "CA_RECONF",
    "S1_BEARE"
  }

  /**
   * @desc List of filtering criteria for the subscription
   * @member appInsId 
   * @member associateId
   * @member plmn
   * @member cellId
   */
  type record FilterCriteriaAssoc {
    AppInsId appInsId,
    AssociateId associateId,
    Plmn plmn,
    CellId cellId
  }

  /**
   * @desc List of filtering criteria for the subscription
   * @member appInsId 
   * @member associateId
   * @member plmn
   * @member cellId
   * @member qci
   */
  type record FilterCriteriaAssocQci {
    AppInsId appInsId,
    AssociateId associateId,
    Plmn plmn,
    CellId cellId,
    Qci qci
  }
  
  /**
   * @desc List of filtering criteria for the subscription
   * @member appInsId 
   * @member associateId
   * @member plmn
   * @member cellId
   * @member hoStatus
   */
  type record FilterCriteriaAssocHo {
    AppInsId appInsId,
    AssociateId associateId,
    Plmn plmn,
    CellId cellId,
    HoStatus hoStatus
  }

  /**
   * @desc List of filtering criteria for the subscription
   * @member appInsId 
   * @member associateId
   * @member plmn
   * @member cellId
   * @member trigger
   */
  type record FilterCriteriaAssocHo {
    AppInsId appInsId,
    AssociateId associateId,
    Plmn plmn,
    CellId cellId,
    Trigger trigger_
Yann Garcia's avatar
Yann Garcia committed
574
575
  } with {
    variant (trigger_) "name as 'trigger'";
Yann Garcia's avatar
Yann Garcia committed
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
  }

  /**
   * @desc List of filtering criteria for the subscription
   * @member appInsId 
   * @member associateId
   * @member plmn
   * @member cellId
   * @member trigger
   */
  type record FilterCriteriaAssocHo {
    AssociateId associateId,
    Plmn plmn,
    CellId cellId,
    Trigger trigger_
Yann Garcia's avatar
Yann Garcia committed
591
592
  } with {
    variant (trigger_) "name as 'trigger'";
Yann Garcia's avatar
Yann Garcia committed
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
  }

  /**
   * @desc Description of the subscribed to event
   */
  type enumerated HoStatus {
    "RESERVED",
    "IN_PREPARATION",
    "IN_EXECUTION",
    "COMPLETED",
    "REJECTED",
    "CANCELLED"
  }

  /**
   * @desc Description of the subscribed event
   */
  type enumerated EventType {
    "RESERVED",
    "S1_BEARER_ESTABLISH",
    "S1_BEARER_MODIFY",
    "S1_BEARER_RELEASE"
  }
  
  /**
   * @desc Unique identifier for the mobile edge application instance
   */
  type enumerated Trigger {
    "NOT_AVAILABLE",
    "PERIODICAL_REPORT_STRONGEST_CELLS",
    "PERIODICAL_REPORT_STRONGEST_CELLS_FOR_SON",
    "PERIODICAL_REPORT_CGI",
    "EVENT_A1",
    "EVENT_A2",
    "EVENT_A3",
    "EVENT_A4",
    "EVENT_A5",
    "EVENT_A6",
    "EVENT_B1",
    "EVENT_B2",
    "EVENT_C1",
    "EVENT_C2",
    "EVENT_W1",
    "EVENT_W2",
    "EVENT_W3"
  }
  
} with {
  encode "JSON"
} // End of module RnisAPI_TypesAndValues