WebAPI - Schema.org Type

<!DOCTYPE html> <html lang="en">  <head> <title>WebAPI - Schema.org Type</title> <meta charset="utf-8" > <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Schema.org Type: WebAPI - An application programming interface accessible over Web/Internet technologies." /> <link rel="shortcut icon" type="image/png" href="/docs/favicon.ico"/> <link rel="stylesheet" type="text/css" href="/docs/schemaorg.css" /> <link rel="stylesheet" type="text/css" href="/docs/devnote.css" /> <link rel="stylesheet" type="text/css" href="/docs/prettify.css" /> <script src="/docs/prettify.js"></script> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script src="/docs/schemaorg.js"></script>  <script src="/docs/sdotermpage.js"></script> <link rel="stylesheet" type="text/css" href="/docs/sdotermpage.css" /> <script src="/docs/pretty-markup/schemarama-parsing.bundle.min.js"></script> <script src="/docs/pretty-markup/layout.js"></script> <link rel="stylesheet" type="text/css" href="/docs/pretty-markup/style.css" /> <script src="/docs/clipboard/clipboard.min.js"></script> <link rel="canonical" href="https://schema.org/WebAPI" /> </head> <body>   <div class="devnote"><b>Note</b>: You are viewing the development version of <a href="https://schema.org">Schema.org</a>. See <a href="/docs/howwework.html">how we work</a> for more details. </div> <div id="container"> <div id="headerwrap"> <div id="pagehead1" class="mobnav"> <div class="header-block" id="pagehead-left"> <div id="sitename2"> <a href="/">Schema.org</a> </div> </div> <div class="header-block header-block-right mobnav" id="pagehead-mid"> <div id="selectionbar2"> <ul> <li> <a href="/docs/documents.html">Docs</a> </li> <li> <a href="/docs/schemas.html">Schemas</a> </li> <li> <a href="https://validator.schema.org">Validate</a> </li> <li> <a href="/docs/about.html">About</a> </li> </ul> </div>  </div> <div class="header-block header-block-right mobnav" id="pagehead-right"> <div id="cse-search-form2" class="live-only"> <div class="gcse-searchbox-only" data-resultsUrl="/docs/search_results.html"></div> </div> </div> <div class="header-block mobnav" id="navicon2"> <a href="javascript:void(0);" class="icon" onclick="navFunction()"> <svg id="open" width="24px" height="24px" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"> <g clip-path="url(#clip0_3560_173)"> <path d="M3 18V16H21V18H3ZM3 13V11H21V13H3ZM3 8V6H21V8H3Z" fill="#444746"/> </g> <defs> <clipPath id="clip0_3560_173"> <rect width="24" height="24" fill="white"/> </clipPath> </defs> </svg> <svg id="close" width="24px" height="24px" viewBox="0 -960 960 960" fill="#444746" xmlns="http://www.w3.org/2000/svg"> <path d="m256-200-56-56 224-224-224-224 56-56 224 224 224-224 56 56-224 224 224 224-56 56-224-224-224 224Z"/> </svg> </a> </div> </div> </div> <div class="header-bottom"></div> </div>  <div id="mainContent"> <div id="infoblock" class="jumptarget" title="Details">  <div id="infohead"> <h1>WebAPI</h1> <div class="infotype">A Schema.org Type</div>  <br/><em>This term is in the "new" area - implementation feedback and adoption from applications and websites can help improve our definitions.</em> </div>  <div class="superPaths" itemscope itemtype="https://schema.org/BreadcrumbList"> <span itemscope itemprop="itemListElement" itemtype="https://schema.org/ListItem"> <meta itemprop="name" content="Thing" /> <meta itemprop="position" content="1" /> <a href="/Thing" itemprop="item" class="core" title="Thing">Thing</a> </span> > <span itemscope itemprop="itemListElement" itemtype="https://schema.org/ListItem"> <meta itemprop="name" content="Intangible" /> <meta itemprop="position" content="2" /> <a href="/Intangible" itemprop="item" class="core" title="Intangible">Intangible</a> </span> > <span itemscope itemprop="itemListElement" itemtype="https://schema.org/ListItem"> <meta itemprop="name" content="Service" /> <meta itemprop="position" content="3" /> <a href="/Service" itemprop="item" class="core" title="Service">Service</a> </span> > <span itemscope itemprop="itemListElement" itemtype="https://schema.org/ListItem"> <meta itemprop="name" content="WebAPI" /> <meta itemprop="position" content="4" /> <a href="/WebAPI" itemprop="item" class="core" title="WebAPI">WebAPI</a> </span> <br/> </div>  <div> <div id='infobox' style='text-align: right; padding-right: 5px;' role="checkbox" aria-checked="false"> <label for="morecheck"><b><span style="cursor: pointer;">[more...]</span></b></label> </div> <input type='checkbox' checked="checked" style='display: none' id=morecheck><div id='infomsg' style='background-color: #EEEEEE; text-align: left; padding: 0.5em;'> <ul><li> <span class="canonicalUrl">Canonical URL: https://schema.org/WebAPI</span> </li>  <li><a href='https://github.com/schemaorg/schemaorg/issues?q=is%3Aissue+is%3Aopen+WebAPI'>Check for open issues.</a></li> </ul> </div> </div>  <div class="description">An application programming interface accessible over Web/Internet technologies.</div> </div>     <table class="definition-table"> <thead> <tr><th>Property</th><th>Expected Type</th><th>Description</th></tr> </thead>  <tr class="supertype"><th class="supertype-name" colspan="3">Properties from <a href="/WebAPI" class="ext ext-pending" title="WebAPI">WebAPI</a></th></tr> <tr><th class="prop-nam"><code> <a href="/documentation" class="ext ext-pending" title="documentation">documentation</a></code></th> <td class="prop-ect"> <a href="/CreativeWork" class="core" title="CreativeWork">CreativeWork</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">Further documentation describing the Web API in more detail. </td> </tr>  <tr class="supertype"><th class="supertype-name" colspan="3">Properties from <a href="/Service" class="core" title="Service">Service</a></th></tr> <tr><th class="prop-nam"><code> <a href="/aggregateRating" class="core" title="aggregateRating">aggregateRating</a></code></th> <td class="prop-ect"> <a href="/AggregateRating" class="core" title="AggregateRating">AggregateRating</a></td> <td class="prop-desc">The overall rating, based on a collection of reviews or ratings, of the item. </td> </tr> <tr><th class="prop-nam"><code> <a href="/areaServed" class="core" title="areaServed">areaServed</a></code></th> <td class="prop-ect"> <a href="/AdministrativeArea" class="core" title="AdministrativeArea">AdministrativeArea</a>  or <br/> <a href="/GeoShape" class="core" title="GeoShape">GeoShape</a>  or <br/> <a href="/Place" class="core" title="Place">Place</a>  or <br/> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">The geographic area where a service or offered item is provided. Supersedes <a href="/serviceArea" class="core" title="serviceArea">serviceArea</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/audience" class="core" title="audience">audience</a></code></th> <td class="prop-ect"> <a href="/Audience" class="core" title="Audience">Audience</a></td> <td class="prop-desc">An intended audience, i.e. a group for whom something was created. Supersedes <a href="/serviceAudience" class="core" title="serviceAudience">serviceAudience</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/availableChannel" class="core" title="availableChannel">availableChannel</a></code></th> <td class="prop-ect"> <a href="/ServiceChannel" class="core" title="ServiceChannel">ServiceChannel</a></td> <td class="prop-desc">A means of accessing the service (e.g. a phone bank, a web site, a location, etc.). </td> </tr> <tr><th class="prop-nam"><code> <a href="/award" class="core" title="award">award</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">An award won by or for this item. Supersedes <a href="/awards" class="core" title="awards">awards</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/brand" class="core" title="brand">brand</a></code></th> <td class="prop-ect"> <a href="/Brand" class="core" title="Brand">Brand</a>  or <br/> <a href="/Organization" class="core" title="Organization">Organization</a></td> <td class="prop-desc">The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person. </td> </tr> <tr><th class="prop-nam"><code> <a href="/broker" class="core" title="broker">broker</a></code></th> <td class="prop-ect"> <a href="/Organization" class="core" title="Organization">Organization</a>  or <br/> <a href="/Person" class="core" title="Person">Person</a></td> <td class="prop-desc">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. Supersedes <a href="/bookingAgent" class="core" title="bookingAgent">bookingAgent</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/category" class="core" title="category">category</a></code></th> <td class="prop-ect"> <a href="/CategoryCode" class="core" title="CategoryCode">CategoryCode</a>  or <br/> <a href="/PhysicalActivityCategory" class="core" title="PhysicalActivityCategory">PhysicalActivityCategory</a>  or <br/> <a href="/Text" class="core" title="Text">Text</a>  or <br/> <a href="/Thing" class="core" title="Thing">Thing</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. </td> </tr> <tr><th class="prop-nam"><code> <a href="/hasCertification" class="core" title="hasCertification">hasCertification</a></code></th> <td class="prop-ect"> <a href="/Certification" class="core" title="Certification">Certification</a></td> <td class="prop-desc">Certification information about a product, organization, service, place, or person. </td> </tr> <tr><th class="prop-nam"><code> <a href="/hasOfferCatalog" class="core" title="hasOfferCatalog">hasOfferCatalog</a></code></th> <td class="prop-ect"> <a href="/OfferCatalog" class="core" title="OfferCatalog">OfferCatalog</a></td> <td class="prop-desc">Indicates an OfferCatalog listing for this Organization, Person, or Service. </td> </tr> <tr><th class="prop-nam"><code> <a href="/hoursAvailable" class="core" title="hoursAvailable">hoursAvailable</a></code></th> <td class="prop-ect"> <a href="/OpeningHoursSpecification" class="core" title="OpeningHoursSpecification">OpeningHoursSpecification</a></td> <td class="prop-desc">The hours during which this service or contact is available. </td> </tr> <tr><th class="prop-nam"><code> <a href="/isRelatedTo" class="core" title="isRelatedTo">isRelatedTo</a></code></th> <td class="prop-ect"> <a href="/Product" class="core" title="Product">Product</a>  or <br/> <a href="/Service" class="core" title="Service">Service</a></td> <td class="prop-desc">A pointer to another, somehow related product (or multiple products). </td> </tr> <tr><th class="prop-nam"><code> <a href="/isSimilarTo" class="core" title="isSimilarTo">isSimilarTo</a></code></th> <td class="prop-ect"> <a href="/Product" class="core" title="Product">Product</a>  or <br/> <a href="/Service" class="core" title="Service">Service</a></td> <td class="prop-desc">A pointer to another, functionally similar product (or multiple products). </td> </tr> <tr><th class="prop-nam"><code> <a href="/logo" class="core" title="logo">logo</a></code></th> <td class="prop-ect"> <a href="/ImageObject" class="core" title="ImageObject">ImageObject</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">An associated logo. </td> </tr> <tr><th class="prop-nam"><code> <a href="/offers" class="core" title="offers">offers</a></code></th> <td class="prop-ect"> <a href="/Demand" class="core" title="Demand">Demand</a>  or <br/> <a href="/Offer" class="core" title="Offer">Offer</a></td> <td class="prop-desc">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 <a class="localLink" href="/businessFunction">businessFunction</a> to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a <a class="localLink" href="/Demand">Demand</a>. 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. <br/>Inverse property: <a href="/itemOffered" class="core" title="itemOffered">itemOffered</a> </td> </tr> <tr><th class="prop-nam"><code> <a href="/provider" class="ext ext-pending" title="provider">provider</a></code></th> <td class="prop-ect"> <a href="/Organization" class="core" title="Organization">Organization</a>  or <br/> <a href="/Person" class="core" title="Person">Person</a></td> <td class="prop-desc">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. Supersedes <a href="/carrier" class="core" title="carrier">carrier</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/providerMobility" class="core" title="providerMobility">providerMobility</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). </td> </tr> <tr><th class="prop-nam"><code> <a href="/review" class="core" title="review">review</a></code></th> <td class="prop-ect"> <a href="/Review" class="core" title="Review">Review</a></td> <td class="prop-desc">A review of the item. Supersedes <a href="/reviews" class="core" title="reviews">reviews</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/serviceOutput" class="core" title="serviceOutput">serviceOutput</a></code></th> <td class="prop-ect"> <a href="/Thing" class="core" title="Thing">Thing</a></td> <td class="prop-desc">The tangible thing generated by the service, e.g. a passport, permit, etc. Supersedes <a href="/produces" class="core" title="produces">produces</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/serviceType" class="core" title="serviceType">serviceType</a></code></th> <td class="prop-ect"> <a href="/GovernmentBenefitsType" class="core" title="GovernmentBenefitsType">GovernmentBenefitsType</a>  or <br/> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">The type of service being offered, e.g. veterans' benefits, emergency relief, etc. </td> </tr> <tr><th class="prop-nam"><code> <a href="/slogan" class="core" title="slogan">slogan</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">A slogan or motto associated with the item. </td> </tr> <tr><th class="prop-nam"><code> <a href="/termsOfService" class="ext ext-pending" title="termsOfService">termsOfService</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">Human-readable terms of service documentation. </td> </tr>   <tr class="supertype"><th class="supertype-name" colspan="3">Properties from <a href="/Thing" class="core" title="Thing">Thing</a></th></tr> <tr><th class="prop-nam"><code> <a href="/additionalType" class="core" title="additionalType">additionalType</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">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 <a href="https://schema.org/docs/styleguide.html">style guide</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/alternateName" class="core" title="alternateName">alternateName</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">An alias for the item. </td> </tr> <tr><th class="prop-nam"><code> <a href="/description" class="core" title="description">description</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a>  or <br/> <a href="/TextObject" class="core" title="TextObject">TextObject</a></td> <td class="prop-desc">A description of the item. </td> </tr> <tr><th class="prop-nam"><code> <a href="/disambiguatingDescription" class="core" title="disambiguatingDescription">disambiguatingDescription</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">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. </td> </tr> <tr><th class="prop-nam"><code> <a href="/identifier" class="core" title="identifier">identifier</a></code></th> <td class="prop-ect"> <a href="/PropertyValue" class="core" title="PropertyValue">PropertyValue</a>  or <br/> <a href="/Text" class="core" title="Text">Text</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">The identifier property represents any kind of identifier for any kind of <a class="localLink" href="/Thing">Thing</a>, 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 <a href="/docs/datamodel.html#identifierBg">background notes</a> for more details. </td> </tr> <tr><th class="prop-nam"><code> <a href="/image" class="core" title="image">image</a></code></th> <td class="prop-ect"> <a href="/ImageObject" class="core" title="ImageObject">ImageObject</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">An image of the item. This can be a <a class="localLink" href="/URL">URL</a> or a fully described <a class="localLink" href="/ImageObject">ImageObject</a>. </td> </tr> <tr><th class="prop-nam"><code> <a href="/mainEntityOfPage" class="core" title="mainEntityOfPage">mainEntityOfPage</a></code></th> <td class="prop-ect"> <a href="/CreativeWork" class="core" title="CreativeWork">CreativeWork</a>  or <br/> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See <a href="/docs/datamodel.html#mainEntityBackground">background notes</a> for details. <br/>Inverse property: <a href="/mainEntity" class="core" title="mainEntity">mainEntity</a> </td> </tr> <tr><th class="prop-nam"><code> <a href="/name" class="core" title="name">name</a></code></th> <td class="prop-ect"> <a href="/Text" class="core" title="Text">Text</a></td> <td class="prop-desc">The name of the item. </td> </tr> <tr><th class="prop-nam"><code> <a href="/potentialAction" class="core" title="potentialAction">potentialAction</a></code></th> <td class="prop-ect"> <a href="/Action" class="core" title="Action">Action</a></td> <td class="prop-desc">Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. </td> </tr> <tr><th class="prop-nam"><code> <a href="/sameAs" class="core" title="sameAs">sameAs</a></code></th> <td class="prop-ect"> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">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. </td> </tr> <tr><th class="prop-nam"><code> <a href="/subjectOf" class="core" title="subjectOf">subjectOf</a></code></th> <td class="prop-ect"> <a href="/CreativeWork" class="core" title="CreativeWork">CreativeWork</a>  or <br/> <a href="/Event" class="core" title="Event">Event</a></td> <td class="prop-desc">A CreativeWork or Event about this Thing. <br/>Inverse property: <a href="/about" class="core" title="about">about</a> </td> </tr> <tr><th class="prop-nam"><code> <a href="/url" class="core" title="url">url</a></code></th> <td class="prop-ect"> <a href="/URL" class="core" title="URL">URL</a></td> <td class="prop-desc">URL of the item. </td> </tr> </table>      <h4 id="source" class="jumptarget" title="Source">Source</h4> <p><a href="https://github.com/schemaorg/schemaorg/issues/1423">https://github.com/schemaorg/schemaorg/issues/1423</a></p> <br/>   <div id="examplespannel" class="jumptarget" title="Examples"> <h3>Examples</h3> <div class="example-head"> <button class="clip clipbutton eg-0239" data-clipboard-target=".ds-tab.selected.eg-0239 .clipsource" title="Copy example to clipboard"> <img src="/docs/clipboard/clippy.svg" width="18" alt="Copy to clipboard" /> </button> <a id="eg-0239" title="Link: #eg-0239" href="#eg-0239" class="clickableAnchor" >Example 1</a> <div class="tooltip"> <span class="tooltiptext eg-0239">Copied</span> </div> </div> <div class='ds-selector-tabs ds-selector'> <div class='selectors'> <a data-selects='original_html' class='selected'>No Markup</a> <a data-selects='jsonld' class=''>JSON-LD</a> <a data-selects='structure' class='extabs'>Structure</a> </div> <div class="ds-tab eg-0239 original_html selected"> <div class="ds-tab-note" >Example notes or example HTML without markup.</div> <pre class="ds-tab-content prettyprint lang-html linenums clipsource "> See JSON example. </pre> </div> <div class="ds-tab eg-0239 jsonld "> <div class="ds-tab-note" >Example encoded as <a class="ds-tab-note" href="https://en.wikipedia.org/wiki/JSON-LD">JSON-LD</a> in a HTML script tag.</div> <pre class="ds-tab-content prettyprint lang-html linenums clipsource "> <script type="application/ld+json"> { "@context": "https://schema.org/", "@type": "WebAPI", "name": "Google Knowledge Graph Search API", "description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.", "documentation": "https://developers.google.com/knowledge-graph/", "termsOfService": "https://developers.google.com/knowledge-graph/terms", "provider": { "@type": "Organization", "name": "Google Inc." } } </script> </pre> </div> <div class="ds-tab eg-0239 structure extabs" data-ex="eg-0239"> <div class="ds-tab-note" >Structured representation of the JSON-LD example.</div> <div class="ds-tab-content structureout extabs eg-0239" style="margin-left: 5px;"> </div> <div class="structuretext clipsource extabs eg-0239"></div> </div> <div class="payload eg-0239" style="display: none;">{ "@context": "https://schema.org/", "@type": "WebAPI", "name": "Google Knowledge Graph Search API", "description": "The Knowledge Graph Search API lets you find entities in the Google Knowledge Graph. The API uses standard schema.org types and is compliant with the JSON-LD specification.", "documentation": "https://developers.google.com/knowledge-graph/", "termsOfService": "https://developers.google.com/knowledge-graph/terms", "provider": { "@type": "Organization", "name": "Google Inc." } }</div> </div> </div> </div>   <div id="footer"> <p><a href="/docs/terms.html">Terms and conditions</a></p> <div id="versioninfo"> <span class="sep">•</span> Schema.org <span class="sep">•</span> V28.1 <span class="sep">|</span> 2024-11-22 </div> </div> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-52672119-1', 'auto'); ga('send', 'pageview'); </script>  <script type="application/ld+json"> { "@context": { "brick": "https://brickschema.org/schema/Brick#", "csvw": "http://www.w3.org/ns/csvw#", "dc": "http://purl.org/dc/elements/1.1/", "dcam": "http://purl.org/dc/dcam/", "dcat": "http://www.w3.org/ns/dcat#", "dcmitype": "http://purl.org/dc/dcmitype/", "dcterms": "http://purl.org/dc/terms/", "doap": "http://usefulinc.com/ns/doap#", "foaf": "http://xmlns.com/foaf/0.1/", "odrl": "http://www.w3.org/ns/odrl/2/", "org": "http://www.w3.org/ns/org#", "owl": "http://www.w3.org/2002/07/owl#", "prof": "http://www.w3.org/ns/dx/prof/", "prov": "http://www.w3.org/ns/prov#", "qb": "http://purl.org/linked-data/cube#", "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "schema": "https://schema.org/", "sh": "http://www.w3.org/ns/shacl#", "skos": "http://www.w3.org/2004/02/skos/core#", "sosa": "http://www.w3.org/ns/sosa/", "ssn": "http://www.w3.org/ns/ssn/", "time": "http://www.w3.org/2006/time#", "vann": "http://purl.org/vocab/vann/", "void": "http://rdfs.org/ns/void#", "xsd": "http://www.w3.org/2001/XMLSchema#" }, "@graph": [ { "@id": "schema:logo", "@type": "rdf:Property", "rdfs:comment": "An associated logo.", "rdfs:label": "logo", "rdfs:subPropertyOf": { "@id": "schema:image" }, "schema:contributor": { "@id": "https://schema.org/docs/collab/GoodRelationsTerms" }, "schema:domainIncludes": [ { "@id": "schema:Certification" }, { "@id": "schema:Organization" }, { "@id": "schema:Brand" }, { "@id": "schema:Service" }, { "@id": "schema:Product" }, { "@id": "schema:Place" } ], "schema:rangeIncludes": [ { "@id": "schema:URL" }, { "@id": "schema:ImageObject" } ] }, { "@id": "schema:url", "@type": "rdf:Property", "rdfs:comment": "URL of the item.", "rdfs:label": "url", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:URL" } }, { "@id": "schema:subjectOf", "@type": "rdf:Property", "rdfs:comment": "A CreativeWork or Event about this Thing.", "rdfs:label": "subjectOf", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:inverseOf": { "@id": "schema:about" }, "schema:rangeIncludes": [ { "@id": "schema:CreativeWork" }, { "@id": "schema:Event" } ], "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/1670" } }, { "@id": "schema:alternateName", "@type": "rdf:Property", "rdfs:comment": "An alias for the item.", "rdfs:label": "alternateName", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:audience", "@type": "rdf:Property", "rdfs:comment": "An intended audience, i.e. a group for whom something was created.", "rdfs:label": "audience", "schema:domainIncludes": [ { "@id": "schema:LodgingBusiness" }, { "@id": "schema:PlayAction" }, { "@id": "schema:Service" }, { "@id": "schema:Product" }, { "@id": "schema:CreativeWork" }, { "@id": "schema:Event" } ], "schema:rangeIncludes": { "@id": "schema:Audience" } }, { "@id": "schema:serviceType", "@type": "rdf:Property", "rdfs:comment": "The type of service being offered, e.g. veterans' benefits, emergency relief, etc.", "rdfs:label": "serviceType", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": [ { "@id": "schema:Text" }, { "@id": "schema:GovernmentBenefitsType" } ] }, { "@id": "schema:Intangible", "@type": "rdfs:Class", "rdfs:comment": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.", "rdfs:label": "Intangible", "rdfs:subClassOf": { "@id": "schema:Thing" } }, { "@id": "schema:availableChannel", "@type": "rdf:Property", "rdfs:comment": "A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).", "rdfs:label": "availableChannel", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": { "@id": "schema:ServiceChannel" } }, { "@id": "schema:serviceArea", "@type": "rdf:Property", "rdfs:comment": "The geographic area where the service is provided.", "rdfs:label": "serviceArea", "schema:domainIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:ContactPoint" }, { "@id": "schema:Service" } ], "schema:rangeIncludes": [ { "@id": "schema:AdministrativeArea" }, { "@id": "schema:GeoShape" }, { "@id": "schema:Place" } ], "schema:supersededBy": { "@id": "schema:areaServed" } }, { "@id": "schema:hoursAvailable", "@type": "rdf:Property", "rdfs:comment": "The hours during which this service or contact is available.", "rdfs:label": "hoursAvailable", "schema:domainIncludes": [ { "@id": "schema:ContactPoint" }, { "@id": "schema:Service" }, { "@id": "schema:LocationFeatureSpecification" } ], "schema:rangeIncludes": { "@id": "schema:OpeningHoursSpecification" } }, { "@id": "schema:additionalType", "@type": "rdf:Property", "rdfs:comment": "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\n 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 <a href=\"https://schema.org/docs/styleguide.html\">style guide</a>.", "rdfs:label": "additionalType", "rdfs:subPropertyOf": { "@id": "rdf:type" }, "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": [ { "@id": "schema:URL" }, { "@id": "schema:Text" } ] }, { "@id": "schema:name", "@type": "rdf:Property", "owl:equivalentProperty": { "@id": "dcterms:title" }, "rdfs:comment": "The name of the item.", "rdfs:label": "name", "rdfs:subPropertyOf": { "@id": "rdfs:label" }, "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:isRelatedTo", "@type": "rdf:Property", "rdfs:comment": "A pointer to another, somehow related product (or multiple products).", "rdfs:label": "isRelatedTo", "schema:contributor": { "@id": "https://schema.org/docs/collab/GoodRelationsTerms" }, "schema:domainIncludes": [ { "@id": "schema:Product" }, { "@id": "schema:Service" } ], "schema:rangeIncludes": [ { "@id": "schema:Service" }, { "@id": "schema:Product" } ] }, { "@id": "schema:aggregateRating", "@type": "rdf:Property", "rdfs:comment": "The overall rating, based on a collection of reviews or ratings, of the item.", "rdfs:label": "aggregateRating", "schema:domainIncludes": [ { "@id": "schema:Offer" }, { "@id": "schema:Organization" }, { "@id": "schema:Service" }, { "@id": "schema:Place" }, { "@id": "schema:CreativeWork" }, { "@id": "schema:Event" }, { "@id": "schema:Brand" }, { "@id": "schema:Product" } ], "schema:rangeIncludes": { "@id": "schema:AggregateRating" } }, { "@id": "schema:Thing", "@type": "rdfs:Class", "rdfs:comment": "The most generic type of item.", "rdfs:label": "Thing" }, { "@id": "schema:disambiguatingDescription", "@type": "rdf:Property", "rdfs:comment": "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.", "rdfs:label": "disambiguatingDescription", "rdfs:subPropertyOf": { "@id": "schema:description" }, "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:areaServed", "@type": "rdf:Property", "rdfs:comment": "The geographic area where a service or offered item is provided.", "rdfs:label": "areaServed", "schema:domainIncludes": [ { "@id": "schema:Offer" }, { "@id": "schema:Organization" }, { "@id": "schema:DeliveryChargeSpecification" }, { "@id": "schema:ContactPoint" }, { "@id": "schema:Service" }, { "@id": "schema:Demand" } ], "schema:rangeIncludes": [ { "@id": "schema:AdministrativeArea" }, { "@id": "schema:GeoShape" }, { "@id": "schema:Text" }, { "@id": "schema:Place" } ] }, { "@id": "schema:WebAPI", "@type": "rdfs:Class", "rdfs:comment": "An application programming interface accessible over Web/Internet technologies.", "rdfs:label": "WebAPI", "rdfs:subClassOf": { "@id": "schema:Service" }, "schema:isPartOf": { "@id": "https://pending.schema.org" }, "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/1423" } }, { "@id": "schema:serviceOutput", "@type": "rdf:Property", "rdfs:comment": "The tangible thing generated by the service, e.g. a passport, permit, etc.", "rdfs:label": "serviceOutput", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": { "@id": "schema:Thing" } }, { "@id": "schema:award", "@type": "rdf:Property", "rdfs:comment": "An award won by or for this item.", "rdfs:label": "award", "schema:domainIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:Service" }, { "@id": "schema:Person" }, { "@id": "schema:Product" }, { "@id": "schema:CreativeWork" } ], "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:termsOfService", "@type": "rdf:Property", "rdfs:comment": "Human-readable terms of service documentation.", "rdfs:label": "termsOfService", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:isPartOf": { "@id": "https://pending.schema.org" }, "schema:rangeIncludes": [ { "@id": "schema:URL" }, { "@id": "schema:Text" } ], "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/1423" } }, { "@id": "schema:image", "@type": "rdf:Property", "rdfs:comment": "An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].", "rdfs:label": "image", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": [ { "@id": "schema:ImageObject" }, { "@id": "schema:URL" } ] }, { "@id": "schema:offers", "@type": "rdf:Property", "rdfs:comment": "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.\n ", "rdfs:label": "offers", "schema:domainIncludes": [ { "@id": "schema:AggregateOffer" }, { "@id": "schema:Service" }, { "@id": "schema:Trip" }, { "@id": "schema:Event" }, { "@id": "schema:MenuItem" }, { "@id": "schema:Product" }, { "@id": "schema:CreativeWork" }, { "@id": "schema:EducationalOccupationalProgram" } ], "schema:inverseOf": { "@id": "schema:itemOffered" }, "schema:rangeIncludes": [ { "@id": "schema:Demand" }, { "@id": "schema:Offer" } ], "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/2289" } }, { "@id": "schema:providerMobility", "@type": "rdf:Property", "rdfs:comment": "Indicates the mobility of a provided service (e.g. 'static', 'dynamic').", "rdfs:label": "providerMobility", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:Service", "@type": "rdfs:Class", "rdfs:comment": "A service provided by an organization, e.g. delivery service, print services, etc.", "rdfs:label": "Service", "rdfs:subClassOf": { "@id": "schema:Intangible" } }, { "@id": "schema:hasOfferCatalog", "@type": "rdf:Property", "rdfs:comment": "Indicates an OfferCatalog listing for this Organization, Person, or Service.", "rdfs:label": "hasOfferCatalog", "schema:domainIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:Service" }, { "@id": "schema:Person" } ], "schema:rangeIncludes": { "@id": "schema:OfferCatalog" } }, { "@id": "schema:hasCertification", "@type": "rdf:Property", "rdfs:comment": "Certification information about a product, organization, service, place, or person.", "rdfs:label": "hasCertification", "schema:domainIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:Service" }, { "@id": "schema:Product" }, { "@id": "schema:Person" }, { "@id": "schema:Place" } ], "schema:rangeIncludes": { "@id": "schema:Certification" }, "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/3230" } }, { "@id": "schema:sameAs", "@type": "rdf:Property", "rdfs:comment": "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.", "rdfs:label": "sameAs", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:URL" } }, { "@id": "schema:mainEntityOfPage", "@type": "rdf:Property", "rdfs:comment": "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.", "rdfs:label": "mainEntityOfPage", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:inverseOf": { "@id": "schema:mainEntity" }, "schema:rangeIncludes": [ { "@id": "schema:CreativeWork" }, { "@id": "schema:URL" } ] }, { "@id": "schema:provider", "@type": "rdf:Property", "rdfs:comment": "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.", "rdfs:label": "provider", "schema:domainIncludes": [ { "@id": "schema:CreativeWork" }, { "@id": "schema:Reservation" }, { "@id": "schema:Invoice" }, { "@id": "schema:Trip" }, { "@id": "schema:Service" }, { "@id": "schema:ParcelDelivery" }, { "@id": "schema:Action" }, { "@id": "schema:EducationalOccupationalProgram" } ], "schema:isPartOf": { "@id": "https://pending.schema.org" }, "schema:rangeIncludes": [ { "@id": "schema:Person" }, { "@id": "schema:Organization" } ], "schema:source": [ { "@id": "https://github.com/schemaorg/schemaorg/issues/2927" }, { "@id": "https://github.com/schemaorg/schemaorg/issues/2289" } ] }, { "@id": "schema:category", "@type": "rdf:Property", "rdfs:comment": "A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.", "rdfs:label": "category", "schema:domainIncludes": [ { "@id": "schema:ActionAccessSpecification" }, { "@id": "schema:Product" }, { "@id": "schema:Offer" }, { "@id": "schema:Service" }, { "@id": "schema:Invoice" }, { "@id": "schema:PhysicalActivity" }, { "@id": "schema:Recommendation" }, { "@id": "schema:SpecialAnnouncement" } ], "schema:rangeIncludes": [ { "@id": "schema:Thing" }, { "@id": "schema:Text" }, { "@id": "schema:PhysicalActivityCategory" }, { "@id": "schema:CategoryCode" }, { "@id": "schema:URL" } ], "schema:source": [ { "@id": "https://github.com/schemaorg/schemaorg/issues/1741" }, { "@id": "https://github.com/schemaorg/schemaorg/issues/2490" } ] }, { "@id": "schema:description", "@type": "rdf:Property", "owl:equivalentProperty": { "@id": "dcterms:description" }, "rdfs:comment": "A description of the item.", "rdfs:label": "description", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": [ { "@id": "schema:Text" }, { "@id": "schema:TextObject" } ] }, { "@id": "schema:review", "@type": "rdf:Property", "rdfs:comment": "A review of the item.", "rdfs:label": "review", "schema:domainIncludes": [ { "@id": "schema:Event" }, { "@id": "schema:Brand" }, { "@id": "schema:Product" }, { "@id": "schema:Place" }, { "@id": "schema:CreativeWork" }, { "@id": "schema:Offer" }, { "@id": "schema:Organization" }, { "@id": "schema:Service" } ], "schema:rangeIncludes": { "@id": "schema:Review" } }, { "@id": "schema:isSimilarTo", "@type": "rdf:Property", "rdfs:comment": "A pointer to another, functionally similar product (or multiple products).", "rdfs:label": "isSimilarTo", "schema:contributor": { "@id": "https://schema.org/docs/collab/GoodRelationsTerms" }, "schema:domainIncludes": [ { "@id": "schema:Service" }, { "@id": "schema:Product" } ], "schema:rangeIncludes": [ { "@id": "schema:Product" }, { "@id": "schema:Service" } ] }, { "@id": "schema:brand", "@type": "rdf:Property", "rdfs:comment": "The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.", "rdfs:label": "brand", "schema:domainIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:Service" }, { "@id": "schema:Person" }, { "@id": "schema:Product" } ], "schema:rangeIncludes": [ { "@id": "schema:Brand" }, { "@id": "schema:Organization" } ] }, { "@id": "schema:produces", "@type": "rdf:Property", "rdfs:comment": "The tangible thing generated by the service, e.g. a passport, permit, etc.", "rdfs:label": "produces", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": { "@id": "schema:Thing" }, "schema:supersededBy": { "@id": "schema:serviceOutput" } }, { "@id": "schema:slogan", "@type": "rdf:Property", "rdfs:comment": "A slogan or motto associated with the item.", "rdfs:label": "slogan", "schema:domainIncludes": [ { "@id": "schema:Place" }, { "@id": "schema:Brand" }, { "@id": "schema:Product" }, { "@id": "schema:Organization" }, { "@id": "schema:Service" } ], "schema:rangeIncludes": { "@id": "schema:Text" } }, { "@id": "schema:broker", "@type": "rdf:Property", "rdfs:comment": "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.", "rdfs:label": "broker", "schema:domainIncludes": [ { "@id": "schema:Service" }, { "@id": "schema:Order" }, { "@id": "schema:Invoice" }, { "@id": "schema:Reservation" } ], "schema:rangeIncludes": [ { "@id": "schema:Organization" }, { "@id": "schema:Person" } ] }, { "@id": "schema:documentation", "@type": "rdf:Property", "rdfs:comment": "Further documentation describing the Web API in more detail.", "rdfs:label": "documentation", "schema:domainIncludes": { "@id": "schema:WebAPI" }, "schema:isPartOf": { "@id": "https://pending.schema.org" }, "schema:rangeIncludes": [ { "@id": "schema:CreativeWork" }, { "@id": "schema:URL" } ], "schema:source": { "@id": "https://github.com/schemaorg/schemaorg/issues/1423" } }, { "@id": "schema:potentialAction", "@type": "rdf:Property", "rdfs:comment": "Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.", "rdfs:label": "potentialAction", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": { "@id": "schema:Action" } }, { "@id": "schema:identifier", "@type": "rdf:Property", "owl:equivalentProperty": { "@id": "dcterms:identifier" }, "rdfs:comment": "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.\n ", "rdfs:label": "identifier", "schema:domainIncludes": { "@id": "schema:Thing" }, "schema:rangeIncludes": [ { "@id": "schema:URL" }, { "@id": "schema:PropertyValue" }, { "@id": "schema:Text" } ] }, { "@id": "schema:serviceAudience", "@type": "rdf:Property", "rdfs:comment": "The audience eligible for this service.", "rdfs:label": "serviceAudience", "schema:domainIncludes": { "@id": "schema:Service" }, "schema:rangeIncludes": { "@id": "schema:Audience" }, "schema:supersededBy": { "@id": "schema:audience" } } ] } </script> </body> </html>

CINXE.COM

WebAPI - Schema.org Type