API Docs for: 1.3.12
Show:

VerificationServiceProfile Class

credentialengine.org/VerificationServiceProfile Entity describing the means by which someone can verify whether a credential has been attained. Includes, but is not limited to, verification of whether quality assurance credentials have been issued for organizations, learning opportunities, and assessments.

Methods

getDescription

() String
Returns the description of the thing

Returns:

String: description of Thing

getName

() String
Returns the name of the thing

Returns:

String: name of Thing

setDescription

(
  • description
)
Method to set Thing description

Parameters:

  • description String
    Description to set for its Thing

setName

(
  • name
)
Method to set Thing name

Parameters:

  • name String
    Name to set for this Thing

Properties

additionalType

URL
Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alternateName

Text
Schema.org/alternateName An alias for the item.

dateEffective

Date

http://purl.org/ctdl/terms/dateEffective Effective date of the content of a credential, assessment or learning opportunity.

description

LangString

Inherited from Thing but overwritten in src/main/js/cass/org.credentialengine.js:3915

http://purl.org/ctdl/terms/description Statement, characterization or account of the entity.

disambiguatingDescription

Text
Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

estimatedCost

CostProfile

http://purl.org/ctdl/terms/estimatedCost Estimated cost of a credential, learning opportunity or assessment.

holderMustAuthorize

Boolean

http://purl.org/ctdl/terms/holderMustAuthorize Whether or not the credential holder must authorize the organization to provide the verification service.

identifier

Schema, URL | schema,Text | schema,PropertyValue
Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

image

Schema, URL | schema,ImageObject
Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

jurisdiction

JurisdictionProfile

http://purl.org/ctdl/terms/jurisdiction Geographic or political region in which the credential is formally applicable or an organization has authority to act.

mainEntityOfPage

Schema, URL | schema,CreativeWork
Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.

name

Text
Schema.org/name The name of the item.

offeredBy

CredentialOrganization | CredentialPerson | QACredentialOrganization

http://purl.org/ctdl/terms/offeredBy Agent that offers the credential, learning opportunity or assessment.

offeredIn

JurisdictionProfile

http://purl.org/ctdl/terms/offeredIn Region or political jurisdiction such as a state, province or locale where the credential, learning resource or assessment is offered.

potentialAction

Action
Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

region

Place

http://purl.org/ctdl/terms/region Entity that describes the longitude, latitude and other location details of an area.

sameAs

URL
Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

subjectWebpage

AnyURI

http://purl.org/ctdl/terms/subjectWebpage The webpage that describes this entity. The web page being referenced describes the entity. The value of subjectWebpage is an authoritative location for information about the subject but should not assumed to be a persistent identifier of the subject.

url

URL
Schema.org/url URL of the item.

verificationDirectory

AnyURI

http://purl.org/ctdl/terms/verificationDirectory Directory of credential holders and their current statuses.

verificationMethodDescription

LangString

http://purl.org/ctdl/terms/verificationMethodDescription Textual description of the methods used to evaluate an assessment, learning opportunity, process or verificaiton service for validity or reliability.

verificationService

AnyURI

http://purl.org/ctdl/terms/verificationService Direct access to the verification service. This property identifies machine-accessible services, such as API endpoints, that provide direct access to the verification service being described.

verifiedClaimType

CredentialAlignmentObject

http://purl.org/ctdl/terms/verifiedClaimType Type of claim provided through a verification service; select from an existing enumeration of such types.