# /research/projects/termservices/WebServices/Dewey/Documents/SummariesServiceAPI.htm

originally: http://www.oclc.org/research/projects/termservices/WebServices/Dewey/Documents/SummariesServiceAPI.htm

# $node.name

The following operations are supported by the Dewey Summaries Service:

1. FindCompleteSummaryHierarchy
   - Request
   - Response
   - REST Interface
   - SOAP Interface
2. FindNearestSummaryClass
   - Request
   - Response
   - REST Interface
   - SOAP Interface

For a formal definition of these operations, please review the Service Description.

## FindCompleteSummaryHierarchy

The FindCompleteSummaryHierarchy operation allows you to retrive...

Request

  Request parameters specify the terms of your request and control the content that is returned to you. The following table lists the parameters that are available for this operation.

  Name | Description | Domain | Range
  --- | --- | --- | ---

  class | The Dewey® schedule class of interest. You can specify any schedule class found in the Dewey® schedules or built by the instructions found in the Dewey® schedules. The schedule class cannot be a centered entry† or a span of classes. A schedule class, by definition, must contain a minimum three digits. The first digit indicates the main class‡. The second digit indicates the division. The third digit indicates the section. A decimal point, or dot, follows the third digit in a class number after which digits are specified to the degree of classification needed. The value of this parameter is constrained by the level parameter, see below. † a centered entry represents a subject covered by a span of numbers. The entry is called "centered" because the span of numbers appears in the center of the page in the print edition of the DDC® rather than in the number column on the left side of the page. Centered entries are identified by the symbol > in the number column. ‡ a main class is one of the ten major subdivisions of the DDC®, represented by the first digit in the notation, e.g., 3 in 300 Social sciences. | REST Required SOAP Required | Valid values Non-spanned schedule class
  language | The ISO 639-1 or ISO 639-2 language code that you would prefer for content. The ISO 639-2 mul (multiple languages) code returns content in all available language. While the permissible range of values are any ISO 639-1 or ISO 639-2 language code, content is only available in select languages. | REST Optional SOAP Required | Default value mul Multiple languages Valid values ISO 639-1 code ISO 639-2 code Content values de, deu, ger German en, eng English es, spa Spanish fr, fra, fre French
  level | The summary level that you would prefer to constrain the value of the class parameter, see above. When the value LevelNone is used it is equivalent to using the default value, e.g., Level3. Since the class parameter allows you to specify any non-spanned class found in the Dewey® schedules or built by the instructions found in the Dewey® schedules, the level parameter constrains deeper level schedule classes to the top 1,000† summary level classes. † The summary level classes are often referred to the top 1,000 classes. However, there are actually 1,110 summary classes: 10 main classes‡ (first level summary classes), plus 100 division classes (second level summary classes), plus 1,000 section classes (third level summary classes). ‡ a main class is one of the ten major subdivisions of the DDC®, represented by the first digit in the notation, e.g., 3 in 300 Social sciences. | REST Optional SOAP Required | Default value Level3 Third level Valid values LevelNone Default level Level1 First level Level2 Second level Level3 Third level Content values Level1 First level Level2 Second level Level3 Third level
  edition | The Dewey® edition of the summaries that you would prefer to use. The latest edition of the Dewey Decimal Classification® is the twenty-second edition. | REST Optional SOAP Required | Default value EditionLatest Latest edition Valid values EditionLatest Latest edition Edition22 Edition 22 Content values Edition22 Edition 22

Response

  The response from this operation is an RDF/XML document.

REST Interface

  The following are templates of an HTTP request and response. The HTTP request template contains placeholders that need to be replaced with actual values. The placeholders shown in the HTTP response will change based on the values found in the request.

  Request Template
  GET /research/projects/termservices/WebServices/Dewey/SummariesService.asmx/FindCompleteSummaryHierarchy
  »?class=[Non-spanned schedule class]
  »&language=[ISO 639-1 code or ISO 639-2 code]
  »&level=[LevelNone or Level1 or Level2 or Level3]
  »&edition=[EditionLatest or Edition22]
  » HTTP/1.1
  Host: www.oclc.org
  Response Template
  HTTP/1.1 200 OK
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  <?xml version="1.0" encoding="utf-8"?>
  RDF/XML
SOAP Interface

  The following are templates of an HTTP request and response. The HTTP request template contains placeholders that need to be replaced with actual values. The placeholders shown in the HTTP response will change based on the values found in the request.

  Request Template
  POST /research/projects/termservices/WebServices/Dewey/SummariesService.asmx HTTP/1.1
  Host: www.oclc.org
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  SOAPAction: "urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E/FindCompleteSummaryHierarchy"
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  >
  <soap:Body>
  <class xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [Non-spanned schedule class]
  </class>
  <language xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [ISO 639-1 code or ISO 639-2 code]
  </language>
  <level xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [LevelNone or Level1 or Level2 or Level3]
  </level>
  <edition xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [EditionLatest or Edition22]
  </edition>
  </soap:Body>
  </soap:Envelope>
  Response Template
  HTTP/1.1 200 OK
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  >
  <soap:Body>
  <FindCompleteSummaryHierarchy xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  RDF/XML
  </FindCompleteSummaryHierarchy>
  </soap:Body>
  </soap:Envelope>

## FindNearestSummaryClass

The FindNearestSummaryClass operation allows you to retrive...

Request

  Request parameters specify the terms of your request and control the content that is returned to you. The following table lists the parameters that are available for this operation.

Response

  The response from this operation is an RDF/XML document.

REST Interface

  The following are templates of an HTTP request and response. The HTTP request template contains placeholders that need to be replaced with actual values. The placeholders shown in the HTTP response will change based on the values found in the request.

  Request Template
  GET /research/projects/termservices/WebServices/Dewey/SummariesService.asmx/FindNearestSummaryClass
  »?class=[Non-spanned schedule class]
  »&language=[ISO 639-1 code or ISO 639-2 code]
  »&level=[LevelNone or Level1 or Level2 or Level3]
  »&edition=[EditionLatest or Edition22]
  » HTTP/1.1
  Host: www.oclc.org
  Response Template
  HTTP/1.1 200 OK
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  <?xml version="1.0" encoding="utf-8"?>
  RDF/XML
SOAP Interface

  The following are templates of an HTTP request and response. The HTTP request template contains placeholders that need to be replaced with actual values. The placeholders shown in the HTTP response will change based on the values found in the request.

  Request Template
  POST /research/projects/termservices/WebServices/Dewey/SummariesService.asmx HTTP/1.1
  Host: www.oclc.org
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  SOAPAction: "urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E/FindNearestSummaryClass"
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  >
  <soap:Body>
  <class xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [Non-spanned schedule class]
  </class>
  <language xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [ISO 639-1 code or ISO 639-2 code]
  </language>
  <level xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [LevelNone or Level1 or Level2 or Level3]
  </level>
  <edition xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  [EditionLatest or Edition22]
  </edition>
  </soap:Body>
  </soap:Envelope>
  Response Template
  HTTP/1.1 200 OK
  Content-Type: text/xml; charset=utf-8
  Content-Length: length
  <?xml version="1.0" encoding="utf-8"?>
  <soap:Envelope
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  >
  <soap:Body>
  <FindNearestSummaryClass xmlns="urn:uuid:DDC90905-2D2E-47D7-97F7-902AFB70640E">
  RDF/XML
  </FindNearestSummaryClass>
  </soap:Body>
  </soap:Envelope>

Please send comments or questions to: kos@oclc.org.