Home/Docs/WebAPI
Class

WebAPI

An application programming interface accessible over Web/Internet technologies.

Type Information

  • Parent Type: Service
  • Schema.org URL: https://schema.org/WebAPI

Properties

| Property | Expected Type | Description | |----------|---------------|-------------| | documentation | URL or CreativeWork | Further documentation describing the Web API in more detail. |

Properties from Service

| Property | Expected Type | Description | |----------|---------------|-------------| | broker | Person or Organization | An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. | | hoursAvailable | OpeningHoursSpecification | The hours during which this service or contact is available. | | isRelatedTo | Service or Product | A pointer to another, somehow related product (or multiple products). | | produces | Thing | The tangible thing generated by the service, e.g. a passport, permit, etc. | | isSimilarTo | Service or Product | A pointer to another, functionally similar product (or multiple products). | | termsOfService | URL or Text | Human-readable terms of service documentation. | | offers | Demand or Offer | An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use [[businessFunction]] to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a [[Demand]]. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. | | audience | Audience | An intended audience, i.e. a group for whom something was created. | | review | Review | A review of the item. | | serviceOutput | Thing | The tangible thing generated by the service, e.g. a passport, permit, etc. | | areaServed | GeoShape or Text or AdministrativeArea or Place | The geographic area where a service or offered item is provided. | | provider | Person or Organization | The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. | | availableChannel | ServiceChannel | A means of accessing the service (e.g. a phone bank, a web site, a location, etc.). | | slogan | Text | A slogan or motto associated with the item. | | award | Text | An award won by or for this item. | | aggregateRating | AggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | | hasCertification | Certification | Certification information about a product, organization, service, place, or person. | | hasOfferCatalog | OfferCatalog | Indicates an OfferCatalog listing for this Organization, Person, or Service. | | brand | Organization or Brand | The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. | | providerMobility | Text | Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). | | category | PhysicalActivityCategory or CategoryCode or Text or Thing or URL | A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. | | serviceType | GovernmentBenefitsType or Text | The type of service being offered, e.g. veterans' benefits, emergency relief, etc. | | serviceArea | AdministrativeArea or GeoShape or Place | The geographic area where the service is provided. | | serviceAudience | Audience | The audience eligible for this service. | | logo | URL or ImageObject | An associated logo. |

Properties from Thing

| Property | Expected Type | Description | |----------|---------------|-------------| | digital | Number | A number from 0.0 to 1.0 representing the degree of digital vs physical embodiment. 1.0 = fully digital, 0.0 = fully physical, 0.5 = hybrid. | | disambiguatingDescription | Text | 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. | | potentialAction | Action | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | | additionalType | Text or URL | 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. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide. | | identifier | URL or Text or PropertyValue | 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 for more details. | | image | ImageObject or URL | An image of the item. This can be a [[URL]] or a fully described [[ImageObject]]. | | sameAs | URL | 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. | | description | Text or TextObject | A description of the item. | | alternateName | Text | An alias for the item. | | url | URL | URL of the item. | | subjectOf | Event or CreativeWork | A CreativeWork or Event about this Thing. | | name | Text | The name of the item. | | mainEntityOfPage | CreativeWork or URL | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |

ID: https://schema.org.ai/WebAPI
Context: https://schema.org.ai