Skip to main content

 Web service API

How to use PageSeeder's Web service API

get externaluri source metadata

/externaluris/{uri}/source/metadata [GET]

com.pageseeder.uri.FetchExternalURIMetadata

Description

Extract the metadata from the specified URL.

Parameters

NameDescriptionRequiredTypeDefault value
reloadtrue to reload the metadata cache (ignored for method=HEAD as not cached).nobooleanfalse
method
The HTTP method for loading the URL (GET|HEAD)noenum
GET

Permission

Any authenticated user can invoke this service.

Response

The output has the following format:

<url-source-metadata
     url="https://en.wikipedia.org/wiki/Wikipedia:Example"
     status="[ok|has_error|internal|invalid_host|malformed|
             not_found|ps_source|redirect|requires_authentication|
             unreachable|unsupported_scheme|virtual]"
     retrieved="2019-10-08T15:06:08+11:00"
     title="Wikipedia:Example - Wikipedia"
     description=""
     image=""
     icon="https://en.wikipedia.org/static/apple-touch/wikipedia.png"
     site-name="en.wikipedia.org"
     canonical=""
    [url-type=""]
    [error=""]>
  <meta name="..." value="..."/>
  ...
</url-source-metadata>

Error Handling

No specific errors expected for this service.

Created on , last edited on