Skip to content

bookops_worldcat.metadata_api

WorldCat Metadata API wrapper session.

MetadataSession 

MetadataSession(
    authorization: WorldcatAccessToken,
    agent: Optional[str] = None,
    timeout: Union[
        int,
        float,
        Tuple[int, int],
        Tuple[float, float],
        None,
    ] = (5, 5),
    totalRetries: int = 0,
    backoffFactor: float = 0,
    statusForcelist: Optional[List[int]] = None,
    allowedMethods: Optional[List[str]] = None,
)

Bases: WorldcatSession

The MetadataSession class supports interactions with the WorldCat Metadata API and the child methods of this class allow users to interact with each endpoint of the API.

MetadataSession inherits attributes and methods from requests.Session and WorldcatSession and contains specific functionality for interacting with the WorldCat Metadata API.

PARAMETER DESCRIPTION
authorization

WorldcatAccessToken object for session.

TYPE: WorldcatAccessToken

agent

User-agent for session to be passed in the request header. Usage is strongly encouraged.

TYPE: Optional[str] DEFAULT: None

timeout

How long to wait for server to send data before giving up. Accepts separate values for connect and read timeouts or a single value.

TYPE: Union[int, float, Tuple[int, int], Tuple[float, float], None] DEFAULT: (5, 5)

totalRetries

Optional number of times to retry a request that failed or timed out. If totalRetries argument is not passed, any arguments passed to backoffFactor, statusForcelist, and allowedMethods will be ignored.

TYPE: int DEFAULT: 0

backoffFactor

If totalRetries is not 0, the backoff factor as a float to use to calculate amount of time session will sleep before attempting request again.

TYPE: float DEFAULT: 0

statusForcelist

If totalRetries is not 0, a list of HTTP status codes to automatically retry requests on. If not specified, failed requests with status codes 413, 429, and 503 will be retried up to number of totalRetries.

EXAMPLE: [500, 502, 503, 504]

TYPE: Optional[List[int]] DEFAULT: None

allowedMethods

If totalRetries is not 0, set of HTTP methods that requests should be retried on. If not specified, requests using any HTTP method verbs will be retried.

EXAMPLE: ["GET", "POST"]

TYPE: Optional[List[str]] DEFAULT: None

Source code in bookops_worldcat\metadata_api.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def __init__(
    self,
    authorization: WorldcatAccessToken,
    agent: Optional[str] = None,
    timeout: Union[int, float, Tuple[int, int], Tuple[float, float], None] = (
        5,
        5,
    ),
    totalRetries: int = 0,
    backoffFactor: float = 0,
    statusForcelist: Optional[List[int]] = None,
    allowedMethods: Optional[List[str]] = None,
) -> None:
    """Initializes MetadataSession.

    Args:
        authorization:
            `WorldcatAccessToken` object for session.
        agent:
            `User-agent` for session to be passed in the request header. Usage is
            strongly encouraged.
        timeout:
            How long to wait for server to send data before giving up. Accepts
            separate values for connect and read timeouts or a single value.
        totalRetries:
            Optional number of times to retry a request that failed or timed out.
            If `totalRetries` argument is not passed, any arguments passed to
            `backoffFactor`, `statusForcelist`, and `allowedMethods` will be
            ignored.
        backoffFactor:
            If `totalRetries` is not `0`, the backoff factor as a float to use to
            calculate amount of time session will sleep before attempting request
            again.
        statusForcelist:
            If `totalRetries` is not `0`, a list of HTTP status codes to
            automatically retry requests on. If not specified, failed requests
            with status codes 413, 429, and 503 will be retried up to number of
            `totalRetries`.

            **EXAMPLE:** `[500, 502, 503, 504]`
        allowedMethods:
            If `totalRetries` is not `0`, set of HTTP methods that requests should
            be retried on. If not specified, requests using any HTTP method verbs
            will be retried.

            **EXAMPLE:** `["GET", "POST"]`
    """
    super().__init__(
        authorization,
        agent=agent,
        timeout=timeout,
        totalRetries=totalRetries,
        backoffFactor=backoffFactor,
        statusForcelist=statusForcelist,
        allowedMethods=allowedMethods,
    )

bib_create 

bib_create(
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Create a bib record in OCLC if it does not already exist.

Uses /manage/bibs endpoint.

PARAMETER DESCRIPTION
record

MARC record to be created

TYPE: Union[str, bytes, BinaryIO]

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
def bib_create(
    self,
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Create a bib record in OCLC if it does not already exist.

    Uses /manage/bibs endpoint.

    Args:
        record:
            MARC record to be created
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_bibs_create()
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_get 

bib_get(
    oclcNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Send a GET request for a full bib record.

Uses /manage/bibs/{oclcNumber} endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
def bib_get(
    self,
    oclcNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Send a GET request for a full bib record.

    Uses /manage/bibs/{oclcNumber} endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_manage_bibs(oclcNumber)
    header = {"Accept": responseFormat}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_get_classification 

bib_get_classification(
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given an OCLC number, retrieve classification recommendations for the bib record.

Uses /search/classification-bibs/{oclcNumber} endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
def bib_get_classification(
    self,
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given an OCLC number, retrieve classification recommendations for the bib
    record.

    Uses /search/classification-bibs/{oclcNumber} endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_classification_bibs(oclcNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_get_current_oclc_number 

bib_get_current_oclc_number(
    oclcNumbers: Union[int, str, List[Union[str, int]]],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given one or more OCLC Numbers, retrieve current OCLC numbers.

Uses /manage/bibs/current endpoint.

PARAMETER DESCRIPTION
oclcNumbers

Integer, string or list containing one or more OCLC numbers to be checked. Numbers can be integers or strings with or without OCLC Number prefix. If str, the numbers must be separated by a comma. If int, only one number may be passed as an arg.

TYPE: Union[int, str, List[Union[str, int]]]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RAISES DESCRIPTION
ValueError

If more than 10 items passed to oclcNumbers arg.
Source code in bookops_worldcat\metadata_api.py 
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
def bib_get_current_oclc_number(
    self,
    oclcNumbers: Union[int, str, List[Union[str, int]]],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given one or more OCLC Numbers, retrieve current OCLC numbers.

    Uses /manage/bibs/current endpoint.

    Args:
        oclcNumbers:
            Integer, string or list containing one or more OCLC numbers to be
            checked. Numbers can be integers or strings with or without OCLC
            Number prefix. If str, the numbers must be separated by a comma.
            If int, only one number may be passed as an arg.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Raises:
        ValueError: If more than 10 items passed to `oclcNumbers` arg.
    """
    vetted_numbers = verify_oclc_numbers(oclcNumbers)

    # check that no more than 10 oclc numbers were passed
    if len(vetted_numbers) > 10:
        raise ValueError("Too many OCLC Numbers passed to 'oclcNumbers' argument.")

    header = {"Accept": "application/json"}
    url = self._url_manage_bibs_current_oclc_number()
    payload = {"oclcNumbers": ",".join(vetted_numbers)}

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_match 

bib_match(
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a bib record in MARC21 or MARCXML identify the best match in WorldCat. Record must contain at minimum an 008 and 245. Response contains number of potential matches in numberOfRecords and best match in briefRecords.

Uses /manage/bibs/match endpoint.

PARAMETER DESCRIPTION
record

MARC record to be matched.

TYPE: Union[str, bytes, BinaryIO]

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
def bib_match(
    self,
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a bib record in MARC21 or MARCXML identify the best match in WorldCat.
    Record must contain at minimum an 008 and 245. Response contains number of
    potential matches in `numberOfRecords` and best match in `briefRecords`.

    Uses /manage/bibs/match endpoint.

    Args:
        record:
            MARC record to be matched.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_bibs_match()
    header = {
        "Accept": "application/json",
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_replace 

bib_replace(
    oclcNumber: Union[int, str],
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given an OCLC number and MARC record, find record in WorldCat and replace it. If the record does not exist in WorldCat, a new bib record will be created.

Uses /manage/bibs/{oclcNumber} endpoint.

PARAMETER DESCRIPTION
record

MARC record to replace existing WorldCat record

TYPE: Union[str, bytes, BinaryIO]

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
def bib_replace(
    self,
    oclcNumber: Union[int, str],
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given an OCLC number and MARC record, find record in WorldCat and replace it.
    If the record does not exist in WorldCat, a new bib record will be created.

    Uses /manage/bibs/{oclcNumber} endpoint.

    Args:
        record:
            MARC record to replace existing WorldCat record
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_manage_bibs(oclcNumber)
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("PUT", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

bib_validate 

bib_validate(
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    validationLevel: str = "validateFull",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a bib record, validate that record conforms to MARC standards.

Uses /manage/bibs/validate/{validationLevel} endpoint.

PARAMETER DESCRIPTION
record

MARC record to validate

TYPE: Union[str, bytes, BinaryIO]

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

validationLevel

Level at which to validate records.

OPTIONS: 'validateFull', 'validateAdd', 'validateReplace'

TYPE: str DEFAULT: 'validateFull'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
RAISES DESCRIPTION
ValueError

If value of arg passed to validationLevel is not 'validateFull', 'validateAdd', or 'validateReplace'.
Source code in bookops_worldcat\metadata_api.py 
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
def bib_validate(
    self,
    record: Union[str, bytes, BinaryIO],
    recordFormat: str,
    validationLevel: str = "validateFull",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a bib record, validate that record conforms to MARC standards.

    Uses /manage/bibs/validate/{validationLevel} endpoint.

    Args:
        record:
            MARC record to validate
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        validationLevel:
            Level at which to validate records.

            **OPTIONS:** `'validateFull'`, `'validateAdd'`, `'validateReplace'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance

    Raises:
        ValueError:
            If value of arg passed to `validationLevel` is not
            `'validateFull'`, `'validateAdd'`, or `'validateReplace'`.
    """
    if validationLevel not in ["validateFull", "validateAdd", "validateReplace"]:
        raise ValueError(
            "Invalid argument 'validationLevel'."
            "Must be either 'validateFull', 'validateAdd', or 'validateReplace'"
        )

    url = self._url_manage_bibs_validate(validationLevel)
    header = {
        "Accept": "application/json",
        "content-type": recordFormat,
    }

    # prep request
    req = Request(
        "POST",
        url,
        data=record,
        headers=header,
        hooks=hooks,
    )
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

brief_bibs_get 

brief_bibs_get(
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Retrieve specific brief bibliographic resource.

Uses /search/brief-bibs/{oclcNumber} endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
def brief_bibs_get(
    self, oclcNumber: Union[int, str], hooks: Optional[Dict[str, Callable]] = None
) -> Optional[Response]:
    """
    Retrieve specific brief bibliographic resource.

    Uses /search/brief-bibs/{oclcNumber} endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_brief_bibs_oclc_number(oclcNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

brief_bibs_get_other_editions 

brief_bibs_get_other_editions(
    oclcNumber: Union[int, str],
    deweyNumber: Optional[Union[str, List[str]]] = None,
    datePublished: Optional[Union[str, List[str]]] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[Union[str, List[str]]] = None,
    heldByInstitutionID: Optional[
        Union[str, int, List[Union[str, int]]]
    ] = None,
    inLanguage: Optional[Union[str, List[str]]] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[Union[str, List[str]]] = None,
    itemSubType: Optional[Union[str, List[str]]] = None,
    retentionCommitments: bool = False,
    spProgram: Optional[str] = None,
    genre: Optional[str] = None,
    topic: Optional[str] = None,
    subtopic: Optional[str] = None,
    audience: Optional[str] = None,
    content: Optional[Union[str, List[str]]] = None,
    openAccess: Optional[bool] = None,
    peerReviewed: Optional[bool] = None,
    facets: Optional[Union[str, List[str]]] = None,
    groupVariantRecords: bool = False,
    preferredLanguage: str = "eng",
    showHoldingsIndicators: bool = False,
    offset: int = 1,
    limit: int = 10,
    orderBy: str = "publicationDateDesc",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Retrieve other editions related to bibliographic resource with provided OCLC Number. Query may contain only one of: heldByInstitutionID, heldByGroup, heldBySymbol, or spProgram.

Uses /brief-bibs/{oclcNumber}/other-editions endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

deweyNumber

Limits response to the specified dewey classification number(s). For multiple values repeat the parameter.

EXAMPLE: '794'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

datePublished

Limits response to one or more dates, or to a range.

EXAMPLES: '2000', '2000-2005', '2000,2005'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

heldByGroup

Limits response to holdings held by group symbol.

TYPE: Optional[str] DEFAULT: None

heldBySymbol

Limits response to holdings held by specified institution symbol.

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

heldByInstitutionID

Limits response to holdings held by specified institution registryId.

TYPE: Optional[Union[str, int, List[Union[str, int]]]] DEFAULT: None

inLanguage

Limits response to the single specified language

EXAMPLE: 'fre'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

inCatalogLanguage

Limits response to specified cataloging language.

EXAMPLE: 'eng'

TYPE: Optional[str] DEFAULT: 'eng'

materialType

Limits response to specified material type.

EXAMPLES: 'bks', 'vis'

TYPE: Optional[str] DEFAULT: None

catalogSource

Limits response to single OCLC symbol as the cataloging source.

EXAMPLE: 'DLC'

TYPE: Optional[str] DEFAULT: None

itemType

Limits response to specified item type.

EXAMPLES: 'book', 'vis'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

itemSubType

Limits response to specified item sub type

EXAMPLES: 'book-digital', 'audiobook-cd'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

retentionCommitments

Limits response to bibliographic records with retention commitment.

OPTIONS: True or False

TYPE: bool DEFAULT: False

spProgram

Limits response to bibliographic records associated with particular shared print program.

TYPE: Optional[str] DEFAULT: None

genre

Genre to limit response to (ge index).

TYPE: Optional[str] DEFAULT: None

topic

Topic to limit response to (s0 index).

TYPE: Optional[str] DEFAULT: None

subtopic

Subtopic to limit response to (s1 index).

TYPE: Optional[str] DEFAULT: None

audience

Audience to limit response to.

OPTIONS: 'juv' or 'nonJuv'

TYPE: Optional[str] DEFAULT: None

content

Content to limit response to.

OPTIONS: 'fic', 'nonFic', 'bio'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

openAccess

Limits response to just open access content.

TYPE: Optional[bool] DEFAULT: None

peerReviewed

Limits response to just peer reviewed content.

TYPE: Optional[bool] DEFAULT: None

facets

List of facets to limit responses.

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

groupVariantRecords

Whether or not to group variant records.

OPTIONS: True or False

TYPE: bool DEFAULT: False

preferredLanguage

Language user would prefer metadata description in. Does not limit responses. To limit responses use inCataloglanguage facet.

TYPE: str DEFAULT: 'eng'

showHoldingsIndicators

Whether or not to show holdings indicators in response.

OPTIONS: True or False

TYPE: bool DEFAULT: False

offset

Start position of bibliographic records to return.

TYPE: int DEFAULT: 1

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

orderBy

Results sort key.

OPTIONS:

  • 'recency'
  • 'bestMatch'
  • 'creator'
  • 'library'
  • 'publicationDateAsc'
  • 'publicationDateDesc'
  • 'mostWidelyHeld'
  • 'title'

TYPE: str DEFAULT: 'publicationDateDesc'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
def brief_bibs_get_other_editions(
    self,
    oclcNumber: Union[int, str],
    deweyNumber: Optional[Union[str, List[str]]] = None,
    datePublished: Optional[Union[str, List[str]]] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[Union[str, List[str]]] = None,
    heldByInstitutionID: Optional[Union[str, int, List[Union[str, int]]]] = None,
    inLanguage: Optional[Union[str, List[str]]] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[Union[str, List[str]]] = None,
    itemSubType: Optional[Union[str, List[str]]] = None,
    retentionCommitments: bool = False,
    spProgram: Optional[str] = None,
    genre: Optional[str] = None,
    topic: Optional[str] = None,
    subtopic: Optional[str] = None,
    audience: Optional[str] = None,
    content: Optional[Union[str, List[str]]] = None,
    openAccess: Optional[bool] = None,
    peerReviewed: Optional[bool] = None,
    facets: Optional[Union[str, List[str]]] = None,
    groupVariantRecords: bool = False,
    preferredLanguage: str = "eng",
    showHoldingsIndicators: bool = False,
    offset: int = 1,
    limit: int = 10,
    orderBy: str = "publicationDateDesc",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Retrieve other editions related to bibliographic resource with provided
    OCLC Number. Query may contain only one of: `heldByInstitutionID`,
    `heldByGroup`, `heldBySymbol`, or `spProgram`.

    Uses /brief-bibs/{oclcNumber}/other-editions endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        deweyNumber:
            Limits response to the specified dewey classification number(s).
            For multiple values repeat the parameter.

            **EXAMPLE:** `'794'`
        datePublished:
            Limits response to one or more dates, or to a range.

            **EXAMPLES:** `'2000'`, `'2000-2005'`, `'2000,2005'`
        heldByGroup:
            Limits response to holdings held by group symbol.
        heldBySymbol:
            Limits response to holdings held by specified institution symbol.
        heldByInstitutionID:
            Limits response to holdings held by specified institution registryId.
        inLanguage:
            Limits response to the single specified language

            **EXAMPLE:** `'fre'`
        inCatalogLanguage:
            Limits response to specified cataloging language.

            **EXAMPLE:** `'eng'`
        materialType:
            Limits response to specified material type.

            **EXAMPLES:** `'bks'`, `'vis'`
        catalogSource:
            Limits response to single OCLC symbol as the cataloging source.

            **EXAMPLE:** `'DLC'`
        itemType:
            Limits response to specified item type.

            **EXAMPLES:** `'book'`, `'vis'`
        itemSubType:
            Limits response to specified item sub type

            **EXAMPLES:** `'book-digital'`, `'audiobook-cd'`
        retentionCommitments:
            Limits response to bibliographic records with retention commitment.

            **OPTIONS:** `True` or `False`
        spProgram:
            Limits response to bibliographic records associated with particular
            shared print program.
        genre:
            Genre to limit response to (ge index).
        topic:
            Topic to limit response to (s0 index).
        subtopic:
            Subtopic to limit response to (s1 index).
        audience:
            Audience to limit response to.

            **OPTIONS:** `'juv'` or `'nonJuv'`
        content:
            Content to limit response to.

            **OPTIONS:** `'fic'`, `'nonFic'`, `'bio'`
        openAccess:
            Limits response to just open access content.
        peerReviewed:
            Limits response to just peer reviewed content.
        facets:
            List of facets to limit responses.
        groupVariantRecords:
            Whether or not to group variant records.

            **OPTIONS:** `True` or `False`
        preferredLanguage:
            Language user would prefer metadata description in. Does not limit
            responses. To limit responses use `inCataloglanguage` facet.
        showHoldingsIndicators:
            Whether or not to show holdings indicators in response.

            **OPTIONS:** `True` or `False`
        offset:
            Start position of bibliographic records to return.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        orderBy:
            Results sort key.

            **OPTIONS:**

            - `'recency'`
            - `'bestMatch'`
            - `'creator'`
            - `'library'`
            - `'publicationDateAsc'`
            - `'publicationDateDesc'`
            - `'mostWidelyHeld'`
            - `'title'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_brief_bibs_other_editions(oclcNumber)
    header = {"Accept": "application/json"}
    payload = {
        "deweyNumber": deweyNumber,
        "datePublished": datePublished,
        "heldByGroup": heldByGroup,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "inLanguage": inLanguage,
        "inCatalogLanguage": inCatalogLanguage,
        "materialType": materialType,
        "catalogSource": catalogSource,
        "itemType": itemType,
        "itemSubType": itemSubType,
        "retentionCommitments": retentionCommitments,
        "spProgram": spProgram,
        "genre": genre,
        "topic": topic,
        "subtopic": subtopic,
        "audience": audience,
        "content": content,
        "openAccess": openAccess,
        "peerReviewed": peerReviewed,
        "facets": facets,
        "groupVariantRecords": groupVariantRecords,
        "preferredLanguage": preferredLanguage,
        "showHoldingsIndicators": showHoldingsIndicators,
        "offset": offset,
        "limit": limit,
        "orderBy": orderBy,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

brief_bibs_search(
    q: str,
    deweyNumber: Optional[Union[str, List[str]]] = None,
    datePublished: Optional[Union[str, List[str]]] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[Union[str, List[str]]] = None,
    heldByInstitutionID: Optional[
        Union[str, int, List[str], List[int]]
    ] = None,
    inLanguage: Optional[Union[str, List[str]]] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[Union[str, List[str]]] = None,
    itemSubType: Optional[Union[str, List[str]]] = None,
    retentionCommitments: bool = False,
    spProgram: Optional[str] = None,
    genre: Optional[str] = None,
    topic: Optional[str] = None,
    subtopic: Optional[str] = None,
    audience: Optional[str] = None,
    content: Optional[Union[str, List[str]]] = None,
    openAccess: Optional[bool] = None,
    peerReviewed: Optional[bool] = None,
    facets: Optional[Union[str, List[str]]] = None,
    groupRelatedEditions: bool = False,
    groupVariantRecords: bool = False,
    preferredLanguage: str = "eng",
    showHoldingsIndicators: bool = False,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    orderBy: str = "bestMatch",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Search for brief bibliographic resources using WorldCat query syntax. See OCLC Bibliographic Records Index Documentation for more information on available indexes. Request may contain only one of: heldByInstitutionID, heldByGroup, heldBySymbol, or combination of lat and lon.

Uses /search/brief-bibs endpoint.

PARAMETER DESCRIPTION
q

Query in the form of a keyword search or fielded search.

EXAMPLES:

  • ti:Zendegi
  • ti:"Czarne oceany"
  • bn:9781680502404
  • kw:python databases
  • ti:Zendegi AND au:greg egan
  • (au:Okken OR au:Myers) AND su:python

TYPE: str

deweyNumber

Limits the response to the specified dewey classification number(s). For multiple values repeat the parameter.

EXAMPLE: '794'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

datePublished

Restricts the response to one or more dates, or to a range.

EXAMPLES: '2000', '2000-2005', '2000,2005'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

heldByGroup

Limits response to holdings held by group symbol.

TYPE: Optional[str] DEFAULT: None

heldBySymbol

Limits response to holdings held by specified institution symbol.

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

heldByInstitutionID

Limits response to holdings held by specified institution registryId.

TYPE: Optional[Union[str, int, List[str], List[int]]] DEFAULT: None

inLanguage

Limits response to the single specified language

EXAMPLE: 'fre'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

inCatalogLanguage

Limits response to specified cataloging language.

EXAMPLE: 'eng'

TYPE: Optional[str] DEFAULT: 'eng'

materialType

Limits response to specified material type.

EXAMPLES: 'bks', 'vis'

TYPE: Optional[str] DEFAULT: None

catalogSource

Limits response to single OCLC symbol as the cataloging source.

EXAMPLE: 'DLC'

TYPE: Optional[str] DEFAULT: None

itemType

Limits response to specified item type.

EXAMPLE: 'book', 'vis'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

itemSubType

Limits response to specified item subtype.

EXAMPLES: 'book-digital', 'audiobook-cd'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

retentionCommitments

Limits response to bibliographic records with retention commitment.

OPTIONS: True or False

TYPE: bool DEFAULT: False

spProgram

Limits response to bibliographic records associated with particular shared print program.

TYPE: Optional[str] DEFAULT: None

genre

Genre to limit response to (ge index).

TYPE: Optional[str] DEFAULT: None

topic

Topic to limit response to (s0 index).

TYPE: Optional[str] DEFAULT: None

subtopic

Subtopic to limit response to (s1 index).

TYPE: Optional[str] DEFAULT: None

audience

Audience to limit response to.

OPTIONS: 'juv' or 'nonJuv'

TYPE: Optional[str] DEFAULT: None

content

Content to limit response to.

OPTIONS: 'fic', 'nonFic', 'bio'

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

openAccess

Limits response to just open access content.

TYPE: Optional[bool] DEFAULT: None

peerReviewed

Limits response to just peer reviewed content.

TYPE: Optional[bool] DEFAULT: None

facets

List of facets to limit responses.

TYPE: Optional[Union[str, List[str]]] DEFAULT: None

groupRelatedEditions

Whether or not use FRBR grouping.

OPTIONS: True or False

TYPE: bool DEFAULT: False

groupVariantRecords

Whether or not to group variant records.

OPTIONS: True or False

TYPE: bool DEFAULT: False

preferredLanguage

Language user would prefer metadata description in. Does not limit responses. To limit responses use inCataloglanguage facet.

TYPE: str DEFAULT: 'eng'

showHoldingsIndicators

Whether or not to show holdings indicators in response. OPTIONS: True or False

TYPE: bool DEFAULT: False

lat

Latitude

EXAMPLE: 37.502508

TYPE: Optional[float] DEFAULT: None

lon

Longitude

EXAMPLE: -122.22702

TYPE: Optional[float] DEFAULT: None

distance

Limits response to holdings held by institutions within specified distance from latitude and longitude.

TYPE: Optional[int] DEFAULT: None

unit

Unit of distance from latitude and longitude.

OPTIONS: 'M' (miles) or 'K' (kilometers)

TYPE: str DEFAULT: 'M'

orderBy

Results sort key.

OPTIONS:

  • 'recency'
  • 'bestMatch'
  • 'creator'
  • 'library'
  • 'publicationDateAsc'
  • 'publicationDateDesc'
  • 'mostWidelyHeld'
  • 'title'

TYPE: str DEFAULT: 'bestMatch'

offset

Start position of bibliographic records to return.

TYPE: int DEFAULT: 1

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
def brief_bibs_search(
    self,
    q: str,
    deweyNumber: Optional[Union[str, List[str]]] = None,
    datePublished: Optional[Union[str, List[str]]] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[Union[str, List[str]]] = None,
    heldByInstitutionID: Optional[Union[str, int, List[str], List[int]]] = None,
    inLanguage: Optional[Union[str, List[str]]] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[Union[str, List[str]]] = None,
    itemSubType: Optional[Union[str, List[str]]] = None,
    retentionCommitments: bool = False,
    spProgram: Optional[str] = None,
    genre: Optional[str] = None,
    topic: Optional[str] = None,
    subtopic: Optional[str] = None,
    audience: Optional[str] = None,
    content: Optional[Union[str, List[str]]] = None,
    openAccess: Optional[bool] = None,
    peerReviewed: Optional[bool] = None,
    facets: Optional[Union[str, List[str]]] = None,
    groupRelatedEditions: bool = False,
    groupVariantRecords: bool = False,
    preferredLanguage: str = "eng",
    showHoldingsIndicators: bool = False,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    orderBy: str = "bestMatch",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Search for brief bibliographic resources using WorldCat query syntax.
    See OCLC
    [Bibliographic Records Index Documentation](https://help.oclc.org/Librarian_Toolbox/Searching_WorldCat_Indexes/Bibliographic_records/Bibliographic_record_indexes)
    for more information on available indexes. Request may contain
    only one of: `heldByInstitutionID`, `heldByGroup`, `heldBySymbol`, or
    combination of `lat` and `lon`.

    Uses /search/brief-bibs endpoint.

    Args:
        q:
            Query in the form of a keyword search or fielded search.

            **EXAMPLES:**

            - `ti:Zendegi`
            - `ti:"Czarne oceany"`
            - `bn:9781680502404`
            - `kw:python databases`
            - `ti:Zendegi AND au:greg egan`
            - `(au:Okken OR au:Myers) AND su:python`

        deweyNumber:
            Limits the response to the specified dewey classification number(s).
            For multiple values repeat the parameter.

            **EXAMPLE:** `'794'`
        datePublished:
            Restricts the response to one or more dates, or to a range.

            **EXAMPLES:** `'2000'`, `'2000-2005'`, `'2000,2005'`
        heldByGroup:
            Limits response to holdings held by group symbol.
        heldBySymbol:
            Limits response to holdings held by specified institution symbol.
        heldByInstitutionID:
            Limits response to holdings held by specified institution registryId.
        inLanguage:
            Limits response to the single specified language

            **EXAMPLE:** `'fre'`
        inCatalogLanguage:
            Limits response to specified cataloging language.

            **EXAMPLE:** `'eng'`
        materialType:
            Limits response to specified material type.

            **EXAMPLES:** `'bks'`, `'vis'`
        catalogSource:
            Limits response to single OCLC symbol as the cataloging source.

            **EXAMPLE:** `'DLC'`
        itemType:
            Limits response to specified item type.

            **EXAMPLE:** `'book'`, `'vis'`
        itemSubType:
            Limits response to specified item subtype.

            **EXAMPLES:** `'book-digital'`, `'audiobook-cd'`
        retentionCommitments:
            Limits response to bibliographic records with retention commitment.

            **OPTIONS:** `True` or `False`
        spProgram:
            Limits response to bibliographic records associated with particular
            shared print program.
        genre:
            Genre to limit response to (ge index).
        topic:
            Topic to limit response to (s0 index).
        subtopic:
            Subtopic to limit response to (s1 index).
        audience:
            Audience to limit response to.

            **OPTIONS:** `'juv'` or `'nonJuv'`
        content:
            Content to limit response to.

            **OPTIONS:** `'fic'`, `'nonFic'`, `'bio'`
        openAccess:
            Limits response to just open access content.
        peerReviewed:
            Limits response to just peer reviewed content.
        facets:
            List of facets to limit responses.
        groupRelatedEditions:
            Whether or not use FRBR grouping.

            **OPTIONS:** `True` or `False`
        groupVariantRecords:
            Whether or not to group variant records.

            **OPTIONS:** `True` or `False`
        preferredLanguage:
            Language user would prefer metadata description in. Does not limit
            responses. To limit responses use `inCataloglanguage` facet.
        showHoldingsIndicators:
            Whether or not to show holdings indicators in response.
            **OPTIONS:** `True` or `False`
        lat:
            Latitude

            **EXAMPLE:** `37.502508`
        lon:
            Longitude

            **EXAMPLE:** `-122.22702`
        distance:
            Limits response to holdings held by institutions within specified
            distance from latitude and longitude.
        unit:
            Unit of distance from latitude and longitude.

            **OPTIONS:** `'M'` (miles) or `'K'` (kilometers)
        orderBy:
            Results sort key.

            **OPTIONS:**

            - `'recency'`
            - `'bestMatch'`
            - `'creator'`
            - `'library'`
            - `'publicationDateAsc'`
            - `'publicationDateDesc'`
            - `'mostWidelyHeld'`
            - `'title'`
        offset:
            Start position of bibliographic records to return.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """  # noqa: E501
    url = self._url_search_brief_bibs()
    header = {"Accept": "application/json"}
    payload = {
        "q": q,
        "deweyNumber": deweyNumber,
        "datePublished": datePublished,
        "heldByGroup": heldByGroup,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "inLanguage": inLanguage,
        "inCatalogLanguage": inCatalogLanguage,
        "materialType": materialType,
        "catalogSource": catalogSource,
        "itemType": itemType,
        "itemSubType": itemSubType,
        "retentionCommitments": retentionCommitments,
        "spProgram": spProgram,
        "genre": genre,
        "topic": topic,
        "subtopic": subtopic,
        "audience": audience,
        "content": content,
        "openAccess": openAccess,
        "peerReviewed": peerReviewed,
        "facets": facets,
        "groupRelatedEditions": groupRelatedEditions,
        "groupVariantRecords": groupVariantRecords,
        "preferredLanguage": preferredLanguage,
        "showHoldingsIndicators": showHoldingsIndicators,
        "lat": lat,
        "lon": lon,
        "distance": distance,
        "unit": unit,
        "orderBy": orderBy,
        "offset": offset,
        "limit": limit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_get_codes 

holdings_get_codes(
    hooks: Optional[Dict[str, Callable]] = None
) -> Optional[Response]

Retrieve the all holding codes for the authenticated institution.

Uses /manage/institution/holding-codes endpoint.

PARAMETER DESCRIPTION
hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
def holdings_get_codes(
    self,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Retrieve the all holding codes for the authenticated institution.

    Uses /manage/institution/holding-codes endpoint.

    Args:
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_ih_codes()
    header = {"Accept": "application/json"}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_get_current 

holdings_get_current(
    oclcNumbers: Union[int, str, List[Union[str, int]]],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Retrieves WorldCat holdings status of a record with provided OCLC number. The service automatically recognizes the user's institution based on the issued access token.

Uses /manage/institution/holdings/current endpoint.

PARAMETER DESCRIPTION
oclcNumbers

Integer, string or list containing one or more OCLC numbers to be checked. Numbers can be integers or strings with or without OCLC Number prefix. If str, the numbers must be separated by a comma. If int, only one number may be passed as an arg.

TYPE: Union[int, str, List[Union[str, int]]]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
RAISES DESCRIPTION
ValueError

If more than 10 items passed to oclcNumbers arg.
Source code in bookops_worldcat\metadata_api.py 
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
def holdings_get_current(
    self,
    oclcNumbers: Union[int, str, List[Union[str, int]]],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Retrieves WorldCat holdings status of a record with provided OCLC number.
    The service automatically recognizes the user's institution based on the
    issued access token.

    Uses /manage/institution/holdings/current endpoint.

    Args:
        oclcNumbers:
            Integer, string or list containing one or more OCLC numbers to be
            checked. Numbers can be integers or strings with or without OCLC
            Number prefix. If str, the numbers must be separated by a comma.
            If int, only one number may be passed as an arg.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance

    Raises:
        ValueError: If more than 10 items passed to `oclcNumbers` arg.
    """
    vetted_numbers = verify_oclc_numbers(oclcNumbers)

    # check that no more than 10 oclc numbers were passed
    if len(vetted_numbers) > 10:
        raise ValueError("Too many OCLC Numbers passed to 'oclcNumbers' argument.")

    url = self._url_manage_ih_current()
    header = {"Accept": "application/json"}

    payload = {"oclcNumbers": vetted_numbers}

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_set 

holdings_set(
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Sets institution's WorldCat holdings on an individual record.

Uses /manage/institions/holdings/{oclcNumber}/set endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
def holdings_set(
    self,
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Sets institution's WorldCat holdings on an individual record.

    Uses /manage/institions/holdings/{oclcNumber}/set endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_manage_ih_set(oclcNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("POST", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_set_with_bib 

holdings_set_with_bib(
    record: str,
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a MARC record in MARCXML or MARC21, set institution holdings on the record. MARC record must contain OCLC number in 001 or 035 subfield a. Only one MARC record is allowed in the request body.

Uses /manage/institution/holdings/set endpoint.

PARAMETER DESCRIPTION
record

MARC record on which to set holdings.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
def holdings_set_with_bib(
    self,
    record: str,
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a MARC record in MARCXML or MARC21, set institution holdings on the
    record. MARC record must contain OCLC number in 001 or 035 subfield a.
    Only one MARC record is allowed in the request body.

    Uses /manage/institution/holdings/set endpoint.

    Args:
        record:
            MARC record on which to set holdings.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_ih_set_with_bib()
    header = {
        "Accept": "application/json",
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_unset 

holdings_unset(
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Unsets institution's WorldCat holdings on an individual record.

Uses /manage/institions/holdings/{oclcNumber}/unset endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
def holdings_unset(
    self,
    oclcNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Unsets institution's WorldCat holdings on an individual record.

    Uses /manage/institions/holdings/{oclcNumber}/unset endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_manage_ih_unset(oclcNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("POST", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

holdings_unset_with_bib 

holdings_unset_with_bib(
    record: str,
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a MARC record in MARCXML or MARC21, unset institution holdings on the record. MARC record must contain OCLC number in 001 or 035 subfield a. Only one MARC record is allowed in the request body.

Uses /manage/institution/holdings/unset endpoint.

PARAMETER DESCRIPTION
record

MARC record on which to unset holdings.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
def holdings_unset_with_bib(
    self,
    record: str,
    recordFormat: str,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a MARC record in MARCXML or MARC21, unset institution holdings on the
    record. MARC record must contain OCLC number in 001 or 035 subfield a.
    Only one MARC record is allowed in the request body.

    Uses /manage/institution/holdings/unset endpoint.

    Args:
        record:
            MARC record on which to unset holdings.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_ih_unset_with_bib()
    header = {
        "Accept": "application/json",
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)
    return query.response

lbd_create 

lbd_create(
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a local bibliographic data record, create it in WorldCat.

Uses /manage/lbds endpoint.

PARAMETER DESCRIPTION
record

MARC record to be created.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
def lbd_create(
    self,
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a local bibliographic data record, create it in WorldCat.

    Uses /manage/lbds endpoint.

    Args:
        record:
            MARC record to be created.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lbd_create()
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lbd_delete 

lbd_delete(
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a control number, delete the associated Local Bibliographic Data record.

Uses /manage/lbds/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Bibliographic Data record. Can be an integer or string.

TYPE: Union[int, str]

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
def lbd_delete(
    self,
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a control number, delete the associated Local Bibliographic Data record.

    Uses /manage/lbds/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Bibliographic Data record.
            Can be an integer or string.
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lbd(controlNumber)
    header = {"Accept": responseFormat}

    # prep request
    req = Request("DELETE", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lbd_get 

lbd_get(
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a Control Number, retrieve a Local Bibliographic Data record.

Uses /manage/lbds/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Bibliographic Data record. Can be an integer or string.

TYPE: Union[int, str]

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
def lbd_get(
    self,
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a Control Number, retrieve a Local Bibliographic Data record.

    Uses /manage/lbds/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Bibliographic Data record.
            Can be an integer or string.
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lbd(controlNumber)
    header = {"Accept": responseFormat}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lbd_replace 

lbd_replace(
    controlNumber: Union[int, str],
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a Control Number, find the associated Local Bibliographic Data Record and replace it. If the Control Number is not found in WorldCat, then the provided Local Bibliographic Data Record will be created.

Uses /manage/lbds/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Bibliographic Data record. Can be an integer or string.

TYPE: Union[int, str]

record

MARC record to replace existing Local Bibliographic Data record.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
def lbd_replace(
    self,
    controlNumber: Union[int, str],
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a Control Number, find the associated Local Bibliographic Data
    Record and replace it. If the Control Number is not found in
    WorldCat, then the provided Local Bibliographic Data Record will be created.

    Uses /manage/lbds/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Bibliographic Data record.
            Can be an integer or string.
        record:
            MARC record to replace existing Local Bibliographic Data record.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lbd(controlNumber)
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("PUT", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lhr_create 

lhr_create(
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a local holdings record, create it in WorldCat

Uses /manage/lhrs endpoint.

PARAMETER DESCRIPTION
record

MARC holdings record to be created.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
def lhr_create(
    self,
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a local holdings record, create it in WorldCat

    Uses /manage/lhrs endpoint.

    Args:
        record:
            MARC holdings record to be created.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lhr_create()
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("POST", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lhr_delete 

lhr_delete(
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a control number, delete a Local Holdings record.

Uses /manage/lhrs/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Holdings record. Can be an integer or string.

TYPE: Union[int, str]

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
def lhr_delete(
    self,
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a control number, delete a Local Holdings record.

    Uses /manage/lhrs/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Holdings record.
            Can be an integer or string.
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lhr(controlNumber)
    header = {"Accept": responseFormat}

    # prep request
    req = Request("DELETE", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lhr_get 

lhr_get(
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Send a GET request for a local holdings record

Uses /manage/lhrs/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Holdings record. Can be an integer or string.

TYPE: Union[int, str]

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
def lhr_get(
    self,
    controlNumber: Union[int, str],
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Send a GET request for a local holdings record

    Uses /manage/lhrs/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Holdings record.
            Can be an integer or string.
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lhr(controlNumber)
    header = {"Accept": responseFormat}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

lhr_replace 

lhr_replace(
    controlNumber: Union[int, str],
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a Control Number, find the associated Local Holdings Record and replace it. If the Control Number is not found in WorldCat, then the provided Local Holdings Record will be created.

Uses /manage/lhrs/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Holdings record. Can be an integer or string.

TYPE: Union[int, str]

record

MARC holdings record to replace existing local holdings record.

TYPE: str

recordFormat

Format of MARC record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str

responseFormat

Format of returned record.

OPTIONS: 'application/marcxml+xml' or 'application/marc'

TYPE: str DEFAULT: 'application/marcxml+xml'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
def lhr_replace(
    self,
    controlNumber: Union[int, str],
    record: str,
    recordFormat: str,
    responseFormat: str = "application/marcxml+xml",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a Control Number, find the associated Local Holdings
    Record and replace it. If the Control Number is not found in
    WorldCat, then the provided Local Holdings Record will be created.

    Uses /manage/lhrs/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Holdings record.
            Can be an integer or string.
        record:
            MARC holdings record to replace existing local holdings record.
        recordFormat:
            Format of MARC record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        responseFormat:
            Format of returned record.

            **OPTIONS:** `'application/marcxml+xml'` or `'application/marc'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_manage_lhr(controlNumber)
    header = {
        "Accept": responseFormat,
        "content-type": recordFormat,
    }

    # prep request
    req = Request("PUT", url, data=record, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_bibs_get 

local_bibs_get(
    controlNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Retrieve LBD Resource.

Uses /search/my-local-bib-data/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Bibliographic Data record. Can be an integer or string.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
def local_bibs_get(
    self,
    controlNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Retrieve LBD Resource.

    Uses /search/my-local-bib-data/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Bibliographic Data record.
            Can be an integer or string.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_search_lbd_control_number(controlNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_bibs_search(
    q: str,
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Search LBD Resources using WorldCat query syntax. See OCLC Local Bibliographic Data Record Index Documentation for more information on available indexes.

Uses /search/my-local-bib-data endpoint.

PARAMETER DESCRIPTION
q

Query in the form of a keyword search or fielded search.

EXAMPLES:

  • ti:Zendegi
  • ti:"Czarne oceany"
  • bn:9781680502404
  • kw:python databases
  • ti:Zendegi AND au:greg egan
  • (au:Okken OR au:Myers) AND su:python

TYPE: str

offset

Start position of bibliographic records to return.

TYPE: int DEFAULT: 1

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
def local_bibs_search(
    self,
    q: str,
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Search LBD Resources using WorldCat query syntax. See OCLC
    [Local Bibliographic Data Record Index](https://help.oclc.org/Librarian_Toolbox/Searching_WorldCat_Indexes/Local_bibliographic_data_records/Local_bibliographic_data_record_indexes_A-Z)
    Documentation for more information on available indexes.

    Uses /search/my-local-bib-data endpoint.

    Args:
        q:
            Query in the form of a keyword search or fielded search.

            **EXAMPLES:**

            - `ti:Zendegi`
            - `ti:"Czarne oceany"`
            - `bn:9781680502404`
            - `kw:python databases`
            - `ti:Zendegi AND au:greg egan`
            - `(au:Okken OR au:Myers) AND su:python`
        offset:
            Start position of bibliographic records to return.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """  # noqa: E501
    url = self._url_search_lbd()
    header = {"Accept": "application/json"}
    payload = {"q": q, "offset": offset, "limit": limit}

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_holdings_browse 

local_holdings_browse(
    holdingLocation: str,
    shelvingLocation: str,
    callNumber: str,
    oclcNumber: Optional[Union[int, str]] = None,
    browsePosition: int = 0,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Browse local holdings.

Uses /browse/my-holdings endpoint.

PARAMETER DESCRIPTION
holdingLocation

Holding location for item.

TYPE: str

shelvingLocation

Shelving location for item.

TYPE: str

callNumber

Call number for item.

TYPE: str

oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Optional[Union[int, str]] DEFAULT: None

browsePosition

Position within browse list where the matching record should be.

TYPE: int DEFAULT: 0

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
def local_holdings_browse(
    self,
    holdingLocation: str,
    shelvingLocation: str,
    callNumber: str,
    oclcNumber: Optional[Union[int, str]] = None,
    browsePosition: int = 0,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Browse local holdings.

    Uses /browse/my-holdings endpoint.

    Args:
        holdingLocation:
            Holding location for item.
        shelvingLocation:
            Shelving location for item.
        callNumber:
            Call number for item.
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        browsePosition:
            Position within browse list where the matching record should be.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    if oclcNumber is not None:
        oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_browse_lhr()
    header = {"Accept": "application/json"}
    payload = {
        "callNumber": callNumber,
        "oclcNumber": oclcNumber,
        "holdingLocation": holdingLocation,
        "shelvingLocation": shelvingLocation,
        "browsePosition": browsePosition,
        "limit": limit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_holdings_get 

local_holdings_get(
    controlNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Retrieve LHR Resource.

Uses /search/my-holdings/{controlNumber} endpoint.

PARAMETER DESCRIPTION
controlNumber

Control number associated with Local Holdings record. Can be an integer or string.

TYPE: Union[int, str]

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
def local_holdings_get(
    self,
    controlNumber: Union[int, str],
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Retrieve LHR Resource.

    Uses /search/my-holdings/{controlNumber} endpoint.

    Args:
        controlNumber:
            Control number associated with Local Holdings record.
            Can be an integer or string.
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    url = self._url_search_lhr_control_number(controlNumber)
    header = {"Accept": "application/json"}

    # prep request
    req = Request("GET", url, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_holdings_search(
    oclcNumber: Optional[Union[int, str]] = None,
    barcode: Optional[str] = None,
    orderBy: str = "oclcSymbol",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Search LHR Resources. Query must contain, at minimum, either an oclcNumber or barcode.

Uses /search/my-holdings endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Optional[Union[int, str]] DEFAULT: None

barcode

Barcode as a string.

TYPE: Optional[str] DEFAULT: None

orderBy

Results sort key.

OPTIONS: 'commitmentExpirationDate', 'location', 'oclcSymbol'

TYPE: str DEFAULT: 'oclcSymbol'

offset

Start position of bibliographic records to return.

TYPE: int DEFAULT: 1

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
def local_holdings_search(
    self,
    oclcNumber: Optional[Union[int, str]] = None,
    barcode: Optional[str] = None,
    orderBy: str = "oclcSymbol",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Search LHR Resources. Query must contain, at minimum, either an
    `oclcNumber` or `barcode`.

    Uses /search/my-holdings endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        barcode:
            Barcode as a string.
        orderBy:
            Results sort key.

            **OPTIONS:** `'commitmentExpirationDate'`, `'location'`, `'oclcSymbol'`
        offset:
            Start position of bibliographic records to return.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    if oclcNumber is not None:
        oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_lhr()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "barcode": barcode,
        "orderBy": orderBy,
        "offset": offset,
        "limit": limit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

local_holdings_search_shared_print 

local_holdings_search_shared_print(
    oclcNumber: Optional[Union[int, str]] = None,
    barcode: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    spProgram: Optional[List[str]] = None,
    orderBy: str = "oclcSymbol",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Search for shared print LHR Resources. Query must contain, at minimum, either an oclcNumber or barcode and a value for either heldBySymbol, heldByInstitutionID or spProgram.

Uses /search/retained-holdings endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Optional[Union[int, str]] DEFAULT: None

barcode

Barcode as a string.

TYPE: Optional[str] DEFAULT: None

heldBySymbol

Restricts to holdings with specified institution symbol.

TYPE: Optional[List[str]] DEFAULT: None

heldByInstitutionID

Restrict to specified institution registryId.

TYPE: Optional[List[int]] DEFAULT: None

spProgram

Limits response to bibliographic records associated with particular shared print program.

TYPE: Optional[List[str]] DEFAULT: None

orderBy

Results sort key.

OPTIONS: 'commitmentExpirationDate', 'location', 'oclcSymbol'

TYPE: str DEFAULT: 'oclcSymbol'

offset

Start position of bibliographic records to return.

TYPE: int DEFAULT: 1

limit

Maximum number of records to return.

MAXIMUM: 50

TYPE: int DEFAULT: 10

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
def local_holdings_search_shared_print(
    self,
    oclcNumber: Optional[Union[int, str]] = None,
    barcode: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    spProgram: Optional[List[str]] = None,
    orderBy: str = "oclcSymbol",
    offset: int = 1,
    limit: int = 10,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Search for shared print LHR Resources. Query must contain, at minimum,
    either an `oclcNumber` or `barcode` and a value for either
    `heldBySymbol`, `heldByInstitutionID` or `spProgram`.

    Uses /search/retained-holdings endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        barcode:
            Barcode as a string.
        heldBySymbol:
            Restricts to holdings with specified institution symbol.
        heldByInstitutionID:
            Restrict to specified institution registryId.
        spProgram:
            Limits response to bibliographic records associated with
            particular shared print program.
        orderBy:
            Results sort key.

            **OPTIONS:** `'commitmentExpirationDate'`, `'location'`, `'oclcSymbol'`
        offset:
            Start position of bibliographic records to return.
        limit:
            Maximum number of records to return.

            **MAXIMUM:** `50`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    if oclcNumber is not None:
        oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_lhr_shared_print()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "barcode": barcode,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "spProgram": spProgram,
        "orderBy": orderBy,
        "offset": offset,
        "limit": limit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

shared_print_holdings_search(
    oclcNumber: Optional[Union[int, str]] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldInState: Optional[str] = None,
    itemType: Optional[List[str]] = None,
    itemSubType: Optional[List[str]] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Finds member shared print holdings for specified item. Query must contain, at minimum, either an oclcNumber, isbn, or issn.

Uses /search/bibs-retained-holdings endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Optional[Union[int, str]] DEFAULT: None

isbn

ISBN without any dashes.

EXAMPLE: '978149191646x'

TYPE: Optional[str] DEFAULT: None

issn

ISSN, hyphenated.

EXAMPLE: '0099-1234'

TYPE: Optional[str] DEFAULT: None

heldByGroup

Restricts to holdings held by group symbol.

TYPE: Optional[str] DEFAULT: None

heldInState

Restricts to holdings held by institutions in requested state.

EXAMPLE: 'US-NY'

TYPE: Optional[str] DEFAULT: None

itemType

Limits response to specified item type.

EXAMPLES: 'book', 'vis'

TYPE: Optional[List[str]] DEFAULT: None

itemSubType

Limits response to specified item sub type

EXAMPLES: 'book-digital', 'audiobook-cd'

TYPE: Optional[List[str]] DEFAULT: None

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
def shared_print_holdings_search(
    self,
    oclcNumber: Optional[Union[int, str]] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldInState: Optional[str] = None,
    itemType: Optional[List[str]] = None,
    itemSubType: Optional[List[str]] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Finds member shared print holdings for specified item. Query must
    contain, at minimum, either an `oclcNumber`, `isbn`, or `issn`.

    Uses /search/bibs-retained-holdings endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        isbn:
            ISBN without any dashes.

            **EXAMPLE:** `'978149191646x'`
        issn:
            ISSN, hyphenated.

            **EXAMPLE:** `'0099-1234'`
        heldByGroup:
            Restricts to holdings held by group symbol.
        heldInState:
            Restricts to holdings held by institutions in requested state.

            **EXAMPLE:** `'US-NY'`
        itemType:
            Limits response to specified item type.

            **EXAMPLES:** `'book'`, `'vis'`
        itemSubType:
            Limits response to specified item sub type

            **EXAMPLES:** `'book-digital'`, `'audiobook-cd'`
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    if oclcNumber is not None:
        oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_shared_print_holdings()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "isbn": isbn,
        "issn": issn,
        "heldByGroup": heldByGroup,
        "heldInState": heldInState,
        "itemType": itemType,
        "itemSubType": itemSubType,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

summary_holdings_get 

summary_holdings_get(
    oclcNumber: Union[int, str],
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    holdingsFilterFormat: Optional[List[str]] = None,
    heldInCountry: Optional[str] = None,
    heldInState: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    heldByLibraryType: Optional[List[str]] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given an OCLC number, get summary of holdings. Query may contain only one of: heldByInstitutionId, heldByGroup, heldBySymbol, heldInCountry, heldInState or combination of lat, lon and distance. If using lat/lon arguments, query must contain a valid distance argument.

Uses /search/summary-holdings endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Union[int, str]

holdingsAllEditions

Get holdings for all editions.

OPTIONS: True or False

TYPE: Optional[bool] DEFAULT: None

holdingsAllVariantRecords

Get holdings for specific edition across variant records.

OPTIONS: True or False

TYPE: Optional[bool] DEFAULT: None

holdingsFilterFormat

Get holdings for specific itemSubType.

EXAMPLE: 'book-digital'

TYPE: Optional[List[str]] DEFAULT: None

heldInCountry

Restricts to holdings held by institutions in requested country.

TYPE: Optional[str] DEFAULT: None

heldInState

Restricts to holdings held by institutions in requested state.

EXAMPLE: 'US-NY'

TYPE: Optional[str] DEFAULT: None

heldByGroup

Restricts to holdings held by group symbol.

TYPE: Optional[str] DEFAULT: None

heldBySymbol

Limits to holdings held by institutions indicated by institution symbol.

TYPE: Optional[List[str]] DEFAULT: None

heldByInstitutionID

Limits to holdings held by institutions indicated by institution registryID.

TYPE: Optional[List[int]] DEFAULT: None

heldByLibraryType

Limits to holdings held by library type.

OPTIONS: 'PUBLIC', 'ALL'

TYPE: Optional[List[str]] DEFAULT: None

lat

Latitude

EXAMPLE: 37.502508

TYPE: Optional[float] DEFAULT: None

lon

Longitude

EXAMPLE: -122.22702

TYPE: Optional[float] DEFAULT: None

distance

Limits results to holdings held by institutions within specified distance from latitude and longitude.

TYPE: Optional[int] DEFAULT: None

unit

Unit of distance from latitude and longitude.

OPTIONS: 'M' (miles) or 'K' (kilometers).

TYPE: str DEFAULT: 'M'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
def summary_holdings_get(
    self,
    oclcNumber: Union[int, str],
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    holdingsFilterFormat: Optional[List[str]] = None,
    heldInCountry: Optional[str] = None,
    heldInState: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    heldByLibraryType: Optional[List[str]] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given an OCLC number, get summary of holdings. Query may contain
    only one of: `heldByInstitutionId`, `heldByGroup`, `heldBySymbol`,
    `heldInCountry`, `heldInState` or combination of `lat`, `lon` and
    `distance`. If using lat/lon arguments, query must contain a valid
    distance argument.

    Uses /search/summary-holdings endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        holdingsAllEditions:
            Get holdings for all editions.

            **OPTIONS:** `True` or `False`
        holdingsAllVariantRecords:
            Get holdings for specific edition across variant records.

            **OPTIONS:** `True` or `False`
        holdingsFilterFormat:
            Get holdings for specific itemSubType.

            **EXAMPLE:** `'book-digital'`
        heldInCountry:
            Restricts to holdings held by institutions in requested country.
        heldInState:
            Restricts to holdings held by institutions in requested state.

            **EXAMPLE:** `'US-NY'`
        heldByGroup:
            Restricts to holdings held by group symbol.
        heldBySymbol:
            Limits to holdings held by institutions indicated by
            institution symbol.
        heldByInstitutionID:
            Limits to holdings held by institutions indicated by institution
            registryID.
        heldByLibraryType:
            Limits to holdings held by library type.

            **OPTIONS:** `'PUBLIC'`, `'ALL'`
        lat:
            Latitude

            **EXAMPLE:** `37.502508`
        lon:
            Longitude

            **EXAMPLE:** `-122.22702`
        distance:
            Limits results to holdings held by institutions within specified
            distance from latitude and longitude.
        unit:
            Unit of distance from latitude and longitude.

            **OPTIONS:** `'M'` (miles) or `'K'` (kilometers).
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_general_holdings_summary()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "holdingsAllEditions": holdingsAllEditions,
        "holdingsAllVariantRecords": holdingsAllVariantRecords,
        "holdingsFilterFormat": holdingsFilterFormat,
        "heldInCountry": heldInCountry,
        "heldInState": heldInState,
        "heldByGroup": heldByGroup,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "heldByLibraryType": heldByLibraryType,
        "lat": lat,
        "lon": lon,
        "distance": distance,
        "unit": unit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response

summary_holdings_search(
    oclcNumber: Optional[Union[int, str]] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    preferredLanguage: str = "eng",
    holdingsFilterFormat: Optional[List[str]] = None,
    heldInCountry: Optional[str] = None,
    heldInState: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    heldByLibraryType: Optional[List[str]] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]

Given a known item, get summary of holdings and brief bib record. Query must contain, at minimum, either an OCLC Number, ISBN, or ISSN. Query may contain only one of: heldByInstitutionId, heldByGroup, heldBySymbol, heldInCountry, heldInState or combination of lat, lon and distance. If using lat/lon arguments, query must contain a valid distance argument.

Uses /search/bibs-summary-holdings endpoint.

PARAMETER DESCRIPTION
oclcNumber

OCLC bibliographic record number. Can be an integer or string with or without OCLC Number prefix.

TYPE: Optional[Union[int, str]] DEFAULT: None

isbn

ISBN without any dashes.

EXAMPLE: '978149191646x'

TYPE: Optional[str] DEFAULT: None

issn

ISSN, hyphenated.

EXAMPLE: '0099-1234'

TYPE: Optional[str] DEFAULT: None

holdingsAllEditions

Get holdings for all editions.

OPTIONS: True or False

TYPE: Optional[bool] DEFAULT: None

holdingsAllVariantRecords

Get holdings for specific edition across variant records.

OPTIONS: True or False

TYPE: Optional[bool] DEFAULT: None

preferredLanguage

Language user would prefer metadata description in. Does not limit responses. To limit responses use inCataloglanguage facet.

TYPE: str DEFAULT: 'eng'

holdingsFilterFormat

Get holdings for specific itemSubType.

EXAMPLE: 'book-digital'

TYPE: Optional[List[str]] DEFAULT: None

heldInCountry

Restricts to holdings held by institutions in requested country.

TYPE: Optional[str] DEFAULT: None

heldInState

Restricts to holdings held by institutions in requested state.

EXAMPLE: 'US-NY'

TYPE: Optional[str] DEFAULT: None

heldByGroup

Restricts to holdings held by group symbol.

TYPE: Optional[str] DEFAULT: None

heldBySymbol

Limits to holdings held by institutions indicated by institution symbol.

TYPE: Optional[List[str]] DEFAULT: None

heldByInstitutionID

Limits to holdings held by institutions indicated by institution registryID.

TYPE: Optional[List[int]] DEFAULT: None

heldByLibraryType

Limits to holdings held by library type.

OPTIONS: 'PUBLIC', 'ALL'

TYPE: Optional[List[str]] DEFAULT: None

lat

Latitude

EXAMPLE: 37.502508

TYPE: Optional[float] DEFAULT: None

lon

Longitude

EXAMPLE: -122.22702

TYPE: Optional[float] DEFAULT: None

distance

Limits results to holdings held by institutions within specified distance from latitude and longitude.

TYPE: Optional[int] DEFAULT: None

unit

Unit of distance from latitude and longitude.

OPTIONS: 'M' (miles) or 'K' (kilometers).

TYPE: str DEFAULT: 'M'

hooks

Requests library hook system that can be used for signal event handling. For more information see the Requests docs

TYPE: Optional[Dict[str, Callable]] DEFAULT: None

RETURNS DESCRIPTION
Optional[Response]

requests.Response instance
Source code in bookops_worldcat\metadata_api.py 
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
def summary_holdings_search(
    self,
    oclcNumber: Optional[Union[int, str]] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    preferredLanguage: str = "eng",
    holdingsFilterFormat: Optional[List[str]] = None,
    heldInCountry: Optional[str] = None,
    heldInState: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[List[str]] = None,
    heldByInstitutionID: Optional[List[int]] = None,
    heldByLibraryType: Optional[List[str]] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: str = "M",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Optional[Response]:
    """
    Given a known item, get summary of holdings and brief bib record. Query must
    contain, at minimum, either an OCLC Number, ISBN, or ISSN. Query may contain
    only one of: `heldByInstitutionId`, `heldByGroup`, `heldBySymbol`,
    `heldInCountry`, `heldInState` or combination of `lat`, `lon` and
    `distance`. If using lat/lon arguments, query must contain a valid
    distance argument.

    Uses /search/bibs-summary-holdings endpoint.

    Args:
        oclcNumber:
            OCLC bibliographic record number. Can be an integer or string
            with or without OCLC Number prefix.
        isbn:
            ISBN without any dashes.

            **EXAMPLE:** `'978149191646x'`
        issn:
            ISSN, hyphenated.

            **EXAMPLE:** `'0099-1234'`
        holdingsAllEditions:
            Get holdings for all editions.

            **OPTIONS:** `True` or `False`
        holdingsAllVariantRecords:
            Get holdings for specific edition across variant records.

            **OPTIONS:** `True` or `False`
        preferredLanguage:
            Language user would prefer metadata description in. Does not limit
            responses. To limit responses use `inCataloglanguage` facet.
        holdingsFilterFormat:
            Get holdings for specific itemSubType.

            **EXAMPLE:** `'book-digital'`
        heldInCountry:
            Restricts to holdings held by institutions in requested country.
        heldInState:
            Restricts to holdings held by institutions in requested state.

            **EXAMPLE:** `'US-NY'`
        heldByGroup:
            Restricts to holdings held by group symbol.
        heldBySymbol:
            Limits to holdings held by institutions indicated by
            institution symbol.
        heldByInstitutionID:
            Limits to holdings held by institutions indicated by institution
            registryID.
        heldByLibraryType:
            Limits to holdings held by library type.

            **OPTIONS:** `'PUBLIC'`, `'ALL'`
        lat:
            Latitude

            **EXAMPLE:** `37.502508`
        lon:
            Longitude

            **EXAMPLE:** `-122.22702`
        distance:
            Limits results to holdings held by institutions within specified
            distance from latitude and longitude.
        unit:
            Unit of distance from latitude and longitude.

            **OPTIONS:** `'M'` (miles) or `'K'` (kilometers).
        hooks:
            Requests library hook system that can be used for signal event
            handling. For more information see the [Requests docs](https://requests.
            readthedocs.io/en/master/user/advanced/#event-hooks)

    Returns:
        `requests.Response` instance
    """
    if oclcNumber is not None:
        oclcNumber = verify_oclc_number(oclcNumber)

    url = self._url_search_general_holdings()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "isbn": isbn,
        "issn": issn,
        "holdingsAllEditions": holdingsAllEditions,
        "holdingsAllVariantRecords": holdingsAllVariantRecords,
        "preferredLanguage": preferredLanguage,
        "holdingsFilterFormat": holdingsFilterFormat,
        "heldInCountry": heldInCountry,
        "heldInState": heldInState,
        "heldByGroup": heldByGroup,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "heldByLibraryType": heldByLibraryType,
        "lat": lat,
        "lon": lon,
        "distance": distance,
        "unit": unit,
    }

    # prep request
    req = Request("GET", url, params=payload, headers=header, hooks=hooks)
    prepared_request = self.prepare_request(req)

    # send request
    query = Query(self, prepared_request, timeout=self.timeout)

    return query.response