This repository was archived by the owner on Jul 1, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathretailcustomer.xsd
More file actions
3191 lines (3178 loc) · 129 KB
/
retailcustomer.xsd
File metadata and controls
3191 lines (3178 loc) · 129 KB
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
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
768
769
770
771
772
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
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
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
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://naesb.org/espi/customer"
targetNamespace="http://naesb.org/espi/customer" elementFormDefault="qualified"
version="3.3.20200130">
<!--
==========================================================================
Schema: retailcustomer.xsd
Version: North American Energy Standards Board (NAESB) REQ.21 ESPI Model Business Practices,
Retail Markets Quadrant (RMQ). Ratified April 8, 2019.
Authors: NAESB
==========================================================================
Copyright 2019-2021 North American Energy Standards Board
Licensed by the North American Energy Standards Board (NAESB). See the NOTICE section file below for additional information
regarding copyright ownership. NAESB licenses this file
to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy
of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
______________________________________________________
NOTICE
______________________________________________________
This NAESB ESPI Retail Customer Schema and the NAESB ESPI Schema are part of the copyrighted NAESB REQ.21 ESPI Model Business Practices.
The NAESB REQ.21 Model Business Practices may be purchased from NAESB at: http://www.naesb.org/misc/naesb_matl_order_espi_standards.pdf.
The NAESB Copyright Policy may be found here http://www.naesb.org/pdf2/copyright.pdf.
The NAESB Intellectual Property Rights Policy Concerning Contributions and Comments may be found here http://www.naesb.org/pdf4/naesb_ipr_policy.doc.
______________________________________________________
END NOTICE
______________________________________________________
______________________________________________________
NOTICE
______________________________________________________
==========================================================================
Schema: retailcustomer.xsd
Version: 3.3.20200130
Author: Ron Pasquarelli & Marty Burns (NIST), John Teeter (for NIST), Don Coffin (REMI Networks), Klaar De Schepper (Flux Tailor)
==========================================================================
Copyright (c) 2018-2020 Green Button Alliance, Inc.
Portions copyright (c) 2013-2018 EnergyOS.org
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
______________________________________________________
All entries marked [GBA-Extension] are Copyright property of the Green Button Alliance, Inc.
as required by the Apache 2.0 License.
______________________________________________________
END NOTICE
______________________________________________________
-->
<!-- edited with XMLSpy v2019 rel. 3 sp1 (x64) (http://www.altova.com) by Donald Coffin (REMI Networks) -->
<xs:annotation>
<xs:documentation>
The retail customer schema provides details about a UsagePoint that are considered Personally identifiable information (PII) and
cannot be part of normal ESPI usage information.
These resources are available via the same messaging patterns as other ESPI data. However, they are defined in a separate namespace
and cannot be retrieved in the same message as non-PII containing ESPI data.
</xs:documentation>
</xs:annotation>
<!--
=======================================
Imports
=======================================
-->
<xs:import namespace="http://www.w3.org/2005/Atom" schemaLocation="atom.xsd"/>
<!--
=======================================
Resources
=======================================
-->
<xs:complexType name="Customer">
<xs:annotation>
<xs:documentation>Organisation receiving services from service supplier.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="OrganisationRole">
<xs:sequence>
<xs:element name="kind" type="CustomerKind" minOccurs="0">
<xs:annotation>
<xs:documentation>Kind of customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="specialNeed" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>True if customer organisation has special service needs such as life support, hospitals, etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="vip" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>(use 'priority' instead) True if this is an important customer. Importance is for matters different than those in 'specialNeed' attribute.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="pucNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>(if applicable) Public utilities commission (PUC) identification number.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="Status" minOccurs="0">
<xs:annotation>
<xs:documentation>Status of this customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="priority" type="Priority" minOccurs="0">
<xs:annotation>
<xs:documentation>Priority of the customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="locale" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Locale designating language to use in communications with this customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customerName" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>[Extension] Customer name</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CustomerAccount">
<xs:annotation>
<xs:documentation>Assignment of a group of products and services purchased by the customer through a customer agreement, used as a mechanism for customer billing and payment. It contains common information from the various types of customer agreements to create billings (invoices) for a customer and receive payment.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Document">
<xs:sequence>
<xs:element name="billingCycle" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Cycle day on which the associated customer account will normally be billed, used to determine when to produce the billing.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="budgetBill" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Budget bill code.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastBillAmount" type="Int48" minOccurs="0">
<xs:annotation>
<xs:documentation>The last amount that will be billed to the customer prior to shut off of the account.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="notifications" type="AccountNotification" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Set of customer account notifications.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="contactInfo" type="Organisation" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Customer contact information used to identify individual responsible for billing and payment of CustomerAccount.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="accountId" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>[Extension] Customer account identifier</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CustomerAgreement">
<xs:annotation>
<xs:documentation>Agreement between the customer and the service supplier to pay for service at a specific service location. It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Agreement">
<xs:sequence>
<xs:element name="loadMgmt" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Load management code.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="isPrePay" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation> If true, the customer is a pre-pay customer for the specified service.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shutOffDateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Final date and time the service will be billed to the previous customer.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DemandResponseProgram" type="DemandResponseProgram"
minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Demand Response program characteristics covered by Customer Agreement</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PricingStructures" type="PricingStructure" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All pricing structures applicable to this customer agreement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="currency" type="Currency" minOccurs="0">
<xs:annotation>
<xs:documentation>Currency for all monetary amounts for this agreement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="futureStatus" type="Status" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>[extension] Known future changes to CustomerAgreement's Status of Service.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="agreementId" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>[Extension] Customer agreement identifier</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="EndDevice">
<xs:annotation>
<xs:documentation>Asset container that performs one or more end device functions. One type of end device is a meter which can perform metering, load management, connect/disconnect, accounting functions, etc. Some end devices, such as ones monitoring and controlling air conditioners, refrigerators, pool pumps may be connected to a meter. All end devices may have communication capability defined by the associated communication function(s). An end device may be owned by a consumer, a service provider, utility or otherwise.
There may be a related end device function that identifies a sensor or control point within a metering application or communications systems (e.g., water, gas, electricity).
Some devices may use an optical port that conforms to the ANSI C12.18 standard for communications.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="AssetContainer">
<xs:sequence>
<xs:element name="isVirtual" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>If true, there is no physical device. As an example, a virtual meter can be defined to aggregate the consumption for two or more physical meters. Otherwise, this is a physical hardware device.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="isPan" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>If true, this is a premises area network (PAN) device.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="installCode" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Installation code.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="amrSystem" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Automated meter reading (AMR) or other communication system responsible for communications to this end device.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Meter">
<xs:annotation>
<xs:documentation>Physical asset that performs the metering role of the usage point. Used for measuring consumption and detection of events.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="EndDevice">
<xs:sequence>
<xs:element name="formNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Meter form designation per ANSI C12.10 or other applicable standard. An alphanumeric designation denoting the circuit arrangement for which the meter is applicable and its specific terminal arrangement.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MeterMultipliers" type="MeterMultiplier" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All multipliers applied at this meter.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="intervalLength" type="UInt32" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Current interval length specified in seconds.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ProgramDateIdMappings">
<xs:annotation>
<xs:documentation>[extension] Collection of all customer Energy Efficiency programs</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="programDateIdMapping" type="ProgramDateIdMapping"
minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Program date description</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ServiceLocation">
<xs:annotation>
<xs:documentation>A real estate location, commonly referred to as premises.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="WorkLocation">
<xs:sequence>
<xs:element name="accessMethod" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Method for the service person to access this service location. For example, a description of where to obtain a key if the facility is unmanned and secured.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="siteAccessProblem" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Problems previously encountered when visiting or performing work on this location. Examples include: bad dog, violent customer, verbally abusive occupant, obstructions, safety hazards, etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="needsInspection" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>True if inspection is needed of facilities at this service location. This could be requested by a customer, due to suspected tampering, environmental concerns (e.g., a fire in the vicinity), or to correct incompatible data.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="UsagePoints" type="UsagePoints" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All usage points delivering service (of the same type) to this service location.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="outageBlock" type="String32" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Outage Block Identifier</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ServiceSupplier">
<xs:annotation>
<xs:documentation>Organisation that provides services to customers.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="OrganisationRole">
<xs:sequence>
<xs:element name="kind" type="SupplierKind" minOccurs="0">
<xs:annotation>
<xs:documentation>Kind of supplier.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="issuerIdentificationNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Unique transaction reference prefix number issued to an entity by the International Organization for Standardization for the purpose of tagging onto electronic financial transactions, as defined in ISO/IEC 7812-1 and ISO/IEC 7812-2.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="effectiveDate" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension] Effective Date of Service Activation</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Statement">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Billing statement for provided services.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="IssueDateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Date and time at which a billing statement was issued.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statementRef" type="StatementRef" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>[extension Copyright GBA] Contains document reference metadata needed to access a document representation of a billing statement.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="TimeConfiguration">
<xs:annotation>
<xs:documentation>[extension] Contains attributes related to the configuration of the time service.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="dstEndRule" type="DstRuleType">
<xs:annotation>
<xs:documentation>Rule to calculate end of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dstOffset" type="TimeType">
<xs:annotation>
<xs:documentation>Daylight savings time offset from local standard time.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dstStartRule" type="DstRuleType">
<xs:annotation>
<xs:documentation>Rule to calculate start of daylight savings time in the current year. Result of dstEndRule must be greater than result of dstStartRule.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="tzOffset" type="TimeType">
<xs:annotation>
<xs:documentation>Local time zone offset from UTCTime. Does not include any daylight savings time offsets.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!--
=======================================
Basic Types
=======================================-->
<xs:simpleType name="HexBinary128">
<xs:annotation>
<xs:documentation>A 128-bit field encoded as a hex string (32 characters / 16 octets)</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:hexBinary">
<xs:maxLength value="16"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="HexBinary32">
<xs:annotation>
<xs:documentation>A 32-bit field encoded as a hex string (8 characters / 4 octets)</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:hexBinary">
<xs:maxLength value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="HexBinary16">
<xs:annotation>
<xs:documentation>A 16-bit field encoded as a hex string (4 characters / 2 octets)</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:hexBinary">
<xs:maxLength value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="HexBinary8">
<xs:annotation>
<xs:documentation>An 8-bit field encoded as a hex string (2 characters / 1 octets)</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:hexBinary">
<xs:maxLength value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="String512">
<xs:annotation>
<xs:documentation>[extension] Character string of max length 512</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="512"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="String256">
<xs:annotation>
<xs:documentation>Character string of max length 256</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="256"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="String64">
<xs:annotation>
<xs:documentation>Character string of max length 64</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="64"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="String32">
<xs:annotation>
<xs:documentation>Character string of max length 32</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="32"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UInt48">
<xs:annotation>
<xs:documentation>Unsigned integer, max inclusive 281474976710655 (2^48-1), restriction of xs:unsignedLong</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:unsignedLong">
<xs:maxInclusive value="281474976710655"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UInt32">
<xs:annotation>
<xs:documentation>Unsigned integer, max inclusive 4294967295 (2^32-1), same as xs:unsignedInt</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:unsignedInt"/>
</xs:simpleType>
<xs:simpleType name="UInt16">
<xs:annotation>
<xs:documentation>Unsigned integer, max inclusive 65535 (2^16-1), same as xs:unsignedShort</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:unsignedShort"/>
</xs:simpleType>
<xs:simpleType name="UInt8">
<xs:annotation>
<xs:documentation>Unsigned integer, max inclusive 255 (2^8-1), same as xs:unsignedByte</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:unsignedByte"/>
</xs:simpleType>
<xs:simpleType name="Int48">
<xs:annotation>
<xs:documentation>Signed integer, max inclusive -140737488355327 to +140737488355327 (2^47-1), restriction of xs:long</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:long">
<xs:minInclusive value="-140737488355328"/>
<xs:maxInclusive value="140737488355328"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="Int16">
<xs:annotation>
<xs:documentation>Signed integer, max inclusive (2^16-1), restriction of xs:short</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:short"/>
</xs:simpleType>
<xs:simpleType name="name">
<xs:restriction base="String64"/>
</xs:simpleType>
<xs:simpleType name="PerCent">
<xs:annotation>
<xs:documentation>Percentage on a defined base. For example, specify as 100 to indicate at the defined base.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:integer">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="100"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TimeType">
<xs:annotation>
<xs:documentation>Time is a signed 64-bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 1970.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:long"/>
</xs:simpleType>
<xs:simpleType name="UUIDType">
<xs:annotation>
<xs:documentation>This pattern defines a UUID </xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"/>
</xs:restriction>
</xs:simpleType>
<!--
=======================================
Additional Complex Types
=======================================
-->
<xs:complexType name="AcceptanceTest">
<xs:annotation>
<xs:documentation>Acceptance test for assets.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="type" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Describes the type of test performed on the asset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="success" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>True if asset has passed acceptance test and may be placed in or is in service. It is set to false if asset is removed from service and is required to be tested again before being placed back in service, possibly in a new location. Since asset may go through multiple tests during its lifecycle, the date of each acceptance test may be recorded in 'Asset.ActivityRecord.status.dateTime'.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Date and time the asset was last tested using the 'type' of test and yielding the current status in 'success' attribute.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="AccountNotification">
<xs:annotation>
<xs:documentation>[extension] Customer action notification (e.g., delinquency, move in, move out)</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="methodKind" type="NotificationMethodKind">
<xs:annotation>
<xs:documentation>Method by which the customer was notified.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="time" type="TimeType">
<xs:annotation>
<xs:documentation>timedate of notification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="note" type="String256">
<xs:annotation>
<xs:documentation>annotation of the reason for the notification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="customerNotificationKind" type="String256">
<xs:annotation>
<xs:documentation>delinquency,move in, move out ...</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Agreement">
<xs:annotation>
<xs:documentation>Formal agreement between two parties defining the terms and conditions for a set of services. The specifics of the services are, in turn, defined via one or more service agreements.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Document">
<xs:sequence>
<xs:element name="signDate" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Date this agreement was consummated among associated persons and/or organisations.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="validityInterval" type="DateTimeInterval" minOccurs="0">
<xs:annotation>
<xs:documentation>Date and time interval this agreement is valid (from going into effect to termination).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Asset">
<xs:annotation>
<xs:documentation>Tangible resource of the utility, including power system equipment, various end devices, cabinets, buildings, etc. For electrical network equipment, the role of the asset is defined through PowerSystemResource and its subclasses, defined mainly in the Wires model (refer to IEC61970-301 and model package IEC61970::Wires). Asset description places emphasis on the physical characteristics of the equipment fulfilling that role.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="type" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Utility-specific classification of Asset and its subtypes, according to their corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="utcNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Uniquely tracked commodity (UTC) number.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="serialNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Serial number of this asset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lotNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Lot number for this asset. Even for the same model and version number, many assets are manufactured in lots.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="purchasePrice" type="Int48" minOccurs="0">
<xs:annotation>
<xs:documentation>Purchase price of asset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="critical" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>True if asset is considered critical for some reason (for example, a pole with critical attachments).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="electronicAddress" type="ElectronicAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>Electronic address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lifecycle" type="LifecycleDate" minOccurs="0">
<xs:annotation>
<xs:documentation>Lifecycle dates for this asset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="acceptanceTest" type="AcceptanceTest" minOccurs="0">
<xs:annotation>
<xs:documentation>Information on acceptance test.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="initialCondition" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Condition of asset in inventory or at time of installation. Examples include new, rebuilt, overhaul required, other. Refer to inspection data for information on the most current condition of the asset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="initialLossOfLife" type="PerCent" minOccurs="0">
<xs:annotation>
<xs:documentation>Whenever an asset is reconditioned, percentage of expected life for the asset when it was new; zero for new devices.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="Status" minOccurs="0">
<xs:annotation>
<xs:documentation>Status of this asset.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="AssetContainer">
<xs:annotation>
<xs:documentation>Asset that is aggregation of other assets such as conductors, transformers, switchgear, land, fences, buildings, equipment, vehicles, etc.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Asset"/>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="BatchItemInfo">
<xs:annotation>
<xs:documentation>Includes elements that make it possible to include multiple transactions in a single (batch) request.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="name" type="HexBinary16" minOccurs="0">
<xs:annotation>
<xs:documentation>An identifier for this object that is only unique within the containing collection.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="operation" type="CRUDOperation" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies the operation requested of this item.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusCode" type="StatusCode" minOccurs="0">
<xs:annotation>
<xs:documentation>Indicates the status code of the associated transaction.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusReason" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Indicates the reason for the indicated status code.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="BatchListType">
<xs:annotation>
<xs:documentation>[extension] List of resource URIs that can be used to GET retail customer resources</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="resources" type="xs:anyURI" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="DateTimeInterval">
<xs:annotation>
<xs:documentation>Interval of date and time. End is not included because it can be derived from the start and the duration.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="duration" type="UInt32" minOccurs="0">
<xs:annotation>
<xs:documentation>[correction] Duration of the interval, in seconds.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="start" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>[correction] Date and time that this interval started.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="DemandResponseProgram">
<xs:annotation>
<xs:documentation>[extension] Demand Response program characteristics covered by Customer Agreement</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="programName" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of Demand Response program</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="enrollmentStatus" type="EnrollmentStatus" minOccurs="0">
<xs:annotation>
<xs:documentation>Retail Customer's current Demand Response program enrollment status</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="programDescription" type="xs:anyURI" minOccurs="0">
<xs:annotation>
<xs:documentation>URI of Demand Response program description</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="programDate" type="ProgramDate" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All Demand Response program enrollment and termination dates</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="capacityReservationLevel" type="SummaryMeasurement" minOccurs="0">
<xs:annotation>
<xs:documentation>Summary measurement of Capacity Reservation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DRProgramNomination" type="SummaryMeasurement" minOccurs="0">
<xs:annotation>
<xs:documentation>Summary measurement of Demand Response</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Document">
<xs:annotation>
<xs:documentation>Parent class for different groupings of information collected and managed as a part of a business process. It will frequently contain references to other objects, such as assets, people and power system resources.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="type" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="authorName" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the author of this document.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="createdDateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Date and time that this document was created.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastModifiedDateTime" type="TimeType" minOccurs="0">
<xs:annotation>
<xs:documentation>Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="revisionNumber" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Revision number for this document.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="electronicAddress" type="ElectronicAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>Electronic address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="subject" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Document subject.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Document title.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="docStatus" type="Status" minOccurs="0">
<xs:annotation>
<xs:documentation>Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute.
Example values for 'docStatus.status' are draft, approved, cancelled, etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="Status" minOccurs="0">
<xs:annotation>
<xs:documentation>Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="comment" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Free text comment.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ElectronicAddress">
<xs:annotation>
<xs:documentation>Electronic address information.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="lan" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Address on local area network.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mac" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>MAC (Media Access Control) address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="email1" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Primary email address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="email2" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Alternate email address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="web" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>World wide web address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="radio" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Radio address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="userID" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>User ID needed to log in, which can be for an individual person, an organisation, a location, etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="password" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Password needed to log in.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="IdentifiedObject">
<xs:annotation>
<xs:documentation>This is a root class to provide common naming attributes for all classes needing naming attributes</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="Object">
<xs:sequence>
<xs:element name="batchItemInfo" type="BatchItemInfo" minOccurs="0"/>
<xs:element name="name" type="name" minOccurs="0">
<xs:annotation>
<xs:documentation>[Deprecated] identifier of object instance</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Location">
<xs:annotation>
<xs:documentation>The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time. It can be defined with one or more position points (coordinates) in a given coordinate system.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="IdentifiedObject">
<xs:sequence>
<xs:element name="type" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mainAddress" type="StreetAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>Main address of the location.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="secondaryAddress" type="StreetAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phone1" type="TelephoneNumber" minOccurs="0">
<xs:annotation>
<xs:documentation>Phone number.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="phone2" type="TelephoneNumber" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional phone number.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="electronicAddress" type="ElectronicAddress" minOccurs="0">
<xs:annotation>
<xs:documentation>Electronic address.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="geoInfoReference" type="String256" minOccurs="0">
<xs:annotation>
<xs:documentation>(if applicable) Reference to geographical information source, often external to the utility.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="direction" type="String256" minOccurs="0">