RDMessage.asn 60.2 KB
Newer Older
1
RDMessage {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3) rdHeader(0) version10(10)}
2
3
4
5
6
7

DEFINITIONS IMPLICIT TAGS ::=

BEGIN

-- =============================
8
-- Object Identifier definitions
9
10
-- =============================

11
-- RetainedData DomainId
12
13
retainedDataDomainId OBJECT IDENTIFIER ::= {itu-t(0) identified-organization(4) etsi(0) securityDomain(2) retainedData(3)}

14
-- rdHeader
15
rdHeaderId OBJECT IDENTIFIER ::= {retainedDataDomainId rdHeader(0) version10(10)}
16
17
18
19
20
21
22
23
24

-- ======================================
-- Top level definitions for RDHI wrapper
-- ======================================

RetainedDataMessage ::= SEQUENCE
{
	rdHeaderId				[0] OBJECT IDENTIFIER,
	retainedDataHeader		[1] RetainedDataHeader,
25
	retainedDataPayload		[2] RetainedDataPayload,
26
	retainedDataDigest		[3] OCTET STRING OPTIONAL,
27
28
		-- The digitally signed hash of the combined fields above (retainedDataHeader and
		-- retainedDataPayload)
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
	...
}
-- ==========================================================================
-- Definitions for Retained Data header information, present in every message
-- ==========================================================================

RetainedDataHeader ::= SEQUENCE
{
	requestID		[1] RequestID,
	cSPID			[2] CSPID,
	timeStamp		[3] GeneralizedTime,
	thirdPartyCSPID	[4] CSPID OPTIONAL,
	...
}

CSPID ::= UTF8String
	-- Unique identifier for the CSP that issued the request

RequestID ::= SEQUENCE
{
	countryCode					[1] CountryCode,
	authorisedOrganisationID	[2] AuthorisedOrganisationID,
	requestNumber				[3] RequestNumber OPTIONAL,
		-- all messages except GetStatusMessage and StatusMessage have a request number
		-- (see clause 6.1.2)
	...
}

CountryCode ::= UTF8String (SIZE(2))
-- A country code as per ISO 3166-1 [4]

AuthorisedOrganisationID::= UTF8String
-- A unique identifier for an Authorized Organization issuing a Retained Data request

RequestNumber ::= UTF8String
-- Unique within a given country and Authorized Organization

-- =================================================
-- Definitions for Retained Data payload information
-- =================================================

RetainedDataPayload ::= CHOICE
	-- Payload can be a request, response, error or acknowledgement
{
73
74
75
76
77
78
79
80
81
82
	requestMessage				[1] RequestMessage,
	requestAcknowledgement		[2] RequestAcknowledgement,
	responseMessage				[3] ResponseMessage,
	responseAcknowledgement		[4] ResponseAcknowledgement,
	errorMessage				[5] FurtherInformation,
	cancelMessage				[6] CancelMessage,
	cancelAcknowledgement		[7] CancelAcknowledgement,
	getstatusMessage			[8] GetStatusMessage,
	statusMessage				[9] StatusMessage,
	getResultsMessage			[10] GetResultsMessage,
83
84
85
	...,
	supplementaryRequest		[11] SupplementaryRequest,
	supplementaryResponse		[12] SupplementaryResponse
86
87
88
89
90
91
92
93
}

-- ==================================================
-- Definitions of Request message and acknowledgement
-- ==================================================

RequestMessage ::= SEQUENCE
{
94
95
96
	requestPriority				[1] RequestPriority OPTIONAL,
	requestParameters			[2] RequestConstraints OPTIONAL,
		-- Optional only in case a warrant is transmitted independently of a request
97
98
99
100
101
	deliveryPointHIB			[3] DeliveryPointHIB OPTIONAL,
		-- pre-arranged set of delivery address(es) of that specific Authorized Organization
	maxHits						[4] INTEGER OPTIONAL,
		-- Maximum number of records to be returned.
		-- On a national basis maximum numbers could be considered
102
103
		-- In case of maxHit a responseFailed message is sent and no data is sent 
		-- (see clause 6.3.3.2)
104
	nationalRequestParameters	[5] NationalRequestParameters OPTIONAL,
105
106
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
107
		-- or to transmit a warrant.
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
	...
}

DeliveryPointHIB ::= UTF8String

RequestConstraints ::= SEQUENCE
{
	equals					[1] RetainedDataRecord OPTIONAL,
	notEqualTo				[2] RetainedDataRecord OPTIONAL,
	lessThan				[3] RetainedDataRecord OPTIONAL,
		-- For numerical values
	lessThanOrEqualTo		[4] RetainedDataRecord OPTIONAL,
		-- For numerical values
	greaterThan				[5] RetainedDataRecord OPTIONAL,
		-- For numerical values
	greaterThanOrEqualTo	[6] RetainedDataRecord OPTIONAL,
		-- For numerical values
	startsWith				[7] RetainedDataRecord OPTIONAL,
		-- For strings
	endsWith				[8] RetainedDataRecord OPTIONAL,
		-- For strings
	isAMemberOf				[9] SEQUENCE OF RetainedDataRecord OPTIONAL,
	...
}

RequestPriority ::= OCTET STRING
	-- Priority considerations are a matter for national implementation
	-- This standard makes no statement regarding how such priorities are represented or used

RequestAcknowledgement ::= SEQUENCE
{
139
	suggestedCompletionTime		[1] GeneralizedTime OPTIONAL,
140
141
		-- Indicative time that results will be ready
		-- Purely informational, not binding for either party
142
143
144
145
146
147
148
149
150
151
152
153
	...
}

-- ===================================================
-- Definitions of Response message and acknowledgement
-- ===================================================

ResponseMessage ::= SEQUENCE 
{
	responseStatus				[1] ResponseStatus,
	responsePayload				[2] SEQUENCE OF ResponseRecord OPTIONAL,
		-- Clause 6 explains use of this field
154
		-- A responseUnavailable message shall not have a responsePayload (see clause 5.3.1)
155
156
157
158
		-- The responseComplete and responseIncomplete message shall have a responsePayload
		-- If there are no responses, the responsePayload is present but has zero entries
	nationalResponsePayload		[3] NationalResponsePayload OPTIONAL,
		-- to be defined on a national basis
159
		-- only to be used in case the present document cannot fulfil the national requirements
160
161
162
	...,
	responseNumber				[4] INTEGER OPTIONAL
		-- number to identify partial results within parallel multi-part delivery
163
164
165
166
}

ResponseStatus	::= CHOICE
{
167
	responseComplete		[1] NULL,
168
		-- No further results to come
169
	responseIncomplete		[2] NULL,
170
		-- There will be at least one further response message to come
171
	responseUnavailable		[3] NULL,
172
		-- See clause 5.3.1
173
	responseFailed			[4] FurtherInformation,
174
		-- See clauses 6.2.2.2 and 6.3.3.2
175
176
177
178
179
180
181
182
	...
}

ResponseRecord	::= SEQUENCE
{
	recordNumber				[1] INTEGER,
	recordPayload				[2] RetainedDataRecord,
	additionalInformation		[3] AdditionalInformation OPTIONAL,
183
		 -- see clause 6.2.4
184
	nationalRecordPayload		[4] NationalRecordPayload OPTIONAL,
185
186
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
187
188
189
190
191
192
193
194
195
196
197
198
199
200
	...
}

AdditionalInformation ::= SEQUENCE
{
	contactInformation		[1] UTF8String OPTIONAL,
		-- Name or address of operator or person who may have further information
	otherInformation		[2] UTF8String OPTIONAL,
	...
}

RetainedDataRecord ::= CHOICE
{
	telephonyRecord		[1] TelephonyRecord,
201
	-- Details are defined in Annex B
202
	messageRecord		[2] MessageRecord,
203
	-- Details are defined in Annex C
204
	networkAccess		[3] NetworkAccessRecord,
205
206
207
208
209
	-- Details are defined in Annex E
	...,
	multimediaRecord	[4] MultimediaRecord
	-- Details are defined in Annex D
		-- Other services will be included (as they are implemented)
210
211
212
213
}

ResponseAcknowledgement ::= CHOICE
{
214
215
	-- Acknowledges a response has been sent
	acknowledgeCompleteResults		[1] NULL,
216
	acknowledgePartialResults		[2] NULL,
217
218
219
	...,
	acknowledgePartialResultsNumber	[3] INTEGER
	-- number to acknowledge a specific resultMessage within parallel multi-part delivery
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
}

-- ==================================================
-- Definitions of an error message and acknowledgment
-- ==================================================

FurtherInformation ::= SEQUENCE
{
	information			[1] UTF8String,
	contactInformation	[2] UTF8String OPTIONAL,
	...
}

-- ===================================================
-- Definitions of a cancel message and acknowledgement
-- ===================================================

CancelMessage ::= NULL
	-- Cancels an active request

CancelAcknowledgement ::= NULL
	-- Acknowledges the receipt of a cancel message (no other information required)

-- ===================================================
-- Definitions of status request and response messages
-- ===================================================

GetStatusMessage ::= SEQUENCE
{
	requestNumbers		[1] SEQUENCE OF RequestNumber,
	...
}

StatusMessage ::= SEQUENCE
{
	statusResponse		[1] SEQUENCE OF StatusResponse,
	...
}

StatusResponse ::= SEQUENCE
{
261
262
	requestNumber		[1] RequestNumber,
	requestStatus		[2] RequestStatus,
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
	...
}

RequestStatus ::= CHOICE
{
	ready						[1] NULL,
	incompleteResultsReady		[2] NULL,
	failureResponseReady		[3] NULL,
	notReady					[4] NULL,
	error						[5] FurtherInformation,
	inDelivery					[6] NULL,
	invalidRequestID			[7] NULL,
	...
}

-- ==========================================
-- Definitions of status get results messages
-- ==========================================

GetResultsMessage ::= NULL
	-- No further information required (the RequestID is given in the header)

-- ===================
-- National parameters
-- ===================

NationalRequestParameters ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- Country Code according to ISO 3166-1 [4],
		-- the country to which the parameters inserted after the extension marker apply.
	...
		-- In case a given country wants to use additional national parameters according to its law,
		-- these national parameters should be defined using the ASN.1 syntax and added after the
		-- extension marker (...).
		-- It is recommended that an version indicator is included in the national parameters 
		-- definition.
}

NationalResponsePayload ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
	...
}

NationalRecordPayload ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
	...
}
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
SupplementaryRequest ::= CHOICE
{
	nationalSupplementaryRequest	[1] NationalSupplementaryRequest,
	...
}

SupplementaryResponse ::= CHOICE
{
	nationalSupplementaryResponse	[1] NationalSupplementaryResponse,
	...
}

NationalSupplementaryRequest ::= SEQUENCE
{
	countryCode [1] UTF8String (SIZE (2)),
		-- Country Code according to ISO 3166-1 [4],
		-- the country to which the parameters inserted after the extension marker apply.
	...
		-- In case a given country wants to use additional national parameters according to its law,
		-- these national parameters should be defined using the ASN.1 syntax and added after the
		-- extension marker (...).
		-- It is recommended that a version indicator is included.
}

NationalSupplementaryResponse ::= SEQUENCE
{
	countryCode [1] UTF8String (SIZE (2)),
		-- Country Code according to ISO 3166-1 [4],
		-- the country to which the parameters inserted after the extension marker apply.
	...
		-- In case a given country wants to use additional national parameters according to its law,
		-- these national parameters should be defined using the ASN.1 syntax and added after the
		-- extension marker (...).
		-- It is recommended that a version indicator is included.
}
351
352
353
354
TimeSpan ::= SEQUENCE
{
	startTime		[1] GeneralizedTime OPTIONAL,
	endTime			[2] GeneralizedTime OPTIONAL,
355
356
357
	...,
	durationTime	[3] INTEGER OPTIONAL
		-- duration in seconds
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
}

-- ==============================================
-- Definitions for Generic Subscriber Information
-- ==============================================

GenericSubscriberInfo ::= SEQUENCE
{
	organizationInfo	[1] OrganizationInfo OPTIONAL,
	individualInfo		[2] IndividualInfo OPTIONAL,
	...
}

OrganizationInfo ::= SEQUENCE
{
	name					[1] UTF8String OPTIONAL,
		-- name of the organization
	contactDetails			[2] ContactDetails OPTIONAL,
		-- address, and name/phone number of a point of contact
	nationalRegistrationID	[3] UTF8String OPTIONAL,
		-- e.g. social security number
	...
}

IndividualInfo ::= SEQUENCE
{
	name					[1] PersonName OPTIONAL,
	contactAddress			[2] ContactDetails OPTIONAL,
	dateOfBirth				[3] GeneralizedTime OPTIONAL,
	gender					[4] ENUMERATED
	{
		male(0),
		female(1),
		...
	} OPTIONAL,
	identificationNumber	[5] UTF8String OPTIONAL,
394
395
	authenticationInfo		[6] AuthenticationInfo OPTIONAL,
	...,
396
	profession				[7] UTF8String OPTIONAL
397
398
}

399
PersonName ::= SEQUENCE
400
{
401
402
403
404
405
406
407
408
	salutation				[1] UTF8String OPTIONAL,
	surname					[2] UTF8String OPTIONAL,
		-- the non-chosen or inherited name of an individual, e.g. "Arend"
	surnamePrefix			[3] UTF8String OPTIONAL,
		-- any prefix before the surname, e.g. "von", "van der"
	surnameSuffix			[4] UTF8String OPTIONAL,
		-- any suffix after the surname, e.g. "Jr", "III"
	middleNames				[5] UTF8String OPTIONAL,
409
		-- that part of the name excluding forename, separable and preceding the surname
410
411
412
413
414
415
416
	firstname				[6] UTF8String OPTIONAL,
		-- the first name or initials, e.g. "Peter"
	...,
	secondsurname			[7] UTF8String OPTIONAL,
		-- a second surname is used in several countries
	secondsurnamePrefix		[8] UTF8String OPTIONAL,
	secondsurnameSuffix		[9] UTF8String OPTIONAL
417
418
}

419
ContactDetails ::= SEQUENCE
420
{
421
422
423
	address						[1] AddressInformation OPTIONAL,
	emailAddress				[2] UTF8String OPTIONAL,
	contactNumber				[3] SEQUENCE OF PartyNumber OPTIONAL,
424
		-- several numbers (work, home, mobile) may be given for a single subscriber
425
426
427
	...,
	additionalEmailAddresses	[4] SEQUENCE OF UTF8String OPTIONAL
		-- several email addresses may be given for a single subscriber
428
429
}

430
AddressInformation ::= SEQUENCE
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
{
	flatNumber		[1] UTF8String OPTIONAL,
	buildingName	[2] UTF8String OPTIONAL,
	buildingNumber	[3] UTF8String OPTIONAL,
	streetName		[4] UTF8String OPTIONAL,
	poBox			[5] UTF8String OPTIONAL,
		-- PO box or Response number
	postalCode		[6] UTF8String OPTIONAL,
		-- Postal code. Example: 2289AC
	region			[7] UTF8String OPTIONAL,
	province		[8] UTF8String OPTIONAL,
	language		[9] UTF8String OPTIONAL,
	city			[10] UTF8String OPTIONAL,
	country			[11] CountryCode OPTIONAL,
		-- Country code as defined in ISO 3166-1 [4]
	validity		[12] TimeSpan OPTIONAL,
		-- time from which the address was registered
	...
}

AuthenticationInfo ::= SEQUENCE
{
	authenticationType		[1] UTF8String OPTIONAL,
454
		-- the type of document used to authenticate, e.g. passport, driver's license
455
456
457
458
	authenticationNumber	[2] UTF8String OPTIONAL,
		-- the number of the document used to authenticate
	...
}
459

460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
PaymentDetails ::= SEQUENCE
{
	billingMethod						[1] BillingMethod OPTIONAL,
	bankAccount							[2] BankAccount OPTIONAL,
	billingAddress						[3] ContactDetails OPTIONAL,
	...
}

BankAccount ::= SEQUENCE
{
	iBAN								[1] IBAN OPTIONAL,
	bIC									[2] BIC OPTIONAL,
	accountHolder						[3] UTF8String OPTIONAL,
	nationalAccountNumber				[4] UTF8String OPTIONAL,
		-- To be used in case that the account holding bank has no IBAN
	nationalBankNumber					[5] UTF8String OPTIONAL,
		-- To be used in case that the account holding bank has neither IBAN nor BIC
	bankName							[6] UTF8String OPTIONAL,
	...
}

IBAN ::= UTF8String 
	-- International Banking Account Number
	-- format as per ISO 13616-1:2007 [28]

BIC ::= UTF8String 
	-- Business Identifier Code
	-- format as per ISO 9362:2009 [29]

BillingMethod ::= ENUMERATED
{
	debit(0),
	transfer(1),
	prepaid(2),
	...
}
496
497
TelephonyRecord ::= CHOICE
{
498
	telephonySubscriber			[1] TelephonySubscriber,
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
	telephonyBillingDetails		[2] TelephonyBillingDetails,
	telephonyServiceUsage		[3] TelephonyServiceUsage,
	telephonyDevice				[4] TelephonyDevice,
	telephonyNetworkElement		[5] TelephonyNetworkElement,
	...
}

-- ==============================
-- Definitions of Subscriber Data
-- ==============================

TelephonySubscriber ::= SEQUENCE
{
	subscriberID					[1] TelephonySubscriberId OPTIONAL,
		-- unique identifier for this subscriber, e.g. account number
	genericSubscriberInfo			[2] GenericSubscriberInfo OPTIONAL,
		-- generic personal information about this subscriber
	telephonySubscriberInfo			[3] TelephonySubscriberInfo OPTIONAL,
		-- service-specific information about this subscriber
	subscribedTelephonyServices		[4] SEQUENCE OF SubscribedTelephonyServices OPTIONAL,
		-- a subscriber (or account) may have more than one service listed against them
520
521
522
523
524
525
526
527
528
529
	...,
	nationalTelephonySubscriberInfo	[5] NationalTelephonySubscriberInfo OPTIONAL
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}

NationalTelephonySubscriberInfo ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
530
531
532
533
534
535
536
537
538
539
540
	...
}

TelephonySubscriberId ::= UTF8String
	-- unique identifier for this subscriber, e.g. account number

TelephonySubscriberInfo ::= NULL
	-- Reserved

SubscribedTelephonyServices ::= SEQUENCE
{
541
	serviceID							[1] UTF8String OPTIONAL,
542
		-- Unique identifier for this service within the operator
543
	providerID							[2] UTF8String OPTIONAL,
544
		-- Unique identifier for the service provider
545
	timeSpan							[3] TimeSpan OPTIONAL,
546
		-- Start and end data, if applicable, of the subscription
547
	registeredNumbers					[4] SEQUENCE OF PartyNumber OPTIONAL,
548
		-- The set of telephone numbers registered for this service
549
550
551
	registeredICCID						[5] UTF8String OPTIONAL,
	serviceType							[6] TelephonyServiceType OPTIONAL,
	installationAddress					[7] AddressInformation OPTIONAL,
552
		-- installation address, if different from the registered address
553
	connectionDate						[8] GeneralizedTime OPTIONAL,
554
555
		-- Date the subscriber was actually connected 
		-- (May differ from the start of subscription)
556
557
558
	iMSI								[9] IMSI OPTIONAL,
	carrierPreselect					[10] BOOLEAN OPTIONAL,
	lineStatus							[11] UTF8String OPTIONAL,
559
		-- CSP-specific description of current line status, e.g. "Active", "Ceased", etc.
560
561
562
563
564
	...,
	allocatedDeviceIDs					[12] SEQUENCE OF TelephonyDeviceID OPTIONAL,
	pUKCode								[13] UTF8String OPTIONAL,
	pUK2Code							[14] UTF8String OPTIONAL,
	iMEI								[15] SEQUENCE OF IMEI OPTIONAL,
565
	nationalTelephonySubscriptionInfo	[16] NationalTelephonySubscriptionInfo OPTIONAL, 
566
567
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
568
	paymentDetails						[17] PaymentDetails OPTIONAL
569
570
571
572
573
574
}

NationalTelephonySubscriptionInfo ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
575
576
577
578
579
	...
}

TelephonyBillingDetails ::= SEQUENCE
{
580
581
582
583
584
	subscriberID						[1] TelephonySubscriberId OPTIONAL,
	serviceID							[2] UTF8String OPTIONAL,
	billingAddress						[3] ContactDetails OPTIONAL,
	billingIdentifier					[4] BillingIdentifier OPTIONAL,
	billingRecords						[5] SEQUENCE OF BillingRecords OPTIONAL,
585
	...,
586
	nationalTelephonyBillingDetails		[6] NationalTelephonyBillingDetails OPTIONAL
587
588
589
590
591
592
593
594
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}

NationalTelephonyBillingDetails ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
595
596
597
598
599
600
601
602
603
	...
}

BillingIdentifier ::= OCTET STRING
	-- Used to correlate billing information
	-- useful if the bill-payer is not the subscriber, e.g. company mobiles

BillingRecords ::= SEQUENCE
{
604
605
606
607
	time								[1] GeneralizedTime OPTIONAL,
	place								[2] UTF8String OPTIONAL,
	amount								[3] REAL OPTIONAL,
	currency							[4] UTF8String (SIZE(3)) OPTIONAL,
608
		-- as per ISO 4217 [5]
609
	method								[5] UTF8String OPTIONAL,
610
		-- i.e. credit card etc. 
611
	...,
612
	nationalTelephonyBillingRecords		[6] NationalTelephonyBillingRecords OPTIONAL,
613
614
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
615
616
617
618
619
620
	transactionID						[7] UTF8String OPTIONAL,
		-- Unique reference for this transaction/billing record
		-- Details to be defined on a national basis
	transactionStatus					[8] UTF8String OPTIONAL
		-- Status of the transaction (i.e. “declined”, “succeeded” etc.)
		-- Details to be defined on a national bases
621
622
623
624
625
626
}

NationalTelephonyBillingRecords ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
	...
}

TelephonyServiceType ::= ENUMERATED
{
	private(0),
	privatePABX(1),
	publicPayphone(2),
	...
}

-- =================================
-- Definitions of Service Usage Data
-- =================================

TelephonyServiceUsage ::= SEQUENCE
{
644
	partyInformation				[1] SEQUENCE OF TelephonyPartyInformation OPTIONAL,
645
646
647
		-- This parameter provides the concerned party (Originating, Terminating or 
		-- forwarded party), the identity(ies) of the party and all the information
		-- provided by the party
648
	communicationTime				[2] TimeSpan OPTIONAL,
649
		-- Time and duration of the communication
650
	eventInformation				[3] SEQUENCE OF TelephonyEventInformation OPTIONAL,
651
		-- A list of events that occurred during this service usage
652
	endReason						[4] INTEGER OPTIONAL,
653
		-- Q.850 cause code for call termination
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
	communicationType				[5] TelephonyCommunicationType OPTIONAL,
	bearerService					[6] TelephonyBearerService OPTIONAL,
	smsInformation					[7] SmsInformation OPTIONAL,
	ringDuration					[8] INTEGER OPTIONAL,
	...,
	mmsInformation					[9] MmsInformation OPTIONAL,
	nationalTelephonyServiceUsage	[10] NationalTelephonyServiceUsage OPTIONAL
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}

NationalTelephonyServiceUsage ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
669
670
671
672
673
	...
}

TelephonyPartyInformation ::= SEQUENCE
{
674
675
676
677
678
	partyRole 							[1] TelephonyPartyRole OPTIONAL,
	partyNumber							[2] PartyNumber OPTIONAL,
	subscriberID						[3] TelephonySubscriberId OPTIONAL,
	deviceID							[4] TelephonyDeviceID OPTIONAL,
	locations							[5] SEQUENCE OF TelephonyLocation OPTIONAL,
679
		-- List of cell locations used by this party during the service usage
680
	communicationTime					[6] TimeSpan OPTIONAL,
681
		-- Time and duration of the communication
682
683
	iMSI								[8] IMSI OPTIONAL,
	natureOfAddress						[9] UTF8String OPTIONAL,
684
		-- Nature of address indicator, e.g. "National", "International"
685
686
687
688
	forwardedTransferredNumber			[10] PartyNumber OPTIONAL,
	terminatingTransferredNumber		[11] PartyNumber OPTIONAL, 
	...,
	emailAddress						[12] UTF8String  OPTIONAL,
689
		-- used for MMS that supports also the use of E-Mail addresses (RFC 5322 [24])
690
691
692
693
	iMEI								[13] IMEI OPTIONAL,
	detailedLocation					[14] TelephonyNetworkElement OPTIONAL,
		-- In the case detailed location information per call and party is available 
		-- (e.g. the geoCoordinates for this partyNumber)
694
	nationalTelephonyPartyInformation	[15] NationalTelephonyPartyInformation OPTIONAL,
695
696
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
697
698
	partyType							[16] TelephonyPartyType OPTIONAL,
	dialledDigits						[17] UTF8String OPTIONAL
699
700
701
702
703
704
}

NationalTelephonyPartyInformation ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
705
706
707
	...
}

708
709
710
711
712
713
714
715
TelephonyPartyType ::= CHOICE
{
	voicemail		[1] NULL,
	smsServer		[2] NULL,
	other			[3] UTF8String,
	...
}

716
TelephonyCommunicationType ::= ENUMERATED
717
718
719
720
{
	telephonyFixedCS(0),
	telephonyWirelessCS(1),
	sMS(2),
721
722
	...,
	mMS(3)
723
724
}

725
TelephonyBearerService ::= ENUMERATED
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
{
	speech(0),
	data(1),
	fax(2),
	...
}

SmsInformation ::= SEQUENCE
{
	smsEvent		[1] ENUMERATED
	{
		shortMessage(1),
		shortPartMessage(2),
		compositeMessage(3),
		notificationMessage(4),
		...
	} OPTIONAL,
	smsType			[2] ENUMERATED
	{
		deliverSCtoMS(1),
		deliverReportMStoSC(2),
		statusReportSCtoMS(3),
		commandMStoSC(4),
		submitMStoSC(5),
		submitReportSCtoMS(6),
		reservedMTIValue(7),
		...
	} OPTIONAL,
	smsStatus		[3] ENUMERATED
	{
		delivered(0),
		expired(1),
		deleted(2),
		replaced(3),
		submitted(4),
		incomplete-submission(5),
		incomplete-delivery(6),
		undeliverable(7),
		passed-on(8),
		...
	} OPTIONAL,
	smsCmRefNr		[4] OCTET STRING (SIZE(1..2)) OPTIONAL,
768
		-- format as per 3GPP TS 23.040 [16]
769
770
771
	smsNumOfSM		[5] INTEGER (0..65535) OPTIONAL,
	smsNotifyInd	[6] BOOLEAN OPTIONAL,
	smsProtocolId	[7] OCTET STRING (SIZE(1)) OPTIONAL,
772
		-- format as per 3GPP TS 23.040 [16]
773
774
775
	...
}

776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
MmsInformation	::= SEQUENCE
{
	mmsEvent		[1] ENUMERATED
	{
		message(1),
		notificationMessage(2),
		deliveryReportMessage(3),
		readReplyMessage(4),
		...
	} OPTIONAL,
		-- type of message exchanged
	mmsStatus		[2] ENUMERATED
	{
		delivered(0),
		expired(1),
		deleted(2),
		replaced(3),
		submitted(4),
		undeliverable(5),
		passed-on(6),
		delivery-rejection(7),
		delivery-forward(8),
		delivery-copy(9),
		submission-rejection(10),
		submission-failure(11),
801
802
803
804
		...,
		delivered-application(12)
		-- optional flag indicating MMS was retrieved using
		-- something other than mobile deivce e.g. web browser
805
806
807
808
809
810
811
812
813
814
815
816
817
818
	} OPTIONAL,
	mmsNotifInd		[3] BOOLEAN OPTIONAL,
		-- indication that a delivery notification has been generated
	mmsMsgMod		[4] ENUMERATED
	{
		none(1),
		modified(2),
		stripped(3),
		...
	} OPTIONAL,
		-- message modification indication for MMS
	...
}

819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
TelephonyEventInformation ::= SEQUENCE
{
	time 		[1] GeneralizedTime OPTIONAL,
		-- time when the event occurred
	type 		[2] TelephonyEventType OPTIONAL,
		-- type of event
	party 		[3] TelephonyPartyRole OPTIONAL,
		-- party to which the event is related
	location	[4] TelephonyLocation OPTIONAL,
	...
}

TelephonyEventType ::= CHOICE
{
	basicEventType				[1] BasicEventType,
	callConferenceEventType		[2] CallConferenceEventType,
	callForwardingEventType		[3] CallForwardingEventType,
	messagingEventType			[4] MessagingEventType,
	prepayServiceEventType		[5] PrepayServiceEventType,
838
839
840
841
842
843
844
845
846
847
	...,
	nationalTelephonyEventType	[6] NationalTelephonyEventType
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}

NationalTelephonyEventType ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
848
849
850
851
852
853
854
855
856
	...
}

BasicEventType ::= ENUMERATED
{
	handover(1),
	hold(2),
	retrieve(3),
	suspend(4),
857
	resume(5),
858
859
860
861
862
863
864
865
866
867
868
869
870
	ect(6),
	mpty(7),
	mptyHold(8),
	mptyRetrieve(9),
	mptySplit(10),
	uus1(11),
	uus2(12),
	uus3(13),
	serviceSpeech(14),
	serviceFax(15),
	tpyInvoke(16),
	tpyPrivateComm(17),
	serviceActivation(18),
871
	transit(19),
872
	mSOriginating(20),
873
	callForwarding(21),
874
	mSTerminating(22),
875
876
877
878
879
	...,
	callAttempt(23),
	callStart(24),
	callEnd(25),
	cliWithheld(26)
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
}

CallForwardingEventType ::= ENUMERATED
{
	cfuActivation(1),
	cfuModification(2),
	cfuDe-activation(3),
	cfcNoReplyActivation(4),
	cfcNoReplyModification(5),
	cfcNoReplyDe-activation(6),
	cfcBusyActivation(7),
	cfcBusyModification(8),
	cfcBusyDe-activation(9),
	cfcOutOfRangeActivation(10),
	cfcOutOfRangeModification(11),
	cfcOutOfRangeDe-activation(12),
	cfcUnavailableActivation(13),
	cfcUnavailableModification(14),
	cfcUnavailableDe-activation(15),
	cfuFaxActivation(16),
	cfuFaxModification(17),
	cfuFaxDe-activation(18),
	...
}

CallConferenceEventType ::= ENUMERATED
{
	confBeginSeizure(1),
	confAdd(2),
	confSplit(3),
	confIsolate(4),
	confReattach(5),
	confDrop(6),
	confBeginActive(7),
	...
}

MessagingEventType ::= ENUMERATED
{
919
920
	mSOriginatingSMSinMSC(1),
	mSTerminatingSMSinMSC(2),
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
	shortMessageDelivery(3),
	mMMessage(4),
	mMNotification(5),
	mMDeliveryReport(6),
	mMReadReply(7),
	...
}

PrepayServiceEventType ::= ENUMERATED
{
	serviceActivation(1),
	...
}

TelephonyLocation ::= SEQUENCE
{
937
	telephonyNetworkID			[1] TelephonyNetworkID OPTIONAL,
938
		-- ID of the network element location (e.g. Cell ID)
939
	timeSpan					[2] TimeSpan OPTIONAL,
940
		-- Time span that this location was valid for
941
942
943
944
945
946
947
948
949
950
	...,
	nationalTelephonyLocation	[3] NationalTelephonyLocation OPTIONAL
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}

NationalTelephonyLocation ::= SEQUENCE
{
	countryCode		[1] UTF8String (SIZE (2)),
		-- see comment in NationalRequestParameters
951
952
953
954
955
956
957
958
	...
}

TelephonyPartyRole ::= ENUMERATED
{
	originating-Party(0),
	terminating-Party(1),
	forwarded-to-Party(2),
959
	originalCalled(3),
960
961
962
963
964
965
966
967
968
969
	redirecting(4),
	connected(5),
	userProvidedCalling(6),
	roaming(7),
	translated(8),
	singlePersonalNumber(9),
	smsOriginator(10),
	smsRecipient(11),
	smsOriginatorTrn(12),
	smsRecipientTrn(13),
970
971
972
973
974
	...,
	mmsOriginator(14),
	mmsRecipient(15),
	mmsOriginatorTrn(16),
	mmsRecipientTrn(17)
975
976
977
978
979
980
981
982
}

-- =======================
-- Device Data definitions
-- =======================

TelephonyDevice ::= SEQUENCE
{
983
	deviceIDType				[1] ENUMERATED
984
985
986
987
988
989
990
		-- Type of identifier for telephony device
	{
		unknown(0),
		imei(1),
		macAddress(2),
		...
	} OPTIONAL,
991
	telephonyDeviceID			[2] TelephonyDeviceID OPTIONAL,
992
		-- Unique identifier for this telephony device according to type of identifier
993
	...,
994
	subscriberID				[3] TelephonySubscriberId OPTIONAL,
995
996
		-- Identifier for a known user of this equipment. 
		-- Usage of this parameter is subject to national legislation.
997
	nationalTelephonyDevice		[4] NationalTelephonyDevice OPTIONAL
998
999
1000
		-- To be defined on a national basis 
		-- Only to be used in case the present document cannot fulfil the national requirements
}
For faster browsing, not all history is shown. View entire blame