education

Documentation

Index

• type AwardedBy
• type CredentialSubject
• type Data
• type DiplomaAddress
• type DiplomaAssessedBy
• type DiplomaAwardingBody
• type DiplomaDefinition
• type DiplomaDocument
  • func NewDiploma() *DiplomaDocument
  • func (d *DiplomaDocument) AddCredentialSubject(dateOfBirth, awardingDate, noteLiteral string)
  • func (d *DiplomaDocument) AddDisplayParameter(base64Image, imageContentType string)
  • func (d *DiplomaDocument) Marshal() (map[string]any, error)
• type DiplomaGrade
• type DiplomaInScheme
• type DiplomaIndividualDisplay
• type DiplomaLocation
• type DiplomaNoteFormat
• type DiplomaPrefLabel
• type DiplomaUsed
• type DisplayDetail
• type DisplayParameter
• type ELMDocument
  • func (d *ELMDocument) Marshal() (map[string]any, error)
• type Fat
• type HasClaim
• type Identifier
• type MCAchievement
• type MCAlignment
• type MCCredentialSchema
• type MCCredentialSubject
• type MCCriteria
• type MCImage
• type MCIssuer
• type MCIssuerAddress
• type MCResult
• type MCResultDescription
• type MediaObject
• type MicroCredentialDocument
  • func (d *MicroCredentialDocument) Marshal() (map[string]any, error)
• type OpenbadgeBasicDocument
  • func (d *OpenbadgeBasicDocument) Marshal() (map[string]any, error)
• type OpenbadgeCompleteDocument
  • func (d *OpenbadgeCompleteDocument) Marshal() (map[string]any, error)
• type OpenbadgeEndorsementDocument
  • func (d *OpenbadgeEndorsementDocument) Marshal() (map[string]any, error)
• type Title

Types

type AwardedBy

type AwardedBy struct {
	ID           string              `json:"id"`
	Type         string              `json:"type"`
	AwardingBody DiplomaAwardingBody `json:"awardingBody"`
	AwardingDate string              `json:"awardingDate"`
	Used         DiplomaUsed         `json:"used"`
}

type CredentialSubject

type CredentialSubject struct {
	ID          string   `json:"id"`
	Type        string   `json:"type"`
	DateOfBirth string   `json:"dateOfBirth"`
	HasClaim    HasClaim `json:"hasClaim"`
}

type Data

type Data struct {
	ID         string `json:"id"`
	Notation   string `json:"notation"`
	SchemeName string `json:"schemeName"`
	Type       string `json:"type"`
}

type DiplomaAddress

type DiplomaAddress struct {
	ID          string `json:"id"`
	Type        string `json:"type"`
	CountryCode Fat    `json:"countryCode"`
}

type DiplomaAssessedBy

type DiplomaAssessedBy struct {
	ID         string            `json:"id"`
	Type       string            `json:"type"`
	Location   DiplomaLocation   `json:"location"`
	Identifier []Fat             `json:"identifier"`
	LegalName  map[string]string `json:"legalName"`
	Homepage   Fat               `json:"homepage"`
}

type DiplomaAwardingBody

type DiplomaAwardingBody struct {
	ID         string            `json:"id"`
	Type       string            `json:"type"`
	Location   DiplomaLocation   `json:"location"`
	Identifier []Fat             `json:"identifier"`
	LegalName  map[string]string `json:"legalName"`
	Homepage   Fat               `json:"homepage"`
}

type DiplomaDefinition

type DiplomaDefinition struct {
	UND string `json:"UND"`
}

type DiplomaDocument

type DiplomaDocument struct {
	Type               []string          `json:"type" validate:"required"`
	CredentialProfiles Fat               `json:"credentialProfiles"`
	DisplayParameter   *DisplayParameter `json:"displayParameter"`
	CredentialSchema   Fat               `json:"credentialSchema"`
	CredentialSubject  CredentialSubject `json:"credentialSubject"`
}

func NewDiploma

func NewDiploma() *DiplomaDocument

func (*DiplomaDocument) AddCredentialSubject

func (d *DiplomaDocument) AddCredentialSubject(dateOfBirth, awardingDate, noteLiteral string)

func (*DiplomaDocument) AddDisplayParameter

func (d *DiplomaDocument) AddDisplayParameter(base64Image, imageContentType string)

func (*DiplomaDocument) Marshal

func (d *DiplomaDocument) Marshal() (map[string]any, error)

type DiplomaGrade

type DiplomaGrade struct {
	ID          string            `json:"id"`
	Type        string            `json:"type"`
	NoteFormat  DiplomaNoteFormat `json:"noteFormat"`
	NoteLiteral string            `json:"noteLiteral"`
}

type DiplomaInScheme

type DiplomaInScheme struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

type DiplomaIndividualDisplay

type DiplomaIndividualDisplay struct {
	ID            string        `json:"id"`
	Type          string        `json:"type"`
	DisplayDetail DisplayDetail `json:"displayDetail"`
	Language      Fat           `json:"language"`
}

type DiplomaLocation

type DiplomaLocation struct {
	ID      string         `json:"id"`
	Type    string         `json:"type"`
	Address DiplomaAddress `json:"address"`
}

type DiplomaNoteFormat

type DiplomaNoteFormat struct {
	ID         string            `json:"id"`
	Type       string            `json:"type"`
	Definition DiplomaDefinition `json:"definition"`
}

type DiplomaPrefLabel

type DiplomaPrefLabel struct {
	En string `json:"en"`
}

type DiplomaUsed

type DiplomaUsed struct {
	ID         string            `json:"id"`
	Type       string            `json:"type"`
	AssessedBy DiplomaAssessedBy `json:"assessedBy"`
}

type DisplayDetail

type DisplayDetail struct {
	ID    string      `json:"id"`
	Type  string      `json:"type"`
	Image MediaObject `json:"image"`
	Page  int         `json:"page"`
}

type DisplayParameter

type DisplayParameter struct {
	ID                string                   `json:"id"`
	Type              string                   `json:"type"`
	IndividualDisplay DiplomaIndividualDisplay `json:"individualDisplay"`
	DisplayDetail     DisplayDetail            `json:"displayDetail"`
	PrimaryLanguage   Fat                      `json:"primaryLanguage"`
	Language          Fat                      `json:"language"`
	Title             Title                    `json:"title"`
}

type ELMDocument

type ELMDocument map[string]any

func (*ELMDocument) Marshal

func (d *ELMDocument) Marshal() (map[string]any, error)

Marshal marshals the document to a map

type Fat

type Fat struct {
	ID         string           `json:"id"`
	Type       string           `json:"type"`
	SchemaName string           `json:"schemaName,omitempty"`
	InScheme   DiplomaInScheme  `json:"inScheme"`
	PrefLabel  DiplomaPrefLabel `json:"prefLabel"`
	Notation   string           `json:"notation"`
	ContentURL string           `json:"contentURL,omitempty"`
}

type HasClaim

type HasClaim struct {
	ID        string       `json:"id"`
	Type      string       `json:"type"`
	AwardedBy AwardedBy    `json:"awardedBy"`
	Grade     DiplomaGrade `json:"grade"`
}

type Identifier

type Identifier Data

type MCAchievement

type MCAchievement struct {
	ID                         string                `json:"id" validate:"required"`
	Type                       []string              `json:"type" validate:"required"`
	Criteria                   MCCriteria            `json:"criteria" validate:"required"`
	Description                string                `json:"description" validate:"required"`
	Name                       string                `json:"name" validate:"required"`
	Image                      MCImage               `json:"image" validate:"required"`
	InLanguage                 string                `json:"inLanguage" validate:"required"`
	EducationProgramIdentifier int                   `json:"educationProgramIdentifier" validate:"required"`
	SBU                        int                   `json:"sbu" validate:"required"`
	Alignment                  []MCAlignment         `json:"alignment" validate:"required"`
	ParticipationType          string                `json:"participationType" validate:"required"`
	AssessmentType             string                `json:"assessmentType" validate:"required"`
	IdentityChecked            bool                  `json:"identityChecked" validate:"required"`
	SupervisionType            string                `json:"supervisionType" validate:"required"`
	ResultDescription          []MCResultDescription `json:"resultDescription" validate:"required"`
}

type MCAlignment

type MCAlignment struct {
	Type       []string `json:"type" validate:"required"`
	TargetType string   `json:"targetType" validate:"required"`
	TargetName string   `json:"targetName" validate:"required"`
	TargetURL  string   `json:"targetURL" validate:"required"`
}

type MCCredentialSchema

type MCCredentialSchema struct {
	ID   string `json:"id" validate:"required"`
	Type string `json:"type" validate:"required"`
}

type MCCredentialSubject

type MCCredentialSubject struct {
	ID          string        `json:"id" validate:"required"`
	Type        []string      `json:"type" validate:"required"`
	Achievement MCAchievement `json:"achievement" validate:"required"`
	Result      []MCResult    `json:"result" validate:"required"`
}

type MCCriteria

type MCCriteria struct {
	Narrative string `json:"narrative" validate:"required"`
}

type MCImage

type MCImage struct {
	ID   string `json:"id" validate:"required"`
	Type string `json:"type" validate:"required"`
}

type MCIssuer

type MCIssuer struct {
	ID      string          `json:"id" validate:"required"`
	Type    []string        `json:"type" validate:"required"`
	Name    string          `json:"name" validate:"required"`
	Address MCIssuerAddress `json:"address" validate:"required"`
}

type MCIssuerAddress

type MCIssuerAddress struct {
	Type               []string `json:"type" validate:"required"`
	AddressCountry     string   `json:"addressCountry" validate:"required"`
	AddressCountryCode string   `json:"addressCountryCode" validate:"required"`
	StreetAddress      string   `json:"streetAddress" validate:"required"`
	PostalCode         string   `json:"postalCode" validate:"required"`
}

type MCResult

type MCResult struct {
	Type              []string `json:"type" validate:"required"`
	ResultDescription string   `json:"resultDescription" validate:"required"`
	Value             string   `json:"value" validate:"required"`
}

type MCResultDescription

type MCResultDescription struct {
	ID            string   `json:"id" validate:"required"`
	Type          []string `json:"type" validate:"required"`
	ValueMax      string   `json:"valueMax" validate:"required"`
	ValueMin      string   `json:"valueMin" validate:"required"`
	Name          string   `json:"name" validate:"required"`
	RequiredValue string   `json:"requiredValue" validate:"required"`
	ResultType    string   `json:"resultType" validate:"required"`
}

type MediaObject

type MediaObject struct {
	ID              string `json:"id"`
	Type            string `json:"type"`
	Content         string `json:"content"`
	ContentEncoding Fat    `json:"contentEncoding"`
	ContentType     Fat    `json:"contentType"`
}

type MicroCredentialDocument

type MicroCredentialDocument struct {
	Context           []string             `json:"@context" validate:"required"`
	ID                string               `json:"id" validate:"required"`
	Type              []string             `json:"type" validate:"required"`
	Issuer            MCIssuer             `json:"issuer" validate:"required"`
	ValidFrom         string               `json:"validFrom" validate:"required"`
	ValidUntil        string               `json:"validUntil" validate:"required"`
	CredentialSubject MCCredentialSubject  `json:"credentialSubject" validate:"required"`
	CredentialSchema  []MCCredentialSchema `json:"credentialSchema" validate:"required"`
}

func (*MicroCredentialDocument) Marshal

func (d *MicroCredentialDocument) Marshal() (map[string]any, error)

type OpenbadgeBasicDocument

type OpenbadgeBasicDocument map[string]any

func (*OpenbadgeBasicDocument) Marshal

func (d *OpenbadgeBasicDocument) Marshal() (map[string]any, error)

type OpenbadgeCompleteDocument

type OpenbadgeCompleteDocument map[string]any

func (*OpenbadgeCompleteDocument) Marshal

func (d *OpenbadgeCompleteDocument) Marshal() (map[string]any, error)

type OpenbadgeEndorsementDocument

type OpenbadgeEndorsementDocument map[string]any

func (*OpenbadgeEndorsementDocument) Marshal

func (d *OpenbadgeEndorsementDocument) Marshal() (map[string]any, error)

type Title

type Title struct {
	En string `json:"en"`
}