-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathcommon-3.0.xsd
1064 lines (980 loc) · 36.2 KB
/
common-3.0.xsd
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:sch="http://purl.oclc.org/dsdl/schematron" elementFormDefault="qualified"
targetNamespace="http://www.orcid.org/ns/common" xmlns:common="http://www.orcid.org/ns/common">
<xs:annotation>
<xs:documentation>
=============================================================================
ORCID (R) Open Source
http://orcid.org
Copyright (c) 2012-2014 ORCID,
Inc.
Licensed under an MIT-Style License (MIT)
http://orcid.org/open-source-license
This copyright and license
information (including a link to the full
license)
shall be included in
its entirety in all copies or substantial portion of
the software.
=============================================================================
The schema describes the message format used for ORCID API requests
and responses.
The top level element is orcid-message.
</xs:documentation>
<xs:appinfo>
<sch:title>Schematron validation</sch:title>
<sch:ns prefix="orcid" uri="http://www.orcid.org/ns/orcid" />
</xs:appinfo>
</xs:annotation>
<xs:element name="last-modified-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when the element was last modified.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="created-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when element was created.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="read-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when element was first read by the user.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="archived-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when element was archived.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="sent-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when element was sent to the user.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="approval-date">
<xs:complexType>
<xs:annotation>
<xs:documentation>The date time when element was approved.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:dateTime" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="source" type="common:source-type" />
<xs:element name="external-ids" type="common:external-ids" />
<xs:element name="external-id" type="common:external-id" />
<xs:complexType name="source-type">
<xs:annotation>
<xs:documentation>The client application (Member organization's
system) or user that created the item. XSD VERSION 1.2 UPDATE: the
identifier for the source may be either an ORCID iD (representing
individuals and legacy client applications) or a Client ID
(representing all newer client applications)
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="common:source-orcid">
<xs:annotation>
<xs:documentation>The ORCID identifier for the individual user (or
legacy client application) that created the item. For identifiers
of
individual users, it may be used to look up ORCID record
details via
the API.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="source-client-id" type="common:client-id">
<xs:annotation>
<xs:documentation>The client ID for the client application (Member
organization system) that created the item.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="source-name" type="common:source-name"
minOccurs="0" />
<xs:choice minOccurs="0">
<xs:element name="assertion-origin-orcid" type="common:orcid-id">
<xs:annotation>
<xs:documentation>The ORCID identifier for the individual user (or
legacy client application) made the assertion.
If missing, source is the same as assertion origin.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="assertion-origin-client-id" type="common:client-id">
<xs:annotation>
<xs:documentation>The client ID for the client application (Member
organization system) that made the assertion.
If missing, source is the same as assertion origin.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="assertion-origin-name" type="common:source-name"
minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="source-name" mixed="true">
<xs:annotation>
<xs:documentation>The human-readable name of the client application
(Member organization system) or individual user that created the
item. Value for the same person/organization could change over time.
source-orcid or source-client-id fields are more appropriate for
disambiguated matching.
</xs:documentation>
</xs:annotation>
</xs:complexType>
<xs:complexType name="organization">
<xs:annotation>
<xs:documentation>A reference to an organization. An organization should
contain a disambiguated organization, which uniquely identifies the
organization. While the schema does not enforce the presence of a
disambiguated organization, it is only optional for peer review
convening organizations. A disambiguated organization is mandatory in
all other cases where organization is required in the schema.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="name" type="common:long-text" />
<xs:element name="address" type="common:organization-address" />
<xs:element name="disambiguated-organization" type="common:disambiguated-organization"
minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<xs:element name="organization" type="common:organization" />
<xs:complexType name="organization-address">
<xs:annotation>
<xs:documentation>Container for organization location information
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="1" name="city" type="common:long-text">
<xs:annotation>
<xs:documentation>City</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="region" type="common:long-text">
<xs:annotation>
<xs:documentation>Region within a country</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="1" name="country" type="common:iso-3166-country" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="disambiguated-organization">
<xs:annotation>
<xs:documentation>A reference to a disambiguated version the
organization to which the researcher or contributor is affiliated.
The list of disambiguated organizations come from ORCID partners
such as Ringgold, ISNI and FundRef.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="disambiguated-organization-identifier"
type="common:short-text">
<xs:annotation>
<xs:documentation>The disambiguated organization identifier.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="disambiguation-source" type="common:short-text">
<xs:annotation>
<xs:documentation>The source for providing the disambiguated
organization ID. For the list of allowed sources see https://github.com/ORCID/ORCID-Source/blob/master/orcid-core/src/main/java/org/orcid/core/orgs/OrgDisambiguatedSourceType.java
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="locale">
<xs:annotation>
<xs:documentation>For the up to date supported locale list see https://github.com/ORCID/ORCID-Source/SUPPORTED_LOCALES.md</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z]{1,8}((-|_)[a-zA-Z0-9]{1,8})*" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="non-empty-string">
<xs:annotation>
<xs:documentation>Must contain one or more charaters that are not a
space, carriage return or linefeed
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="[\s\S]*[^\s\n\r]+[\s\S]*" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="transient-non-empty-string">
<xs:annotation>
<xs:documentation>A string that is flagged as transient
i.e. populated by ORCID, not the source.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="common:non-empty-string">
<xs:attribute name="transient" use="required">
<xs:simpleType>
<xs:restriction base="xs:boolean">
<xs:pattern value="true" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="transient-error">
<xs:annotation>
<xs:documentation>An error that populated by ORCID when record is read
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="error-code" type="common:non-empty-string" minOccurs="0" maxOccurs="1"/>
<xs:element name="error-message" type="common:non-empty-string" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="transient" use="required">
<xs:simpleType>
<xs:restriction base="xs:boolean">
<xs:pattern value="true" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
<xs:complexType name="amount">
<xs:annotation>
<xs:documentation>The funding amount.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="currency-code" type="common:currency-code"
use="required" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="currency-code">
<xs:annotation>
<xs:documentation>
The currency code used for funding amounts, from the ISO 4217 list
https://www.iso.org/iso-4217-currency-codes.html .
ORCID will validate this value against the enumeration
java.util.Currency (https://docs.oracle.com/javase/8/docs/api/java/util/Currency.html) and other rules when necessary.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:simpleType name="organization-defined-type">
<xs:annotation>
<xs:documentation>Container for a organization defined type for an
external identifier.
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:string-255">
</xs:restriction>
</xs:simpleType>
<xs:element name="language-code" type="common:language-code"></xs:element>
<xs:simpleType name="language-code">
<xs:annotation>
<xs:documentation>A code to identify the language
that a field value is expressed in, selected from the following options:
ab, aa, af, ak, sq, am, ar, an, hy, as, av, ae, ay, az, bm, ba, eu, be, bn, bh, bi, bs, br, bg, my, ca, ch, ce, zh_CN, zh_TW, cu, cv, kw, co, cr, hr, cs, da, dv, nl, dz, en, eo, et, ee, fo, fj, fi, fr, fy, ff, gl, lg, ka, de, el, kl, gn, gu, ht, ha, iw, hz, hi, ho, hu, is, io, ig, in, ia, ie, iu, ik, ga, it, ja, jv, kn, kr, ks, kk, km, ki, rw, ky, kv, kg, ko, ku, kj, lo, la, lv, li, ln, lt, lu, lb, mk, mg, ms, ml, mt, gv, mi, mr, mh, mo, mn, na, nv, ng, ne, nd, se, no, nb, nn, ny, oc, oj, or, om, os, pi, pa, fa, pl, pt, ps, qu, rm, ro, rn, ru, sm, sg, sa, sc, gd, sr, sn, ii, sd, si, sk, sl, so, nr, st, es, su, sw, ss, sv, tl, ty, tg, ta, tt, te, th, bo, ti, to, ts, tn, tr, tk, tw, ug, uk, ur, uz, ve, vi, vo, wa, cy, wo, xh, ji, yo, za, zu
ORCID will validate this value against the enumeration https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/LanguageCode.java and other rules when necessary.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:complexType name="url">
<xs:annotation>
<xs:documentation>Represents a URL in the XML anyURI format
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:anyURI" />
</xs:simpleContent>
</xs:complexType>
<xs:element name="url" type="common:url" />
<xs:complexType name="address">
<xs:annotation>
<xs:documentation>Container for address information. Only country
information is included at this time.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="common:country" />
</xs:sequence>
</xs:complexType>
<xs:element name="country">
<xs:complexType>
<xs:annotation>
<xs:documentation>Country represented by its ISO 3611 code. The
visibility attribute (private, limited or public) can be set at
record creation, and indicates who can see this section of
information.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="common:iso-3166-country-or-empty">
<xs:attribute name="visibility" type="common:visibility" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:simpleType name="orcid-path">
<xs:annotation>
<xs:documentation>Path for the ORCID iD.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="(\d{4}-){3,}\d{3}[\dX]" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="orcid-uri">
<xs:annotation>
<xs:documentation>ORCID URI for the ORCID iD.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern
value="https://([^/]*orcid\.org|localhost.*/orcid-web)/(\d{4}-){3,}\d{3}[\dX]" />
</xs:restriction>
</xs:simpleType>
<xs:element name="application-group-orcid" type="common:orcid-id" />
<xs:element name="application-orcid" type="common:orcid-id" />
<xs:element name="orcid-identifier" type="common:orcid-id" />
<xs:element name="contributor-orcid" type="common:orcid-id" />
<xs:element name="group-orcid-identifier" type="common:orcid-id" />
<xs:element name="source-orcid" type="common:orcid-id" />
<xs:element name="orcid-id" type="common:orcid-id" />
<xs:complexType name="orcid-id">
<xs:annotation>
<xs:documentation>The identifier of the researcher or contributor in
ORCID (the ORCID iD). At least one of uri or path must be given.
NOTE: this type is also used for legacy client IDs.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element name="uri" type="common:orcid-uri">
<xs:annotation>
<xs:documentation>ORCID iD in URI form (preferred).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="path" type="common:orcid-path"
minOccurs="0">
<xs:annotation>
<xs:documentation>ORCID path (16-character identifier) of the
ORCID iD.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:element name="path" type="common:orcid-path">
<xs:annotation>
<xs:documentation>ORCID path (16-character identifier) of the
ORCID iD.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="host" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>ORCID host (base URL) of the ORCID iD.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="client-path">
<xs:annotation>
<xs:documentation>Path for the API client ID.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="(APP-[\da-zA-Z]{16}|(\d{4}-){3,}\d{3}[\dX])" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="client-uri">
<xs:annotation>
<xs:documentation>ORCID URI for the API client ID.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern
value="https://([^/]*orcid\.org|localhost.*/orcid-web)/client/(APP-[\da-zA-Z]{16}|(\d{4}-){3,}\d{3}[\dX])" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="client-id">
<xs:annotation>
<xs:documentation>The identifier of an ORCID API client app. At least
one of uri or path must be given. NOTE: legacy API clients still may
be identified by the orcid-id type.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element name="uri" type="common:client-uri" />
<xs:element name="path" type="common:client-path"
minOccurs="0" />
</xs:sequence>
<xs:element name="path" type="common:client-path" />
</xs:choice>
<xs:element name="host" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>ORCID host (base URL) of the ORCID iD.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="put-code">
<xs:annotation>
<xs:documentation>The put-code attribute is present only when reading
elements. The code must be used when PUTing (updating) items that
contain the attribute (works, affiliations, etc) to ensure that the
existing item's history is retained.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:integer">
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="element-path">
<xs:annotation>
<xs:documentation>The activity-path attribute is present only when
reading elements. It will be of the form /{orcid}/{activity-name}/{put-code} for
activity elements or /{orcid}/person/{element-name}/{put-code} for person element
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="visibility">
<xs:annotation>
<xs:documentation>Indicates who can see the value of the element when
reading the ORCID record. See the enumerations for definitions of
each value, private, limited, public, registered-only.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="private">
<xs:annotation>
<xs:documentation>The data can only be seen by the researcher or
contributor. This data may be used internally by ORCID for Record
disambiguation purposes.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="limited">
<xs:annotation>
<xs:documentation>The data can only be seen by trusted parties
(organizations or people) as indicated by the researcher or
contributor. This information is only shared with systems that the
researcher or contributor has specifically granted authorization
(using OAuth).
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="public">
<xs:annotation>
<xs:documentation>The data can be seen by anyone. It is publically
available via the ORCID Registry website and the public API
without further authroization by the researcher or contributor.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="registered-only">
<xs:annotation>
<xs:documentation>The data is shared only with the registered user.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="email">
<xs:annotation>
<xs:documentation>Type to represent an email address.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="350" />
<xs:pattern value="[^@]+@[^\.]+\..+" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="year">
<xs:annotation>
<xs:documentation>4-digit integer representing a year of a date.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:integer">
<xs:minInclusive value="1900"/>
<xs:maxInclusive value="2100"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="month">
<xs:annotation>
<xs:documentation>2-digit integer representing a month of a date.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:integer">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="12"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="day">
<xs:annotation>
<xs:documentation>2-digit integer representing a day of a date.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:integer">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="31"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="fuzzy-date" type="common:fuzzy-date" />
<xs:element name="start-date" type="common:fuzzy-date" />
<xs:element name="end-date" type="common:fuzzy-date" />
<xs:element name="publication-date" type="common:fuzzy-date" />
<xs:complexType name="fuzzy-date">
<xs:annotation>
<xs:documentation>In some places the full date is not required.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="year">
<xs:annotation>
<xs:documentation>Used with the fuzzy-date type. Represents the
year
of the date.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:simpleContent>
<xs:extension base="common:year" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:sequence minOccurs="0">
<xs:element name="month">
<xs:annotation>
<xs:documentation>Used with the fuzzy-date type. Represents the
month
of the date.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:simpleContent>
<xs:extension base="common:month" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="day" minOccurs="0">
<xs:annotation>
<xs:documentation>Used with the fuzzy-date type. Represents the
day
of the date.
</xs:documentation>
</xs:annotation>
<xs:complexType mixed="true">
<xs:simpleContent>
<xs:extension base="common:day" />
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="iso-3166-country">
<xs:annotation>
<xs:documentation>ISO 3166-1 alpha-2 country code from https://www.iso.org/iso-3166-country-codes.html .
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:simpleType name="iso-3166-country-or-empty">
<xs:annotation>
<xs:documentation>Contains either a country code or an empty value
</xs:documentation>
</xs:annotation>
<xs:union memberTypes="common:iso-3166-country" />
</xs:simpleType>
<xs:simpleType name="empty">
<xs:annotation>
<xs:documentation>An empty string</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="short-text">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 500
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-150">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 150
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:non-empty-string">
<xs:maxLength value="150" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-200">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 200
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="200" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-255">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 255
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="255" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-350">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 350
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:non-empty-string">
<xs:maxLength value="350" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-1000">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 1000
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:non-empty-string">
<xs:maxLength value="1000" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="string-2084">
<xs:annotation>
<xs:documentation>A non-empty string that has a maximum size of 2084
characters
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:non-empty-string">
<xs:maxLength value="2084" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="string-with-lang-code">
<xs:annotation>
<xs:documentation>A non-empty string that includes a language code to
indicate the language used for the string's value.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="common:non-empty-string">
<xs:attribute name="language-code" type="common:language-code"
use="required" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="short-description">
<xs:annotation>
<xs:documentation>A short narrative (few sentences) describing the
item.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="5000" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="long-text">
<xs:annotation>
<xs:documentation>Must contain one or more charaters that are not a
space, carriage return or linefeed
</xs:documentation>
</xs:annotation>
<xs:restriction base="common:non-empty-string">
<xs:maxLength value="4000" />
</xs:restriction>
</xs:simpleType>
<xs:complexType name="credit-name">
<xs:annotation>
<xs:documentation>The name to use for the researcher or contributor
when credited or cited, for example, in an article or index, or as a
funding contributor. The value of this field also is used as the
display name for the researcher or contributor in the ORCID Registry
in their ORCID Record, or when listed as a contributor on other
ORCID Records. If this element is NULL, given-name family-name will
be used for display purposes, with a visibility of "public". The
visibility attribute (private, limited or public) can be set at
record creation, and indicates who can see this section of
information.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="common:string-150" />
</xs:simpleContent>
</xs:complexType>
<xs:element name="title" type="common:string-1000">
<xs:annotation>
<xs:documentation>The main name or title of the work. For a
spin-off
company, include use the company name
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="subtitle">
<xs:annotation>
<xs:documentation>If the work has a subtitle, include it here.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="1000"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="translated-title">
<xs:complexType>
<xs:annotation>
<xs:documentation>The main title of the work or funding translated
into another language. The translated language will be included in
the <language-code> attribute.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:restriction base="common:string-with-lang-code">
<xs:maxLength value="1000" />
</xs:restriction>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:complexType name="contributor-email">
<xs:annotation>
<xs:documentation>Email of the collaborator or other contributor.
When provided during creation or update, the email address is used
to look up and add the contributor's ORCID iD.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="common:email" />
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="contributor-attributes">
<xs:annotation>
<xs:documentation>Provides detail of the nature of the contribution
by the collaborator or other contirbutor.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="contributor-sequence" type="common:contributor-sequence"
minOccurs="0" />
<xs:element name="contributor-role" type="common:contributor-role"
minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:simpleType name="contributor-sequence">
<xs:annotation>
<xs:documentation>Indication of where in the contributor list the
collaborator or other contributor's name should appear, selected from the following options:
* first
* additional
ORCID will validate this value against the enumeration
https://github.com/ORCID/orcid-model/blob/master/src/main/java/org/orcid/jaxb/model/common/SequenceType.java
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:simpleType name="contributor-role">
<xs:annotation>
<xs:documentation>
The role performed by the collaborator or other contributor.
There are two controlled vocabularies that can be used. Any value not on these lists will be rejected by the API.
Original role values
--------------
author
assignee
editor
chair-or-translator
co-investigator
co-inventor
graduate-student
other-inventor
principal-investigator
postdoctoral-researcher
support-staff
Note: support for original roles will be removed in future versions of the API.
CREDIT role values
------------
http://credit.niso.org/contributor-roles/conceptualization/
http://credit.niso.org/contributor-roles/data-curation/
http://credit.niso.org/contributor-roles/formal-analysis/
http://credit.niso.org/contributor-roles/funding-acquisition/
http://credit.niso.org/contributor-roles/investigation/
http://credit.niso.org/contributor-roles/methodology/
http://credit.niso.org/contributor-roles/project-administration/
http://credit.niso.org/contributor-roles/resources/
http://credit.niso.org/contributor-roles/software/
http://credit.niso.org/contributor-roles/supervision/
http://credit.niso.org/contributor-roles/validation/
http://credit.niso.org/contributor-roles/visualization/
http://credit.niso.org/contributor-roles/writing-original-draft/
http://credit.niso.org/contributor-roles/writing-review-editing/
Note: these roles use URIs as terms, so that they have a distinct namespace from the original roles.
More information on roles can be found in our documentation at https://info.orcid.org/documentation/integration-and-api-faq/#easy-faq-2721
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string" />
</xs:simpleType>
<xs:complexType name="element-summary">
<xs:sequence>
<xs:element ref="common:created-date" minOccurs="0"
maxOccurs="1" />
<xs:element ref="common:last-modified-date" minOccurs="0"
maxOccurs="1" />
<xs:element ref="common:source" minOccurs="0" maxOccurs="1" />
</xs:sequence>
<xs:attribute name="put-code" type="common:put-code" use="optional" />
<xs:attribute name="visibility" type="common:visibility" />
<xs:attribute name="display-index" type="xs:string" use="optional" />
<xs:attribute name="path" type="common:element-path" use="optional" />
</xs:complexType>
<xs:complexType name="affiliation-summary">
<xs:complexContent>
<xs:extension base="common:element-summary">
<xs:sequence>
<xs:element name="department-name" type="common:long-text"
minOccurs="0" maxOccurs="1" />
<xs:element name="role-title" type="common:long-text"
minOccurs="0" maxOccurs="1" />
<xs:element ref="common:start-date" minOccurs="0"
maxOccurs="1" />
<xs:element ref="common:end-date" minOccurs="0"
maxOccurs="1" />
<xs:element name="organization" type="common:organization"
minOccurs="1" maxOccurs="1" />
<xs:element ref="common:url" minOccurs="0" />
<xs:element ref="common:external-ids" minOccurs="0" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="affiliation">
<xs:complexContent>
<xs:extension base="common:element-summary">
<xs:sequence>
<xs:element name="department-name" type="common:long-text"
minOccurs="0" maxOccurs="1" />
<xs:element name="role-title" type="common:long-text"
minOccurs="0" maxOccurs="1" />
<xs:element ref="common:start-date" minOccurs="0"
maxOccurs="1" />
<xs:element ref="common:end-date" minOccurs="0"
maxOccurs="1" />