Skip to content

Latest commit

 

History

History
169 lines (152 loc) · 7.09 KB

API_ISBN.md

File metadata and controls

169 lines (152 loc) · 7.09 KB

TLMS simple APIs

TLMS/searchByID?id={id}

This endpoint takes as input any identifier of a book (ISBN, ISSN, EAN) and returns information about title, author, other identifiers and volumes. See this document for BDRC's conventions to record ISBNs.

The HTTP header Accept-Language will have an impact on the results, set it to bo to get the Tibetan Unicode version.

where {id} is any identifier, the API is tailored to ISBNs, ISSNs and EANs.

There are 3 types of matches:

  • monovolume: the match is a one volume edition
  • full_multivolume: the match is a multi volume edition, all volumes could match
  • subset: the match is a multi-volume edition, only some volumes match

Example of a monovolume match (id=9789380359700, Accept-Language "bo"):

[
	{
		"id": "http://purl.bdrc.io/resource/MW1KG13995",
		"title": "བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ།",
		"match_type": "monovolume",
		"publisherName": "བོད་ཀྱི་དཔེ་མཛོད་ཁང་།",
		"publisherLocation": "dharamsala, h.p.",
		"publicationDate": "2012",
		"author_name": "བློ་བཟང་རྒྱལ་མཚན།",
		"author_id": "http://purl.bdrc.io/resource/P9521",
		"nb_volumes": 1,
		"thumbnail_iiif_service": "https://iiif.bdrc.io/bdr:I1KG14309::I1KG143090003.jpg",
		"ids": ["9789380359700"]
	}
]

Example of a subset match (?id=9787800579875), matches the first 6 volumes of MW1KG14896 but not the last 6. Note that the volumes object only contains volumes that match the given id.

[
	{
		"id": "http://purl.bdrc.io/resource/MW1KG14896",
		"title": "མང་ཚོགས་སྒྱུ་རྩལ།་ལེགས་རྩོམ་དཔེ་ཚོགས།",
		"nb_volumes": 12,
		"publisherName": "ཀྲུང་གོའི་བོད་རིག་པ་དཔེ་སྐྲུན་ཁང་།",
		"publisherLocation": "པེ་ཅིན།",
		"publicationDate": "2009/2010",
		"edition_statement": "པར་གཞི་དང་པོ།",
		"match_type": "subset",
		"thumbnail_iiif_service": "https://iiif.bdrc.io/bdr:I1KG14906::I1KG149060003.jpg",
		"ids": [],
		"volumes": [
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 1,
				"title": "Volume 1",
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14906"],
				"ids": ["9787800579875"]
			},
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 2,
				"title": "Volume 2",
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14907"],
				"ids": ["9787800579875"]
			},
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 3,
				"title": "Volume 3",
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14908"],
				"ids": ["9787800579875"]
			},
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 4,
				"title": "Volume 4",
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14909"],
				"ids": ["9787800579875"]
			},
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 5,
				"title": "Volume 5",
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14910"],
				"ids": ["9787800579875"]
			},
			{
				"id": "http://purl.bdrc.io/resource/MW1KG14896_O1KG14896_9D0E4TT10JYA",
				"volume_number": 6,
				"title": "Volume 6",
				"ids": ["9787800579875"],
				"image_groups": ["http://purl.bdrc.io/resource/I1KG14911"],
			}
		]
	}
]

In the case of a full_multivolume match (ex: ?id=9787540929800), the format is the same as a subset match except all volumes are listed.

Note that for each image group a thumbnail can be obtained directly through the IIIF server. For instance for image group http://purl.bdrc.io/resource/I1KG14911, the IIIF base URL is https://iiif.bdrc.io/bdr:I1KG14911::thumbnail/.

The results are in no particular order.

`TLMS/SearchByTitle?title={title}

This endpoint takes a title (or a part of a title) in Tibetan and returns each corresponding collection or volume in the exact same format as the ISBN search. It also takes the HTTP header Accept-Language into account.

The only different is the presence of a value title_matched in the root or in the matching volumes. The format of the field is an array of string where the matched part of the title is surrounded by the characters ↦ and ↤. For instance searching བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ will yield:

[
   {
      "id":"http://purl.bdrc.io/resource/MW1KG13995",
      "nb_volumes":1,
      "volumes":[
         {
            "ids":[],
            "image_groups":[
               "http://purl.bdrc.io/resource/I1KG14309"
            ],
            "volume_number":1
         }
      ],
      "ids":[
         "9789380359700"
      ],
      "author_id":"http://purl.bdrc.io/resource/P9521",
      "author_name":"བློ་བཟང་རྒྱལ་མཚན།",
      "title":"བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ།",
      "title_matched":[
         "↦བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ↤་ཡི་གར་འཇོ་བའི་རོལ་རྩེད།",
         "↦བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ↤།"
      ],
      "publisherName":"བོད་ཀྱི་དཔེ་མཛོད་ཁང་།",
      "publisherLocation":"dharamsala, h.p.",
      "publicationDate":"2012",
      "thumbnail_iiif_service":"https://iiif.bdrc.io/bdr:I1KG14309::I1KG143090003.jpg",
      "match_type":"monovolume"
   },
   {
      "id":"http://purl.bdrc.io/resource/MW22149",
      "nb_volumes":1,
      "volumes":[
         {
            "ids":[],
            "image_groups":[
               "http://purl.bdrc.io/resource/I1KG22960"
            ],
            "volume_number":1
         }
      ],
      "ids":[],
      "author_id":"http://purl.bdrc.io/resource/P9521",
      "author_name":"བློ་བཟང་རྒྱལ་མཚན།",
      "title":"བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ་ཡི་གར་འཇོ་བའི་རོལ་རྩེད།",
      "title_matched":[
         "↦བཞིན་བཟང་མ་གཏུམ་དྲག་རོལ་པའི་སྒྲུང་གཏམ↤་ཡི་གར་འཇོ་བའི་རོལ་རྩེད།"
      ],
      "publisherName":"བློ་བཟང་རྒྱལ་མཚན།",
      "publisherLocation":"མེན་པཱཊ།",
      "publicationDate":"1982",
      "thumbnail_iiif_service":"https://iiif.bdrc.io/bdr:I1KG22960::I1KG229600003.jpg",
      "match_type":"monovolume"
   }
]

The results are in no particular order.