Zetoc: SOAP Application Profile
| Change History |
|
| 2008-03-05 |
Added new terms introduced for UKPMC harvest.
|
| v1.2, 2006-09-28 |
Corrected general search request by adding dcterms:issued.
|
| v1.1, 2006-05-31 |
Corrected namespaces.
|
| v1.0, 2004-02-03 |
First version, developed for the A2Z project.
|
This document is an application profile that defines the metadata in the Zetoc SOAP interface, described according to the Dublin Core Application Profile Guidelines (CEN/ISSS CWA14860). In consideration of the document length only those application profile attributes necessary to define each property are included. Some attributes are not used at all within this application profile: type of term; refines; refined by; similar to; obligation.
'Occurrence' is defined as a minimum and maximum pair (Min; Max) effectively indicating where an occurence is mandatory. Note that all properties are required in a SOAP search request and response, but this occurrence refers to the a property having a non-null value.
The Zetoc SOAP interface provides four possible search request types that replicate the Zetoc Web interface search types. These are: GeneralRequest; JournalRequest; ConferenceRequest; IdentifierRequest.
It provides two response types: SearchResponse, for the first three request types; IdentifierSearchResponse, for IdentifierRequest.
Contents
Namespaces
| Term URI |
http://purl.org/dc/elements/1.1/ |
| Name |
dc: |
| Label |
Dublin Core |
| Term URI |
http://purl.org/dc/terms/ |
| Name |
dcterms: |
| Label |
Dublin Core terms |
| Term URI |
http://www.loc.gov/zing/srw/ |
| Name |
srw: |
| Label |
SRW (Search Retrieve Web) |
| Term URI |
http://zing.z3950.org/cql/bath/2.0/ |
| Name |
bath: |
| Label |
Z39.50 Bath Profile Indexes |
| Term URI |
info:ofi/fmt:xml:xsd:journal |
| Name |
oujnl: |
| Label |
OpenURL Journal XML Metadata Format |
| Term URI |
info:ofi/fmt:xml:xsd:book |
| Name |
oubook: |
| Label |
OpenURL Book XML Metadata Format |
| Term URI |
http://zetoc.mimas.ac.uk/soap/# |
| Name |
zetoc: |
| Label |
zetoc SOAP Interface |
Request and Response Entities
| Term URI |
http://zetoc.mimas.ac.uk/soap/#GeneralRequest |
| Name |
GeneralRequest |
| Label |
General Request |
| Definition |
A request for a general zetoc search over all records |
| DataType |
complex |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#JournalRequest |
| Name |
JournalRequest |
| Label |
Journal Request |
| Definition |
A request for a zetoc search over journal article records |
| DataType |
complex |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#ConferenceRequest |
| Name |
ConferenceRequest |
| Label |
Conference Request |
| Definition |
A request for a zetoc search over conference paper records |
| DataType |
complex |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#IdentifierRequest |
| Name |
IdentifierRequest |
| Label |
Identifier Request |
| Definition |
A request for the full zetoc record details of an article or paper from its identifier |
| DataType |
complex |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#SearchResponse |
| Name |
SearchResponse |
| Label |
Search Response |
| Definition |
A response to a general, journal, or conference zetoc search |
| DataType |
complex |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#IdentifierSearchResponse |
| Name |
IdentifierSearchResponse |
| Label |
Identifier Search Response |
| Definition |
A response to a zetoc full record request |
| DataType |
complex |
GeneralRequest Properties
| Term URI |
http://www.loc.gov/zing/srw/#startRecord |
| Name |
startRecord |
| Definition |
The position in the result set of the first record requested |
| Comments |
zetoc SOAP returns a fixed number of records (currently 25). To retrieve further results it is necessary to set startRecord > 1 |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zing.z3950.org/cql/bath/2.0/#any |
| Name |
any |
| Definition |
Search for the value of this property anywhere within a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/title |
| Name |
title |
| Definition |
Search for the value of this property within the title of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/creator |
| Name |
creator |
| Definition |
Search for the value of this property within the author of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#issnOrIsbn |
| Name |
issnOrIsbn |
| Label |
ISSN or ISBN |
| Definition |
Search for the value of this property within the ISSN or ISBN of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/terms/issued |
| Name |
issued |
| Label |
Year Issued |
| Definition |
Search for the value of this property within the publication year of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
JournalRequest Properties
| Term URI |
http://www.loc.gov/zing/srw/#startRecord |
| Name |
startRecord |
| Definition |
The position in the result set of the first record requested |
| Comments |
zetoc SOAP returns a fixed number of records (currently 25). To retrieve further results it is necessary to set startRecord > 1 |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zing.z3950.org/cql/bath/2.0/#any |
| Name |
any |
| Definition |
Search for the value of this property anywhere within a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/title |
| Name |
title |
| Definition |
Search for the value of this property within the title of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/creator |
| Name |
creator |
| Definition |
Search for the value of this property within the author of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#jtitle |
| Name |
jtitle |
| Label |
Journal Title |
| Definition |
Search for the value of this property within the journal title of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#issn |
| Name |
issn |
| Definition |
Search for the value of this property within the ISSN of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#volume |
| Name |
volume |
| Definition |
Search for the value of this property within the volume of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#issue |
| Name |
issue |
| Definition |
Search for the value of this property within the issue of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#spage |
| Name |
spage |
| Label |
Start Page |
| Definition |
Search for the value of this property within the start page of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/terms/issued |
| Name |
issued |
| Label |
Year Issued |
| Definition |
Search for the value of this property within the publication year of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
ConferenceRequest Properties
| Term URI |
http://www.loc.gov/zing/srw/#startRecord |
| Name |
startRecord |
| Definition |
The position in the result set of the first record requested |
| Comments |
zetoc SOAP returns a fixed number of records (currently 25). To retrieve further results it is necessary to set startRecord > 1 |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zing.z3950.org/cql/bath/2.0/#any |
| Name |
any |
| Definition |
Search for the value of this property anywhere within a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/title |
| Name |
title |
| Definition |
Search for the value of this property within the title of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/creator |
| Name |
creator |
| Definition |
Search for the value of this property within the author of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/subject |
| Name |
subject |
| Definition |
Search for the value of this property within the conference keywords of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zing.z3950.org/cql/bath/2.0/#conferenceName |
| Name |
conferenceName |
| Definition |
Search for the value of this property within the conference details of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:book#isbn |
| Name |
isbn |
| Definition |
Search for the value of this property within the ISBN of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:book#spage |
| Name |
spage |
| Label |
Start Page |
| Definition |
Search for the value of this property within the start page of a record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
IdentifierRequest Properties
| Term URI |
http://purl.org/dc/elements/1.1/identifier |
| Name |
identifier |
| Definition |
Search for the value of this property as the zetoc identifier of a record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
SearchResponse Properties
| Term URI |
http://www.loc.gov/zing/srw/#numberOfRecords |
| Name |
numberOfRecords |
| Definition |
The total number of hits returned by the search request |
| Comments |
A maximum fixed number of results is returned, currently 25, which may be less than numberOfRecords. The results returned start from the startRecord (in the SearchRequest) position within the result set |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://www.loc.gov/zing/srw/#nextRecordPosition |
| Name |
nextRecordPosition |
| Definition |
The position in the result set of the next record following those returned in the SearchResponse |
| Comments |
If there are no further records in the result set this will be zero. Otherwise it will be: startRecord (in the SearchRequest) + the fixed number of records (25) returned |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#theSearch |
| Name |
theSearch |
| Label |
The Search |
| Definition |
The search performed |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#ArrayOfBriefRecord |
| Name |
ArrayOfBriefRecord |
| Label |
Array of Brief Records |
| Definition |
An array of BriefRecords each element of which contains a search result |
| Comments |
If the search found no hits the array will be empty |
| DataType |
Array |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#BriefRecord |
| Name |
BriefRecord |
| Label |
Brief Record |
| Definition |
A brief record detailing a single search hit |
| Comments |
The set of properties contained in a BriefRecord is detailed below |
| DataType |
complex |
BriefRecord Properties
| Term URI |
http://www.loc.gov/zing/srw/#recordPosition |
| Name |
recordPosition |
| Definition |
The position in the result set of this brief record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/title |
| Name |
title |
| Definition |
The title of the brief record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/creator |
| Name |
creator |
| Definition |
The author(s) of the brief record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/terms/bibliographicCitation |
| Name |
bibliographicCitation |
| Definition |
The bibliographic citation details of the brief record |
| Comments |
This will indicate the journal issue or conference proceedings details of the record including the page number |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/identifier |
| Name |
identifier |
| Definition |
The zetoc identifier of the brief record |
| Comments |
This identifier can be used in an IdentifierSearch Request to retrieve the full record details |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
IdentifierSearchResponse Properties
| Term URI |
http://www.loc.gov/zing/srw/#numberOfRecords |
| Name |
numberOfRecords |
| Definition |
The total number of hits returned by the search request |
| Comments |
This should always be one |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/identifier |
| Name |
identifier |
| Definition |
The zetoc identifier of the full record |
| Comments |
This is the same identifier as was used in the IdentifierRequest |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#type |
| Name |
type |
| Label |
zetoc Record Type |
| Definition |
Indication of whether this is a zetoc journal (J) or a conference (C) record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/title |
| Name |
title |
| Definition |
The article or paper title of the full record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/creator |
| Name |
creator |
| Definition |
The author(s) of a full record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#dewey |
| Name |
dewey |
| Label |
Dewey Classification |
| Definition |
Dewey classification of record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#lccn |
| Name |
lccn |
| Label |
Library of Congress Classification |
| Definition |
Library of Congress classification of record |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/description |
| Name |
description |
| Definition |
The abstract of the full record |
| Comments |
Note that very few, and no current, zetoc records have abstracts |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#jtitle |
| Name |
jtitle |
| Label |
Journal Title |
| Definition |
Journal title of full record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#jnlIssueTitle |
| Name |
jnlIssueTitle |
| Label |
Journal Issue Title |
| Definition |
Title specific to a journal issue |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#issn |
| Name |
issn |
| Definition |
Journal ISSN of full record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#eissn |
| Name |
eissn |
| Definition |
Journal eISSN of full record |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#volissue |
| Name |
volissue |
| Label |
Volume and Issue |
| Definition |
Journal volume and issue details |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:journal#pages |
| Name |
pages |
| Label |
Pagination |
| Definition |
Page range of article in journal issue or conference proceedings |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/terms/issued |
| Name |
issued |
| Label |
Year Issued |
| Definition |
Publication year |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/contributor |
| Name |
contributor |
| Definition |
The editor(s) of a journal issue or conference proceedings |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#conf |
| Name |
conf |
| Label |
Conference |
| Definition |
Conference and proceedings details |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/subject |
| Name |
subject |
| Definition |
Conference keywords |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#sponsor |
| Name |
| Label |
Sponsor |
| Definition |
Conference sponsor(s) |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://openurl.info/registry/docs/info:ofi/fmt:xml:xsd:book#isbn |
| Name |
isbn |
| Definition |
ISBN(s) of conference proceedings |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/publisher |
| Name |
publisher |
| Definition |
Publisher of journal or conference proceedings |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#frequency |
| Name |
frequency |
| Label |
Frequency of Publication |
| Definition |
Publication frequency of a journal |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/language |
| Name |
language |
| Definition |
Language of article or paper |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/format |
| Name |
format |
| Definition |
Medium of publication of journal |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://purl.org/dc/elements/1.1/type |
| Name |
type |
| Definition |
Material type of conference paper |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#shelfmark |
| Name |
shelfmark |
| Label |
British Library Shelfmark |
| Definition |
British Library shelfmark of journal issue or conference proceedings |
| DataType |
string |
| Occurrence |
Min: 1; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#location |
| Name |
location |
| Label |
British Library Location |
| Definition |
British Library location of conference proceedings |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#pmid |
| Name |
pmid |
| Label |
PubMed ID |
| Definition |
PubMed identifier of article |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#doi |
| Name |
doi |
| Label |
DOI |
| Definition |
Digital Object Identifier of article |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
| Term URI |
http://zetoc.mimas.ac.uk/soap/#copyright |
| Name |
copyright |
| Label |
Copyright |
| Definition |
Copyright that applies to article |
| DataType |
string |
| Occurrence |
Min: 0; Max: 1 |
This work is licensed under a
Creative Commons Licence: Attribution Required; Non-Commercial; Share-Alike.
