{"swagger":"2.0","info":{"description":"The Ulrichsweb API is a programmatic way of searching the Ulrichsweb™ Global Serials Directory.","version":"2.0","title":"Ulrichsweb API","termsOfService":"https://developers.exlibrisgroup.com/termsofuse","contact":{"name":"Developer Network","url":"https://developers.exlibrisgroup.com"}},"host":"ulrichsweb.serialssolutions.com","basePath":"/","tags":[{"name":"Ulrichsweb Search API","description":"The Ulrichsweb Search API is a simple, HTTP-based service that provides an interface for programmatic searching of the Ulrichsweb™ Global Serials Directory and will return results in XML or JSON format."}],"paths":{"/api/json/{searchKey}/search":{"get":{"tags":["Ulrichsweb Search API"],"summary":"Search for titles given the query","description":"Returns titles that match the query in JSON format.","operationId":"JSONRequestUsingGET","produces":["application/json"],"parameters":[{"name":"filterQuery","in":"query","description":"Filter the search results by this query<div><b>Supported Filter Query Fields</b></div><ul><li>country</li><li>format</li><li>status</li><li>frequency</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":false,"type":"string","allowEmptyValue":false},{"name":"query","in":"query","description":"Search query<div><b>Supported Search Query Fields</b></div><ul><li>title</li><li>issn</li><li>publisher</li><li>country</li><li>country_description</li><li>subject_keyword</li><li>titleid</li><li>spell</li><li>alt_title</li><li>format</li><li>status</li><li>frequency</li><li>coden</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":true,"type":"string","allowEmptyValue":false},{"name":"rows","in":"query","description":"The number of search results to be returned. Defaults to 10 and max is 50","required":false,"type":"string","allowEmptyValue":false},{"name":"searchKey","in":"path","description":"A unique, 10-digit API key for your institution","required":true,"type":"string","allowEmptyValue":false},{"name":"sortIndex","in":"query","description":"The field to sort by. It can be any one of the supported search fields","required":false,"type":"string","allowEmptyValue":false},{"name":"sortOrder","in":"query","description":"The order in which the sort index is sorted. Can be asc or desc","required":false,"type":"string","allowEmptyValue":false},{"name":"start","in":"query","description":"The record number at the start of the search results. Defaults to 0","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Look at the status field returned to determine if the search was successfully","schema":{"$ref":"#/definitions/searchResults"}}}}},"/api/xml/{searchKey}/search":{"get":{"tags":["Ulrichsweb Search API"],"summary":"Search for titles given the query","description":"Returns titles that match the query in XML format.","operationId":"XMLRequestUsingGET","produces":["application/xml"],"parameters":[{"name":"filterQuery","in":"query","description":"Filter the search results by this query<div><b>Supported Filter Query Fields</b></div><ul><li>country</li><li>format</li><li>status</li><li>frequency</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":false,"type":"string","allowEmptyValue":false},{"name":"query","in":"query","description":"Search query<div><b>Supported Search Query Fields</b></div><ul><li>title</li><li>issn</li><li>publisher</li><li>country</li><li>country_description</li><li>subject_keyword</li><li>titleid</li><li>spell</li><li>alt_title</li><li>format</li><li>status</li><li>frequency</li><li>coden</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":true,"type":"string","allowEmptyValue":false},{"name":"rows","in":"query","description":"The number of search results to be returned. Defaults to 10 and max is 50","required":false,"type":"string","allowEmptyValue":false},{"name":"searchKey","in":"path","description":"A unique, 10-digit API key for your institution","required":true,"type":"string","allowEmptyValue":false},{"name":"sortIndex","in":"query","description":"The field to sort by. It can be any one of the supported search fields","required":false,"type":"string","allowEmptyValue":false},{"name":"sortOrder","in":"query","description":"The order in which the sort index is sorted. Can be asc or desc","required":false,"type":"string","allowEmptyValue":false},{"name":"start","in":"query","description":"The record number at the start of the search results. Defaults to 0","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Look at the status field returned to determine if the search was successfully","schema":{"$ref":"#/definitions/searchResults"}}}}},"/api/{searchKey}/advsearch":{"post":{"tags":["Ulrichsweb Search API"],"summary":"Search for titles given the query","description":"Returns titles that match the query in XML or JSON format based on the accept header.","operationId":"AdvancedSearchUsingPOST","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"advancedSearch","description":"Search query in XML or JSON format based on the content-type header<div><b>Supported Search Query Fields</b></div><ul><li>title</li><li>issn</li><li>publisher</li><li>country</li><li>country_description</li><li>subject_keyword</li><li>titleid</li><li>spell</li><li>alt_title</li><li>format</li><li>status</li><li>frequency</li><li>coden</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul><div><b>Supported Filter Query Fields</b></div><ul><li>country</li><li>format</li><li>status</li><li>frequency</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":true,"schema":{"$ref":"#/definitions/searchCriteria"}},{"name":"searchKey","in":"path","description":"A unique, 10-digit API key for your institution","required":true,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Look at the status field returned to determine if the search was successfully","schema":{"$ref":"#/definitions/searchResults"}}}}},"/api/{searchKey}/search":{"get":{"tags":["Ulrichsweb Search API"],"summary":"Search for titles given the query","description":"Returns titles that match the query in XML or JSON format based on the accept header.","operationId":"JSONSearchUsingGET","produces":["*/*","application/xml","application/json"],"parameters":[{"name":"filterQuery","in":"query","description":"Filter the search results by this query<div><b>Supported Filter Query Fields</b></div><ul><li>country</li><li>format</li><li>status</li><li>frequency</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":false,"type":"string","allowEmptyValue":false},{"name":"query","in":"query","description":"Search query<div><b>Supported Search Query Fields</b></div><ul><li>title</li><li>issn</li><li>publisher</li><li>country</li><li>country_description</li><li>subject_keyword</li><li>titleid</li><li>spell</li><li>alt_title</li><li>format</li><li>status</li><li>frequency</li><li>coden</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>","required":true,"type":"string","allowEmptyValue":false},{"name":"rows","in":"query","description":"The number of search results to be returned. Defaults to 10 and max is 50","required":false,"type":"string","allowEmptyValue":false},{"name":"searchKey","in":"path","description":"A unique, 10-digit API key for your institution","required":true,"type":"string","allowEmptyValue":false},{"name":"sortIndex","in":"query","description":"The field to sort by. It can be any one of the supported search fields","required":false,"type":"string","allowEmptyValue":false},{"name":"sortOrder","in":"query","description":"The order in which the sort index is sorted. Can be asc or desc","required":false,"type":"string","allowEmptyValue":false},{"name":"start","in":"query","description":"The record number at the start of the search results. Defaults to 0","required":false,"type":"string","allowEmptyValue":false}],"responses":{"200":{"description":"Look at the status field returned to determine if the search was successfully","schema":{"$ref":"#/definitions/searchResults"}}}}},"/api/{searchKey}/title/{titleId}":{"get":{"tags":["Ulrichsweb Search API"],"summary":"Get details about the title given the title ID","description":"Returns title details for the given title ID in XML or JSON format based on the accept header.","operationId":"titleDetailsUsingGET","produces":["*/*","application/xml","application/json"],"parameters":[{"name":"searchKey","in":"path","description":"A unique, 10-digit API key for your institution","required":true,"type":"string","allowEmptyValue":false},{"name":"titleId","in":"path","description":"The title ID to get detailed information","required":true,"type":"integer","allowEmptyValue":false,"format":"int64","x-example":1}],"responses":{"200":{"description":"Title details request was successfully","schema":{"$ref":"#/definitions/titleDetails"}},"400":{"description":"Invalid Request"},"401":{"description":"Invalid API Key"},"500":{"description":"Internal Server Error"}}}}},"definitions":{"ModelAndView":{"type":"object","properties":{"empty":{"type":"boolean"},"model":{"type":"object"},"modelMap":{"type":"object","additionalProperties":{"type":"object"}},"reference":{"type":"boolean"},"status":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"view":{"$ref":"#/definitions/View"},"viewName":{"type":"string"}},"title":"ModelAndView"},"Titles":{"type":"object","properties":{"UlrichTitle":{"type":"array","xml":{"name":"UlrichTitle","attribute":false,"wrapped":false},"description":"List of titles that match the query","items":{"$ref":"#/definitions/UlrichTitle"}}},"title":"Titles","description":"Ulrich's titles that matches the search query"},"UlrichTitle":{"type":"object","properties":{"abstractedIndexed":{"type":"boolean"},"availableOnline":{"type":"boolean","description":"Indication of whether the serial is available in an online format"},"coden":{"type":"string","example":"SCIQDX","description":"Alphanumeric code independently assigned by the Chemical Abstracts Service that uniquely identifies a serial, mainly for use on scientific and technical serials"},"contentTypes":{"type":"array","example":"Bibliography","description":"Controlled vocabulary term(s) denoting the primary target audience(s) of the serial","items":{"type":"string"}},"country":{"type":"string","example":"Denmark","description":"Country of publication text"},"countryCode":{"type":"string","example":"DNK","description":"Country of publication code"},"description":{"type":"string","description":"Text describing what the serial is about"},"deweyNumbers":{"type":"array","description":"Dewey Decimal Number(s) for the serial","items":{"type":"string"}},"formats":{"type":"array","example":"Print","description":"Controlled vocabulary term(s) denoting the Format edition(s) in which the serial is available","items":{"type":"string"}},"formatsCSV":{"type":"string"},"frequency":{"type":"string","example":"Daily","description":"Controlled vocabulary term denoting the Frequency of publication"},"historicTitle":{"type":"boolean","description":"Indication of whether the title is a former title of the serial (i.e., not the current title)"},"id":{"type":"string","description":"System identifier for the individual serial (Do not confuse with titleId)"},"issn":{"type":"string","description":"International Standard Serial Number of the format edition"},"keyFeatures":{"type":"array","description":"Translatable codes representing key feature(s) of the serial","items":{"type":"string"}},"languages":{"type":"array","description":"Language(s) in which the text of the serial is available","items":{"type":"string"}},"languagesCSV":{"type":"string"},"lcnumber":{"type":"string","description":"Library of Classification Number for the serial"},"openAccess":{"type":"boolean","description":"Indication of whether the serial is available via Open Access"},"openAccessUrl":{"type":"string","description":"If serial is Open Access, the Open Access URL for the serial"},"otherFeatures":{"type":"array","description":"Translatable codes representing additional feature(s) of the serial","items":{"type":"string"}},"price":{"type":"string","description":"Publisher-reported list price for the serial"},"publisher":{"type":"array","description":"Name of commercial publisher of the serial","items":{"type":"string"}},"refereed":{"type":"boolean","description":"Indication of whether the serial is Refereed/peer-reviewed"},"reviewed":{"type":"boolean","description":"Indication of whether the serial has a Magazines for Libraries™ review in the Ulrich’s record"},"rss":{"type":"array","description":"Type, frequency, source, description and URL of RSS feed available for the serial","items":{"$ref":"#/definitions/availabilityRSS"}},"serialTypes":{"type":"array","example":"Magazine","description":"Controlled vocabulary term(s) denoting the type(s) of serial","items":{"type":"string"}},"serialTypesCSV":{"type":"string"},"startYear":{"type":"string","example":1990,"description":"Year of first publication"},"status":{"type":"string","example":"Active","description":"Publication status of the serial"},"subject":{"type":"array","description":"Ulrich’s subject classification(s)","items":{"type":"string"}},"title":{"type":"string","description":"The preferred title of the serial"},"titleId":{"type":"string","description":"Unique Ulrich’s identifier for the title of the serial (Do not confuse with id)"},"toc":{"type":"boolean","description":"Indication of whether the serial displays Tables of Contents in Ulrichsweb"}},"title":"UlrichTitle","description":"Ulrich's title that matches the search query"},"View":{"type":"object","properties":{"contentType":{"type":"string"}},"title":"View"},"availabilityRSS":{"type":"object","properties":{"rssFrequencyCode":{"type":"string","example":"BW","description":"Translatable code denoting the frequency of the RSS feed"},"rssSourceDescription":{"type":"string","description":"Name of the source of the RSS feed (e.g., Publisher)"},"rssTypeCode":{"type":"string","example":"LI","description":"Translatable code denoting the type of RSS feed"},"rssUrl":{"type":"string","description":"URL of the RSS feed"}},"title":"availabilityRSS","description":"Available RSS feed"},"relatedTitles":{"type":"object","properties":{"relatedTitleId":{"type":"string","example":41749,"description":"Ulrich's Title ID for the related serial"},"relatedTitleIssn":{"type":"string","example":"1538-3598","description":"ISSN for the related serial"},"relatedTitleName":{"type":"string","example":"JAMA: The Journal of the American Medical Association","description":"Title of the related serial"},"relatedTitleType":{"type":"string","example":"Alternative Media Edition","description":"Title type of the related serial"},"relatedTitleTypeCode":{"type":"string","example":"ALTMED","description":"Title type code of the related serial"}},"title":"relatedTitles","description":"Ulrichsweb Related Titles"},"searchCriteria":{"type":"object","required":["advancedQuery"],"properties":{"advancedQuery":{"type":"string","example":"title:garden","description":"Search query<div><b>Supported Search Query Fields</b></div><ul><li>title</li><li>issn</li><li>publisher</li><li>country</li><li>country_description</li><li>subject_keyword</li><li>titleid</li><li>spell</li><li>alt_title</li><li>format</li><li>status</li><li>frequency</li><li>coden</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>"},"filterQuery":{"type":"string","example":"refereed:true","description":"Filter the search results by this query<div><b>Supported Filter Query Fields</b></div><ul><li>country</li><li>format</li><li>status</li><li>frequency</li><li>other_feature</li><li>serial_type</li><li>refereed</li><li>open_access</li><li>content_type</li><li>key_feature</li></ul>"},"rows":{"type":"integer","format":"int32","example":10,"description":"The number of search results to be returned. Defaults to 10 and max is 50"},"sortField":{"type":"string","example":"title","description":"The field to sort by. It can be any one of the supported search fields"},"sortOrder":{"type":"string","example":"asc","description":"Sort order","enum":["asc","desc"]},"start":{"type":"integer","format":"int32","example":0,"description":"The record number at the start of the search results. Defaults to 0"}},"title":"searchCriteria","description":"Used in the POST method to set the search criteria","xml":{"name":"searchCriteria","attribute":false,"wrapped":false}},"searchResults":{"type":"object","properties":{"numberOfRecords":{"type":"integer","format":"int32","example":1,"description":"The number of titles returned"},"requestFilterQuery":{"type":"string","example":"refereed:true","description":"The filter query used in the request"},"requestQuery":{"type":"string","example":"title:nature","description":"The query used in the request"},"requestRows":{"type":"string","example":1,"description":"The number of titles that were requested"},"requestSortIndex":{"type":"string","example":"title","description":"The sort field used in the request"},"requestSortOrder":{"type":"string","description":"Sort order","enum":["asc","desc"]},"requestStart":{"type":"string","example":0,"description":"The title number at the start of the title list"},"results":{"description":"List of titles that match the requested query","$ref":"#/definitions/Titles"},"status":{"type":"string","description":"Status of the query","enum":["Success","Error"]},"statusMessage":{"type":"string","description":"In the case of an Error, this will contain a diagnostic message"},"totalRecords":{"type":"integer","format":"int64","example":5,"description":"The total number of titles found that match the query"}},"title":"searchResults","description":"Response that is returned by the Ulrichsweb Search API"},"titleDetails":{"type":"object","properties":{"corporateAuthors":{"type":"array","example":[Transition],"description":"Corporate authors for the given title id","items":{"type":"string"}},"mflReviews":{"type":"array","example":[This is a MFL review],"description":"MFL reviews for the given title id","items":{"type":"string"}},"publicationHistory":{"type":"string","example":"1961-1968; New Series 1971-1977; New Series 1991 (vol.1, no.51)","description":"Publication history for the given title id"},"relatedTitles":{"type":"array","description":"Related titles for the given title id","items":{"$ref":"#/definitions/relatedTitles"}},"titleHistoryDetails":{"type":"array","description":"Title history for the given title id","items":{"$ref":"#/definitions/titleHistoryDetails"}},"variantTitles":{"description":"Variant titles for the given title id","$ref":"#/definitions/variantTitles"}},"title":"titleDetails","description":"Response that is returned by the Ulrichsweb Title Details API","xml":{"name":"titleDetails","attribute":false,"wrapped":false}},"titleHistoryDetails":{"type":"object","properties":{"titleHistoryComments":{"type":"string","description":"Title history comments"},"titleHistoryCountry":{"type":"string","description":"Title history country code"},"titleHistoryId":{"type":"integer","format":"int32","example":1,"description":"Title history sequence number"},"titleHistoryIssn":{"type":"string","description":"Title history ISSN"},"titleHistoryTitle":{"type":"string","description":"Title history title"}},"title":"titleHistoryDetails","description":"Ulrichsweb Title History Details"},"variantTitles":{"type":"object","properties":{"abbreviatedTitle":{"type":"array","example":[Abbreviated Title],"description":"The abbreviated titles of the serial","items":{"type":"string"}},"alternateTitle":{"type":"array","example":[Alternate Title],"description":"The alternate titles of the serial","items":{"type":"string"}},"medlineAbbrev":{"type":"array","example":[Medline Abbreviation],"description":"The MEDLINE abbreviations used in PubMed","items":{"type":"string"}},"parallelLanguageTitle":{"type":"array","example":[Parallel Title],"description":"The parallel language titles of the serial","items":{"type":"string"}}},"title":"variantTitles","description":"Alternate titles under which the serial is published"}}}