-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCredentialRequest.cs
More file actions
902 lines (747 loc) · 34.8 KB
/
Copy pathCredentialRequest.cs
File metadata and controls
902 lines (747 loc) · 34.8 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
// <copyright file="CredentialRequest.cs" company="Credential Engine">
// Copyright (c) Credential Engine. All rights reserved.
// </copyright>
// <license>Apache License 2.0 - https://www.apache.org/licenses/LICENSE-2.0</license>
using System.Collections.Generic;
using Newtonsoft.Json;
namespace RA.Models.Input
{
/// <summary>
/// Class used with a Credential format or publish request
/// June 24, 2020 - added BaseSalary (Monetary Amount)
/// </summary>
public class CredentialRequest : BaseRequest
{
/// <summary>
/// constructor
/// </summary>
public CredentialRequest()
{
Credential = new Credential();
}
/// <summary>
/// Credential Input Class
/// </summary>
public Credential Credential { get; set; }
}
/// <summary>
/// PROTOTYPE - NOT ALLOWED IN PRODUCTION
/// Allow publishing up to 50 credentials at a time.
/// Only used by the endpoint: bulkPublish
/// </summary>
public class BulkCredentialRequest : BaseRequest
{
public BulkCredentialRequest()
{
}
/// <summary>
/// List of credentials to publish
/// </summary>
public List<Credential> Credentials { get; set; } = new List<Credential>();
}
public class CopyRequest : BaseRequest
{
public CopyRequest()
{
}
/// <summary>
/// Optionally provide a list of CTIDs for records to copy
/// A maximum of 50 CTIDs may be requested at a time.
/// </summary>
public List<string> CTIDList { get; set; } = new List<string>();
}
/// <summary>
/// Credential input class
/// </summary>
public class Credential : BaseRequestHelper
{
/// <summary>
/// constructor
/// </summary>
public Credential()
{
Type = "Credential";
AudienceLevelType = new List<string>();
AudienceType = new List<string>();
AvailableAt = new List<Place>();
DegreeConcentration = new List<string>();
DegreeMajor = new List<string>();
DegreeMinor = new List<string>();
InLanguage = new List<string>();
Keyword = new List<string>();
OccupationType = new List<FrameworkItem>();
OwnedBy = new List<OrganizationReference>();
IndustryType = new List<FrameworkItem>();
Naics = new List<string>();
Subject = new List<string>();
AccreditedBy = new List<Input.OrganizationReference>();
ApprovedBy = new List<Input.OrganizationReference>();
OfferedBy = new List<Input.OrganizationReference>();
RecognizedBy = new List<Input.OrganizationReference>();
RegulatedBy = new List<Input.OrganizationReference>();
RenewedBy = new List<Input.OrganizationReference>();
RevokedBy = new List<Input.OrganizationReference>();
Corequisite = new List<ConditionProfile>();
Recommends = new List<ConditionProfile>();
Requires = new List<ConditionProfile>();
CommonConditions = new List<string>();
CommonCosts = new List<string>();
HasPart = new List<EntityReference>();
IsPartOf = new List<EntityReference>();
AdvancedStandingFrom = new List<ConditionProfile>();
IsAdvancedStandingFor = new List<ConditionProfile>();
PreparationFrom = new List<ConditionProfile>();
IsPreparationFor = new List<ConditionProfile>();
IsRecommendedFor = new List<ConditionProfile>();
IsRequiredFor = new List<ConditionProfile>();
Renewal = new List<ConditionProfile>();
AdministrationProcess = new List<ProcessProfile>();
DevelopmentProcess = new List<ProcessProfile>();
MaintenanceProcess = new List<ProcessProfile>();
AppealProcess = new List<ProcessProfile>();
ComplaintProcess = new List<ProcessProfile>();
ReviewProcess = new List<ProcessProfile>();
RevocationProcess = new List<ProcessProfile>();
}
/// <summary>
/// Helper property for use with blank nodes
/// This is a 'broad' type. CredentialType is still required.
/// </summary>
public string Type { get; set; }
/// <summary>
/// Handle both forms of input for type
/// </summary>
[JsonProperty( "@type" )]
public string AtType
{
get { return Type; }
set { Type = value; }
}
#region *** Required Properties ***
/// <summary>
/// The credential type as defined in CTDL
/// <see href="https://credreg.net/page/typeslist"/>
/// Required
/// NOTE: The following types are 'top level' types that may not be published:
/// Credential, Degree
/// Only the sub-types under the latter may be used in publishing
/// </summary>
public string CredentialType { get; set; }
/// <summary>
/// Name or title of the resource.
/// Required
/// </summary>
public string Name { get; set; }
/// <summary>
/// LanguageMap for Name
/// </summary>
[JsonProperty( PropertyName = "ceterms:name" )]
public LanguageMap NameLangMap { get; set; } = null;
/// <summary>
/// Description
/// REQUIRED and must be a minimum of 15 characters.
/// </summary>
public string Description { get; set; }
/// <summary>
/// Alternately can provide a language map
/// </summary>
[JsonProperty( PropertyName = "ceterms:description" )]
public LanguageMap DescriptionLangMap { get; set; } = null;
/// <summary>
/// Organization that owns this credential
/// Required
/// </summary>
public List<OrganizationReference> OwnedBy { get; set; }
[JsonProperty( PropertyName = "ceterms:ownedBy" )]
public List<string> OwnedByList { get; set; }
/// <summary>
/// The status type of this credential.
/// Required
/// The default is Active.
/// </summary>
public string CredentialStatusType { get; set; }
[JsonProperty( PropertyName = "ceterms:credentialStatusType" )]
public RA.Models.JsonV2.CredentialAlignmentObject CredentialStatusType2 { get; set; }
/// <summary>
/// Globally unique Credential Transparency Identifier
/// format:
/// ce-UUID (guid)
/// Required
/// </summary>
public string CTID { get; set; }
/// <summary>
/// Webpage that describes this entity.
/// Required
/// URL
/// </summary>
public string SubjectWebpage { get; set; }
/// <summary>
/// The primary language or languages of the entity, even if it makes use of other languages; e.g., a course offered in English to teach Spanish would have an inLanguage of English, while a credential in Quebec could have an inLanguage of both French and English.
/// Required
/// List of language codes. ex: en, es
/// </summary>
public List<string> InLanguage { get; set; }
#endregion
/// <summary>
/// List of Alternate Names for this credential
/// </summary>
public List<string> AlternateName { get; set; } = new List<string>();
/// <summary>
/// LanguageMap for AlternateName
/// </summary>
[JsonProperty( PropertyName = "ceterms:alternateName" )]
public LanguageMapList AlternateNameLangMap { get; set; } = null;
/// <summary>
/// The type of credential seeker for whom the entity is applicable; select from an existing enumeration of such types.
/// audience:Citizen audience:CurrentMilitary audience:CurrentMilitaryDependent audience:CurrentMilitarySpouse audience:CurrentStudent audience:FormerMilitary audience:FormerMilitaryDependent audience:FormerMilitarySpouse audience:FormerStudent audience:FullTime audience:Member audience:NonCitizen audience:NonMember audience:NonResident audience:PartTime audience:PrivateEmployee audience:PublicEmployee audience:Resident
/// <see href="https://credreg.net/ctdl/terms/Audience"></see>
/// </summary>
public List<string> AudienceType { get; set; }
/// <summary>
/// Type of level indicating a point in a progression through an educational or training context, for which the credential is intended; select from an existing enumeration of such types.
/// audLevel:AdvancedLevel audLevel:AssociatesDegreeLevel audLevel:BachelorsDegreeLevel audLevel:BeginnerLevel audLevel:DoctoralDegreeLevel audLevel:GraduateLevel audLevel:IntermediateLevel audLevel:LowerDivisionLevel audLevel:MastersDegreeLevel audLevel:PostSecondaryLevel audLevel:ProfessionalLevel audLevel:SecondaryLevel audLevel:UndergraduateLevel audLevel:UpperDivisionLevel
/// <see href="https://credreg.net/ctdl/terms/AudienceLevel"></see>
/// </summary>
public List<string> AudienceLevelType { get; set; } = new List<string>();
/// <summary>
/// Delivery type for the assessment for the credential.
/// deliveryType:BlendedDelivery deliveryType:InPerson deliveryType:OnlineOnly
/// <see href="https://credreg.net/ctdl/terms/Delivery"></see>
/// </summary>
public List<string> AssessmentDeliveryType { get; set; } = new List<string>();
/// <summary>
/// AvailableOnlineAt URL
/// 22-08-30 Changed to an object to allow handling of a single or a list
/// </summary>
public object AvailableOnlineAt { get; set; }
/// <summary>
/// AvailabilityListing URL
/// 22-08-30 Changed to an object to allow handling of a single or a list
/// </summary>
public object AvailabilityListing { get; set; }
/// <summary>
/// List of Addresses for this credential, using Place
/// </summary>
public List<Place> AvailableAt { get; set; }
/// <summary>
/// Indicates the stage or level of achievement in a progression of learning.
/// The Target can be a ProgressionLevel or a Concept. Typically just a CTID needs to be provided.
/// If the Target is not in the registry, then both the ProgressionModel (framework) and ProgressLevel (targetNode) will be required.
/// range: ceterms:CredentialAlignmentObject
/// </summary>
public List<CredentialAlignmentObject> AtLevel { get; set; }
/// <summary>
/// Person or organization holding the rights in copyright to entities such as credentials, learning opportunities, assessments, competencies or concept schemes.
/// </summary>
public OrganizationReference CopyrightHolder { get; set; }
/// <summary>
/// Credential Identifier
/// Globally unique identifier by which the creator, owner or provider of a credential recognizes that credential in transactions with the external environment (e.g., in verifiable claims involving the credential).
/// NOTE: Acronyns should not be used here. Use AlternateName for providing acronyms.
/// </summary>
public string CredentialId { get; set; }
/// <summary>
/// GovernmentCredentialType: Type of credential as defined by an authoritative body
/// for use within an officially regulated qualification system.
/// The actual CTDL term is ceterms:credentialType, but the latter property is already in use,
/// so using GovernmentCredentialType as the input class
/// <see cref="https://purl.org/ctdl/terms/credentialType"/>
/// Range: is an object of type: CredentialType
/// </summary>
public List<string> GovernmentCredentialType { get; set; }
/// <summary>
/// Effective date of the content of this profile
/// ceterms:dateEffective
/// </summary>
public string DateEffective { get; set; }
/// <summary>
/// Date beyond which the resource is no longer offered or available.
/// Previously earned, completed, or attained resources may still be valid even if they are no longer offered.
/// </summary>
public string ExpirationDate { get; set; }
#region -- Quality Assurance BY --
/// <summary>
/// List of Organizations that accredit this credential
/// </summary>
public List<OrganizationReference> AccreditedBy { get; set; }
/// <summary>
/// List of Organizations that approve this credential
/// </summary>
public List<OrganizationReference> ApprovedBy { get; set; }
/// <summary>
/// List of Organizations that offer this credential
/// </summary>
public List<OrganizationReference> OfferedBy { get; set; }
/// <summary>
/// List of Organizations that recognize this credential
/// </summary>
public List<OrganizationReference> RecognizedBy { get; set; }
/// <summary>
/// Organization(s) that register this resource.
/// Only allowed for Apprenticeship related certificates. Currently:
/// ceterms:ApprenticeshipCertificate, ceterms:JourneymanCertificate, ceterms:MasterCertificate, ceterms:PreApprenticeshipCertificate
/// </summary>
public List<OrganizationReference> RegisteredBy { get; set; } = new List<Input.OrganizationReference>();
/// <summary>
/// List of Organizations that regulate this credential
/// </summary>
public List<OrganizationReference> RegulatedBy { get; set; }
/// <summary>
/// List of Organizations that renew this credential
/// </summary>
public List<OrganizationReference> RenewedBy { get; set; }
/// <summary>
/// List of Organizations that can revoke this credential
/// </summary>
public List<OrganizationReference> RevokedBy { get; set; }
#endregion
#region Quality Assurance IN - Jurisdiction based Quality Assurance (INs)
/// <summary>
/// List of Organizations that accredit this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> AccreditedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that approve this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> ApprovedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that offer this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> OfferedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that recognize this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> RecognizedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that regulate this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> RegulatedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that renew this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> RenewedIn { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// List of Organizations that revoke this credential in a specific Jurisdiction.
/// </summary>
public List<JurisdictionProfile> RevokedIn { get; set; } = new List<JurisdictionProfile>();
#endregion
#region Costs, duration, assistance
/// <summary>
/// List of CTIDs (recommended) or full URLs for a CostManifest published by the owning organization.
/// Set of costs maintained at an organizational or sub-organizational level, which apply to this credential.
/// </summary>
public List<string> CommonCosts { get; set; }
/// <summary>
/// List of cost profiles for this credential
/// </summary>
public List<CostProfile> EstimatedCost { get; set; } = new List<CostProfile>();
/// <summary>
/// Estimated time it will take to complete an activity, event, or resource.
/// List of duration profiles expressing one or more duration profiles to attain this resource.
/// </summary>
public List<DurationProfile> EstimatedDuration { get; set; }
/// <summary>
/// Entity that describes financial assistance that is offered or available.
/// </summary>
public List<FinancialAssistanceProfile> FinancialAssistance { get; set; }
#endregion
/// <summary>
/// List of credentials that are part of this credential
/// </summary>
public List<EntityReference> HasPart { get; set; }
/// <summary>
/// Rubric related to this resource.
/// <see cref="https://credreg.net/ctdl/terms/hasRubric"/>
/// ceterms:hasRubric
/// </summary>
public List<string> HasRubric { get; set; } = new List<string>();
/// <summary>
/// Reference to a relevant support service available for this resource.
/// List of CTIDs for published resources
/// </summary>
public List<string> HasSupportService { get; set; } = new List<string>();
/// <summary>
/// Alphanumeric token that identifies this resource and information about the token's originating context or scheme.
/// <see href="https://credreg.net/ctdl/terms/identifier">Identifier</see>
/// ceterms:identifier
/// </summary>
public List<IdentifierValue> Identifier { get; set; } = new List<IdentifierValue>();
/// <summary>
/// Image URL
/// </summary>
public string Image { get; set; }
/// <summary>
/// An inventory or listing of resources that includes this resource.
/// </summary>
public string InCatalog { get; set; }
/// <summary>
/// ISIC Revision 4 Code
/// </summary>
public string ISICV4 { get; set; }
/// <summary>
/// Is Non-Credit
/// Resource carries or confers no official academic credit towards a program or a credential.
/// </summary>
public bool? IsNonCredit { get; set; }
/// <summary>
/// List of credentials where this credential is a part of.
/// </summary>
public List<EntityReference> IsPartOf { get; set; }
/// <summary>
/// Jurisdiction Profile
/// Geo-political information about applicable geographic areas and their exceptions.
/// <see href="https://credreg.net/ctdl/terms/JurisdictionProfile">JurisdictionProfile</see>
/// </summary>
public List<JurisdictionProfile> Jurisdiction { get; set; } = new List<JurisdictionProfile>();
/// <summary>
/// Keyword or key phrase describing relevant aspects of an entity.
/// </summary>
public List<string> Keyword { get; set; }
/// <summary>
/// Language map list for Keyword
/// </summary>
[JsonProperty( PropertyName = "ceterms:keyword" )]
public LanguageMapList KeywordLangMap { get; set; } = null;
/// <summary>
/// Delivery type for the learning opportunity for the credential.
/// deliveryType:BlendedDelivery deliveryType:InPerson deliveryType:OnlineOnly
/// <see href="https://credreg.net/ctdl/terms/Deliver">Deliver</see>
/// </summary>
public List<string> LearningDeliveryType { get; set; } = new List<string>();
/// <summary>
/// Types of methods used to conduct the learning opportunity;
/// Concepts: Applied, Gaming, Laboratory, Lecture, Prerecorded, SelfPaced, Seminar, WorkBased
/// ConceptScheme: <see href="https://credreg.net/ctdl/terms/LearningMethod">LearningMethod</see>
/// </summary>
public List<string> LearningMethodType { get; set; }
/// <summary>
/// Learning Method Description
/// Description of the learning methods for a resource.
/// </summary>
public string LearningMethodDescription { get; set; }
/// <summary>
/// Alternately can provide a language map
/// </summary>
[JsonProperty( PropertyName = "ceterms:learningMethodDescription" )]
public LanguageMap LearningMethodDescriptionLangMap { get; set; } = null;
/// <summary>
/// Webpage or online document that describes the criteria, standards, and/or requirements used with a process.
/// </summary>
public string ProcessStandards { get; set; }
/// <summary>
/// Textual description of the criteria, standards, and/or requirements used with a process
/// </summary>
public string ProcessStandardsDescription { get; set; }
/// <summary>
/// Language map - Textual description of the criteria, standards, and/or requirements used with a process
/// </summary>
[JsonProperty( PropertyName = "ceterms:processStandardsDescription" )]
public LanguageMap ProcessStandardsDescriptionLangMap { get; set; }
/// <summary>
/// This resource provides transfer value for the referenced Transfer Value Profile.
/// Refer to the referenced Transfer Value Profile for more information. Other resources may be included for the full value.
/// </summary>
public List<string> ProvidesTransferValueFor { get; set; } = new List<string>();
/// <summary>
/// This resource receives transfer value from the referenced Transfer Value Profile.
/// Refer to the referenced Transfer Value Profile for more information. Other resources may be included for the full value.
/// </summary>
public List<string> ReceivesTransferValueFrom { get; set; } = new List<string>();
#region Version related properties
//
/// <summary>
/// Latest version of the credential.
/// full URL OR CTID (recommended)
/// </summary>
public string LatestVersion { get; set; }
/// <summary>
/// Version of the resource that immediately precedes this version.
/// full URL OR CTID (recommended)
/// </summary>
public string PreviousVersion { get; set; }
/// <summary>
/// Version of the resource that immediately follows this version.
/// full URL OR CTID (recommended)
/// </summary>
public string NextVersion { get; set; }
/// <summary>
/// Resource that replaces this resource.
/// full URL OR CTID (recommended)
/// </summary>
public string SupersededBy { get; set; }
/// <summary>
/// Resource that this resource replaces.
/// full URL OR CTID (recommended)
/// </summary>
public string Supersedes { get; set; }
/// <summary>
/// alphanumeric identifier of the version of the resource that is unique within the organizational context of its owner and which does not need the context of other information in order to be interpreted.
/// </summary>
public string VersionCode { get; set; }
/// <summary>
/// VersionIdentifier
/// Alphanumeric identifier of the version of the credential that is unique within the organizational context of its owner.
/// The credential version captured here is any local identifier used by the credential owner to identify the version of the credential in the its local system.
/// </summary>
public List<IdentifierValue> VersionIdentifier { get; set; } = new List<IdentifierValue>();
#endregion
/// <summary>
/// Frequency with which the credential needs to be renewed.
/// A single DurationItem, using Years, Months, etc. or a combination.
/// Alternately the actual ISO8601 format may be provided (using Duration_ISO8601)
/// </summary>
public DurationItem RenewalFrequency { get; set; }
/// <summary>
/// Revocation Profile
/// Entity describing conditions and methods by which a credential can be removed from a holder.
/// </summary>
public List<RevocationProfile> Revocation { get; set; } = new List<RevocationProfile>();
/// <summary>
/// Another source of information about the entity being described.
/// HINT: If the SameAs target is a resource in the Credential Registry, just the CTID needs to be provided.
/// ceterms:sameAs
/// </summary>
public List<string> SameAs { get; set; } = new List<string>();
/// <summary>
/// Words or brief phrases describing the topicality of the entity; select subject terms from an existing enumeration of such terms.
/// </summary>
public List<string> Subject { get; set; } = new List<string>();
/// <summary>
/// Language map list for Subject
/// </summary>
[JsonProperty( PropertyName = "ceterms:subject" )]
public LanguageMapList SubjectLangMap { get; set; } = new LanguageMapList();
#region Occupations, Industries, and instructional programs
// =====================================================================
// List of occupations from a published framework, that is with a web URL
/// <summary>
/// OccupationType
/// Type of occupation; select from an existing enumeration of such types.
/// For U.S. credentials, best practice is to identify an occupation using a framework such as the O*Net.
/// Other credentials may use any framework of the class ceterms:OccupationClassification, such as the EU's ESCO, ISCO-08, and SOC 2010.
/// </summary>
public List<FrameworkItem> OccupationType { get; set; }
[JsonProperty( PropertyName = "ceterms:occupationType" )]
public List<RA.Models.JsonV2.CredentialAlignmentObject> OccupationTypeList { get; set; }
/// <summary>
/// AlternativeOccupationType
/// Occupations that are not found in a formal framework can be still added using AlternativeOccupationType.
/// Any occupations added using this property will be added to or appended to the OccupationType output.
/// </summary>
public List<string> AlternativeOccupationType { get; set; } = new List<string>();
/// <summary>
/// Language map list for AlternativeOccupationType
/// </summary>
public LanguageMapList AlternativeOccupationTypeLangMap { get; set; } = new LanguageMapList();
/// <summary>
/// List of valid O*Net codes. See:
/// https://www.onetonline.org/find/
/// The API will validate and format the ONet codes as Occupations
/// </summary>
public List<string> ONET_Codes { get; set; } = new List<string>();
// =============================================================================
/// <summary>
/// IndustryType
/// Type of industry; select from an existing enumeration of such types such as the SIC, NAICS, and ISIC classifications.
/// Best practice in identifying industries for U.S. credentials is to provide the NAICS code using the ceterms:naics property.
/// Other credentials may use the ceterms:industrytype property and any framework of the class ceterms:IndustryClassification.
/// </summary>
public List<FrameworkItem> IndustryType { get; set; }
/// <summary>
/// AlternativeIndustryType
/// Industries that are not found in a formal framework can be still added using AlternativeIndustryType.
/// Any industries added using this property will be added to or appended to the IndustryType output.
/// </summary>
public List<string> AlternativeIndustryType { get; set; } = new List<string>();
/// <summary>
/// Language map list for AlternativeIndustryType
/// </summary>
public LanguageMapList AlternativeIndustryTypeLangMap { get; set; } = new LanguageMapList();
/// <summary>
/// List of valid NAICS codes. See:
/// https://www.naics.com/search/
/// </summary>
public List<string> Naics { get; set; }
// =============================================================================
/// <summary>
/// InstructionalProgramType
/// Type of instructional program; select from an existing enumeration of such types.
/// </summary>
public List<FrameworkItem> InstructionalProgramType { get; set; } = new List<FrameworkItem>();
/// <summary>
/// AlternativeInstructionalProgramType
/// Programs that are not found in a formal framework can be still added using AlternativeInstructionalProgramType.
/// Any programs added using this property will be added to or appended to the InstructionalProgramType output.
/// </summary>
public List<string> AlternativeInstructionalProgramType { get; set; } = new List<string>();
/// <summary>
/// Language map list for AlternativeInstructionalProgramType
/// </summary>
public LanguageMapList AlternativeInstructionalProgramTypeLangMap { get; set; } = new LanguageMapList();
/// <summary>
/// List of valid Classification of Instructional Program codes. See:
/// https://nces.ed.gov/ipeds/cipcode/search.aspx?y=55
/// </summary>
public List<string> CIP_Codes { get; set; } = new List<string>();
#endregion
#region Properties allowed only for degree types
/// <summary>
/// Focused plan of study within a college or university degree such as a concentration in Aerospace Engineering within an Engineering degree.
/// TODO: enable more detail by using a blank node in ReferenceObject. The latter would be a CredentialAlignmentObject. The Id would be a Guid in DegreeConcentration. Alternately a fully formed blank node id ( _:(GUID) )
/// </summary>
public List<string> DegreeConcentration { get; set; }
/// <summary>
/// Focused plan of study within a college or university degree such as a concentration in Aerospace Engineering within an Engineering degree.
/// </summary>
[JsonProperty( PropertyName = "ceterms:degreeConcentration" )]
public LanguageMapList DegreeConcentrationLangMap { get; set; } = new LanguageMapList();
/// <summary>
/// List for Primary field of study of a degree-seeking student.
/// </summary>
public List<string> DegreeMajor { get; set; }
/// <summary>
/// LanguageMapList for Primary field of study of a degree-seeking student.
/// </summary>
[JsonProperty( PropertyName = "ceterms:degreeMajor" )]
public LanguageMapList DegreeMajorLangMap { get; set; } = new LanguageMapList();
/// <summary>
/// Optional, secondary field of study of a degree-seeking student.
/// </summary>
public List<string> DegreeMinor { get; set; }
/// <summary>
/// LanguageMapList for Optional, secondary field of study of a degree-seeking student.
/// </summary>
[JsonProperty( PropertyName = "ceterms:degreeMinor" )]
public LanguageMapList DegreeMinorLangMap { get; set; } = new LanguageMapList();
#endregion
#region Outcome data
/// <summary>
/// Resource containing summary/statistical employment outcome, earnings, and/or holders information.
/// For deeper information, include qdata:DataSetProfile.
/// </summary>
public List<AggregateDataProfile> AggregateData { get; set; } = new List<AggregateDataProfile>();
#endregion
/// <summary>
/// Uses Verification Service
/// Reference to a service that is used to verify this Credential.
/// Range: ceterms:VerificationServiceProfile
/// List of CTIDs that reference a VerificationServiceProfile in the registry
/// </summary>
public List<string> UsesVerificationService { get; set; } = new List<string>();
/// <summary>
/// Category or classification of this resource.
/// Where a more specific property exists, such as ceterms:naics, ceterms:isicV4, ceterms:credentialType, etc., use that property instead of this one.
/// URI to a concept(based on the ONet work activities example) or to a blank node in RA.Models.Input.BaseRequest.ReferenceObjects
/// ceterms:classification
/// </summary>
public List<string> Classification { get; set; } = new List<string>();
#region -- Condition Profiles --
/// <summary>
/// List of CTIDs or full URLs for a ConditionManifest published by the owning organization
/// </summary>
public List<string> CommonConditions { get; set; }
/// <summary>
/// Requirement or set of requirements for this resource
/// </summary>
public List<ConditionProfile> Requires { get; set; }
/// <summary>
/// Recommended resources for this resource.
/// </summary>
public List<ConditionProfile> Recommends { get; set; }
/// <summary>
/// Resources that must be pursued concurrently.
/// </summary>
public List<ConditionProfile> Corequisite { get; set; }
/// <summary>
/// Resource that must be completed prior to, or pursued at the same time as, this resource.
/// </summary>
public List<ConditionProfile> CoPrerequisite { get; set; } = new List<ConditionProfile>();
/// <summary>
/// Requirements for entry into a credentialing program, a learning opportunity, or an assessment, including credentials, transcripts, records of previous experience, or other forms of entry documentation.
/// </summary>
public List<ConditionProfile> EntryCondition { get; set; } = new List<ConditionProfile>();
/// <summary>
/// Entity describing the constraints, prerequisites, entry conditions, or requirements necessary to maintenance and renewal of an awarded credential.
/// </summary>
public List<ConditionProfile> Renewal { get; set; }
#endregion
#region -- Connections Profiles --
// Connection Profiles are Condition Profiles but typically only a subset of the Condition Profile properties are used.
/// <summary>
/// Credential that has its time or cost reduced by another credential, assessment or learning opportunity.
/// ceterms:advancedStandingFrom
/// <seealso href="https://credreg.net/ctdl/terms/advancedStandingFrom"></seealso>
/// </summary>
public List<ConditionProfile> AdvancedStandingFrom { get; set; }
/// <summary>
/// This credential, assessment, or learning opportunity reduces the time or cost required to earn or complete the referenced credential, assessment, or learning opportunity.
/// <para>A third-party credential agent claiming that its credential provides advanced standing for the credential of another credential agent should consider using ceterms:recommendedFor instead of ceterms:advancedStandingFor in the absence of an explicit and verifiable agreement on advanced standing between the agents of the two credentials.</para>
/// ceterms:isAdvancedStandingFor
/// <seealso href="https://credreg.net/ctdl/terms/isAdvancedStandingFor">isAdvancedStandingFor</seealso>
/// </summary>
public List<ConditionProfile> IsAdvancedStandingFor { get; set; }
/// <summary>
/// This credential, assessment, or learning opportunity provides preparation for the credential, assessment, or learning opportunity being referenced.
/// ceterms:isPreparationFor
/// <seealso href="https://credreg.net/ctdl/terms/isPreparationFor">isPreparationFor</seealso>
/// </summary>
public List<ConditionProfile> IsPreparationFor { get; set; }
/// <summary>
/// It is recommended to earn or complete this credential, assessment, or learning opportunity before attempting to earn or complete the referenced credential, assessment, or learning opportunity.
/// ceterms:isRecommendedFor
/// <seealso href="https://credreg.net/ctdl/terms/isRecommendedFor">isRecommendedFor</seealso>
/// </summary>
public List<ConditionProfile> IsRecommendedFor { get; set; }
/// <summary>
/// This credential, assessment, or learning opportunity must be earned or completed prior to attempting to earn or complete the referenced credential, assessment, or learning opportunity.
/// ceterms:isRequiredFor
/// <seealso href="https://credreg.net/ctdl/terms/isRequiredFor"></seealso>
/// </summary>
public List<ConditionProfile> IsRequiredFor { get; set; }
/// <summary>
/// Another credential, learning opportunity or assessment that provides preparation for this credential, learning opportunity or assessment.
/// ceterms:preparationFrom
/// <seealso href="https://credreg.net/ctdl/terms/preparationFrom"></seealso>
/// </summary>
public List<ConditionProfile> PreparationFrom { get; set; }
#endregion
#region -- Process Profiles --
/// <summary>
/// Description of a process by which a resource is administered.
/// ceterms:administrationProcess
/// </summary>
public List<ProcessProfile> AdministrationProcess { get; set; }
/// <summary>
/// Description of a formal process for objecting to decisions of an organization.
/// </summary>
public List<ProcessProfile> AppealProcess { get; set; }
/// <summary>
/// Description of a process for handling complaints about a resource or related resources.
/// </summary>
public List<ProcessProfile> ComplaintProcess { get; set; }
/// <summary>
/// Description of a process by which a resource was created.
/// </summary>
public List<ProcessProfile> DevelopmentProcess { get; set; }
/// <summary>
/// Description of a process by which a resource is maintained, including review and updating.
/// </summary>
public List<ProcessProfile> MaintenanceProcess { get; set; }
/// <summary>
/// Description of a process by which a resource is reviewed.
/// </summary>
public List<ProcessProfile> ReviewProcess { get; set; }
/// <summary>
/// Entity describing the process by which the credential is revoked.
/// </summary>
public List<ProcessProfile> RevocationProcess { get; set; }
#endregion
/// <summary>
/// Action related to the credential
/// list of CTIDs
/// </summary>
public List<string> RelatedAction { get; set; }
// TargetPathway
// NOTE: the TargetPathway is an inverse property for a credential. That is, it will not be published with the credential, and is instead derived via a PathwayComponent
}
}