WebAPI

CDIFCore::Classes::WebAPI

Definition

Documentation

Original

Reference

schema:WebAPI

Definition

An application programming interface accessible over Web/Internet technologies.

Scope

Parent class(es): Service (https://schema.org/Service).

CDIF

Definition

schema:WebAPI - an API distribution endpoint. Used as an alternative to schema:DataDownload for service-mediated access. Inherits identifier/name/description from AbstractDistribution.

Diagram

Inheritance

Generalizes: AbstractDistribution

Attributes

Name	Type	Multiplicity	Description
documentation	Reference	[0..1]	Documentation Original Reference schema:documentation Definition Further documentation describing the Web API in more detail. Scope Domain: WebAPI (https://schema.org/WebAPI). Range: CreativeWork (https://schema.org/CreativeWork), URL (https://schema.org/URL). CDIF Definition a document that provides a machine-actionable description of a service instance. Examples include OpenAPI documents, OGC Capabilities documents. Software designed to utilise a particular service type will typically include functionality to parse such a description document and engage with the service endpoint. If such a document is available for the service instance providing the resource distribution, it should be included in the distribution metadata. Scope schema:documentation - URL of API documentation.
termsOfService	Reference	[0..1]	Documentation Original Reference schema:termsOfService Definition Human-readable terms of service documentation. Scope Domain: Service (https://schema.org/Service). Range: Text (https://schema.org/Text), URL (https://schema.org/URL). CDIF Definition Description of access privileges required to use the API, e.g. registration, licensing, payments. Note that access constraints applying to all distributions of the resource should be specified in the access constraints for the resource description as a whole. Scope schema:termsOfService - terms of service for using the API (URI or labeled reference).
serviceType	string	[0..1]	Documentation Original Reference schema:serviceType Definition The type of service being offered, e.g. veterans' benefits, emergency relief, etc. Scope Domain: Service (https://schema.org/Service). Range: GovernmentBenefitsType (https://schema.org/GovernmentBenefitsType), Text (https://schema.org/Text). CDIF Definition specify the kind of service. Ideally this should be a resolvable identifier. Currently there is no widely adopted registry for serviceType identifiers, in large part because services might be defined at different levels of granularity, and classifications might focus on function, data formats, thematic content, security, or other aspects of the service definition. For interoperability, there must be an external arrangement between data providers and consumers on the strings that will be used to specify service types. Scope schema:serviceType - the type of the web API service.

Associations

Role	Target	Multiplicity	Kind
potentialAction	→ Action	[0..*]	association