API Docs for: 1.3.12
Show:

RevokeAction Class

credentialengine.org/RevokeAction Action by an agent removing an awarded credential (credential assertion) from the credential holder based on violations or failure of the holder to renew. Since an instance of ceterms:CredentialingAction is a claim that a certain agent has taken the action being described, creation of such a ceterms:CredentialingAction should be reserved to the agent of that action.

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

actionStatus

ActionStatusType
Schema.org/actionStatus Indicates the current disposition of the Action.

actionStatusType

CredentialAlignmentObject

http://purl.org/ctdl/terms/actionStatusType Entity describing the current disposition or standing of an action; select from an existing enumeration of such types.

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.

agent

Person
Schema.org/agent The direct performer or driver of the action (animate or inanimate). e.g. *John* wrote a book.

alternateName

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

description

LangString

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

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.

endDate

Date

http://purl.org/ctdl/terms/endDate Date some event or activity ends.

endTime

DateTime
Schema.org/endTime The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to *December*.\n\nNote that SchemaEvent uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

error

Thing
Schema.org/error For failed actions, more information on the cause of the failure.

evidenceOfAction

AnyURI

http://purl.org/ctdl/terms/evidenceOfAction Entity that proves that the action occured or that the action continues to be valid. The evidence verifies the information in the action and is particular to it. It is not a directory of such evidentiary entities or a description of how such verifications might generically be characterized.

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]].

instrument

ApprenticeshipCertificate | AssociateDegree | BachelorDegree | Badge | Certificate | Certification | Credential | Degree | DigitalBadge | Diploma | DoctoralDegree | GeneralEducationDevelopment | JourneymanCertificate | License | MasterCertificate | MasterDegree | MicroCredential | OpenBadge | ProfessionalDoctorate | QualityAssuranceCredential | ResearchDoctorate | SecondarySchoolDiploma

http://purl.org/ctdl/terms/instrument Object that helped the agent perform the action. e.g. John wrote a book with a pen. A credential or other instrument whose criteria was applied in executing the action.

location

PostalAddress
Schema.org/location The location of for example where the event is happening, an organization is located, or where an action takes place.

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.

participant

CredentialOrganization | CredentialPerson | QACredentialOrganization

http://purl.org/ctdl/terms/participant Co-agents that participated in the action indirectly.

potentialAction

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

result

Thing
Schema.org/result The result produced in the action. e.g. John wrote *a book*.

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.

startDate

Date

http://purl.org/ctdl/terms/startDate Date the validity or usefulness of the information in this resource begins.

startTime

DateTime
Schema.org/startTime The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from *January* to December.\n\nNote that SchemaEvent uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

target

EntryPoint
Schema.org/target Indicates a target EntryPoint for an Action.

url

URL
Schema.org/url URL of the item.