bookops_worldcat.metadata_api

This module provides MetadataSession class for requests to WorldCat Metadata API.

MetadataSession

MetadataSession(
    authorization: WorldcatAccessToken,
    agent: Optional[str] = None,
    timeout: Optional[
        Union[
            int, float, Tuple[int, int], Tuple[float, float]
        ]
    ] = None,
)

Bases: WorldcatSession

OCLC Metadata API wrapper session. Inherits requests.Session methods

agent:                  "User-agent" parameter to be passed in the request
                        header; usage strongly encouraged
timeout:                how long to wait for server to send data before
                        giving up; default value is 5 seconds

Source code in bookops_worldcat\metadata_api.py

def __init__(
    self,
    authorization: WorldcatAccessToken,
    agent: Optional[str] = None,
    timeout: Optional[
        Union[int, float, Tuple[int, int], Tuple[float, float]]
    ] = None,
) -> None:
    """
    Args:
        authorization:          WorlcatAccessToken object
        agent:                  "User-agent" parameter to be passed in the request
                                header; usage strongly encouraged
        timeout:                how long to wait for server to send data before
                                giving up; default value is 5 seconds
    """
    super().__init__(authorization, agent=agent, timeout=timeout)

get_brief_bib

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

Retrieve specific brief bibliographic resource. Uses /brief-bibs/{oclcNumber} endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string that can include OCLC # prefix	required
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response instance

Source code in bookops_worldcat\metadata_api.py

def get_brief_bib(
    self, oclcNumber: Union[int, str], hooks: Optional[Dict[str, Callable]] = None
) -> Response:
    """
    Retrieve specific brief bibliographic resource.
    Uses /brief-bibs/{oclcNumber} endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be
                                an integer, or string that can include
                                OCLC # prefix
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` instance
    """

    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber:
        raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

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

    # 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

get_full_bib

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

Send a GET request for a full bibliographic resource. Uses /bib/data/{oclcNumber} endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
response_format	Optional[str]	format of returned record	None
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def get_full_bib(
    self,
    oclcNumber: Union[int, str],
    response_format: Optional[str] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Send a GET request for a full bibliographic resource.
    Uses /bib/data/{oclcNumber} endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        response_format:        format of returned record
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` object
    """
    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber:
        raise WorldcatSessionError("Invalid OCLC # was passed as an argument.")

    url = self._url_bib_oclc_number(oclcNumber)
    if not response_format:
        response_format = (
            'application/atom+xml;content="application/vnd.oclc.marc21+xml"'
        )
    header = {"Accept": response_format}

    # 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

holding_get_status

holding_get_status(
    oclcNumber: Union[int, str],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: Optional[
        str
    ] = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Retrieves Worlcat holdings status of a record with provided OCLC number. The service automatically recognizes institution based on the issued access token. Uses /ih/checkholdings endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
inst	Optional[str]	registry ID of the institution whose holdings are being checked	None
instSymbol	Optional[str]	optional; OCLC symbol of the institution whose holdings are being checked	None
response_format	Optional[str]	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns:

Type	Description
Response	requests.Response object

Source code in bookops_worldcat\metadata_api.py

def holding_get_status(
    self,
    oclcNumber: Union[int, str],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: Optional[str] = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Retrieves Worlcat holdings status of a record with provided OCLC number.
    The service automatically recognizes institution based on the issued access
    token.
    Uses /ih/checkholdings endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        inst:                   registry ID of the institution whose holdings
                                are being checked
        instSymbol:             optional; OCLC symbol of the institution whose
                                holdings are being checked
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks

    Returns:
        `requests.Response` object
    """
    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    url = self._url_bib_holdings_check()
    header = {"Accept": response_format}
    payload = {"oclcNumber": oclcNumber, "inst": inst, "instSymbol": instSymbol}

    # 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

holding_set

holding_set(
    oclcNumber: Union[int, str],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    holdingLibraryCode: Optional[str] = None,
    classificationScheme: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Sets institution's Worldcat holding on an individual record. Uses /ih/data endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
inst	Optional[str]	registry ID of the institution whose holdings are being checked	None
instSymbol	Optional[str]	optional; OCLC symbol of the institution whose holdings are being checked	None
holdingLibraryCode	Optional[str]	four letter holding code to set the holing on	None
classificationScheme	Optional[str]	whether or not to return group availability information	None
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns:

Type	Description
Response	requests.Response object

Source code in bookops_worldcat\metadata_api.py

def holding_set(
    self,
    oclcNumber: Union[int, str],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    holdingLibraryCode: Optional[str] = None,
    classificationScheme: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Sets institution's Worldcat holding on an individual record.
    Uses /ih/data endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        inst:                   registry ID of the institution whose holdings
                                are being checked
        instSymbol:             optional; OCLC symbol of the institution whose
                                holdings are being checked
        holdingLibraryCode:     four letter holding code to set the holing on
        classificationScheme:   whether or not to return group availability
                                information
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks

    Returns:
        `requests.Response` object
    """

    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    url = self._url_bib_holdings_action()
    header = {"Accept": response_format}
    payload = {
        "oclcNumber": oclcNumber,
        "inst": inst,
        "instSymbol": instSymbol,
        "holdingLibraryCode": holdingLibraryCode,
        "classificationScheme": classificationScheme,
    }

    # prep request
    req = Request("POST", 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

holding_unset

holding_unset(
    oclcNumber: Union[int, str],
    cascade: Union[int, str] = "0",
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    holdingLibraryCode: Optional[str] = None,
    classificationScheme: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Deletes institution's Worldcat holding on an individual record. Uses /ih/data endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix if str the numbers must be separated by comma	required
cascade	Union[int, str]	0 or 1, default 0; 0 - don't remove holdings if local holding record or local bibliographic records exists; 1 - remove holding and delete local holdings record and local bibliographic record	'0'
inst	Optional[str]	registry ID of the institution whose holdings are being checked	None
instSymbol	Optional[str]	optional; OCLC symbol of the institution whose holdings are being checked	None
holdingLibraryCode	Optional[str]	four letter holding code to set the holing on	None
classificationScheme	Optional[str]	whether or not to return group availability information	None
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns:

Type	Description
Response	requests.Response object

Source code in bookops_worldcat\metadata_api.py

def holding_unset(
    self,
    oclcNumber: Union[int, str],
    cascade: Union[int, str] = "0",
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    holdingLibraryCode: Optional[str] = None,
    classificationScheme: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Deletes institution's Worldcat holding on an individual record.
    Uses /ih/data endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
                                if str the numbers must be separated by comma
        cascade:                0 or 1, default 0;
                                0 - don't remove holdings if local holding
                                record or local bibliographic records exists;
                                1 - remove holding and delete local holdings
                                record and local bibliographic record
        inst:                   registry ID of the institution whose holdings
                                are being checked
        instSymbol:             optional; OCLC symbol of the institution whose
                                holdings are being checked
        holdingLibraryCode:     four letter holding code to set the holing on
        classificationScheme:   whether or not to return group availability
                                information
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks

    Returns:
        `requests.Response` object
    """

    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    url = self._url_bib_holdings_action()
    header = {"Accept": response_format}
    payload = {
        "oclcNumber": oclcNumber,
        "cascade": cascade,
        "inst": inst,
        "instSymbol": instSymbol,
        "holdingLibraryCode": holdingLibraryCode,
        "classificationScheme": classificationScheme,
    }

    # prep request
    req = Request("DELETE", 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(
    oclcNumbers: Union[str, List],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> List[Response]

Set institution holdings for multiple OCLC numbers Uses /ih/datalist endpoint.

Parameters:

Name	Type	Description	Default
oclcNumbers	Union[str, List]	list of OCLC control numbers for which holdings should be set; they can be integers or strings with or without OCLC # prefix; if str the numbers must be separated by comma	required
inst	Optional[str]	registry ID of the institution whose holdings are being checked	None
instSymbol	Optional[str]	optional; OCLC symbol of the institution whose holdings are being checked	None
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: list of requests.Response objects

Source code in bookops_worldcat\metadata_api.py

def holdings_set(
    self,
    oclcNumbers: Union[str, List],
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> List[Response]:
    """
    Set institution holdings for multiple OCLC numbers
    Uses /ih/datalist endpoint.

    Args:
        oclcNumbers:            list of OCLC control numbers for which holdings
                                should be set;
                                they can be integers or strings with or
                                without OCLC # prefix;
                                if str the numbers must be separated by comma
        inst:                   registry ID of the institution whose holdings
                                are being checked
        instSymbol:             optional; OCLC symbol of the institution whose
                                holdings are being checked
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        list of `requests.Response` objects
    """
    responses = []

    try:
        vetted_numbers = verify_oclc_numbers(oclcNumbers)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    url = self._url_bib_holdings_batch_action()
    header = {"Accept": response_format}

    # split into batches of 50 and issue request for each batch
    for batch in self._split_into_legal_volume(vetted_numbers):
        payload = {
            "oclcNumbers": batch,
            "inst": inst,
            "instSymbol": instSymbol,
        }

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

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

        responses.append(query.response)

    return responses

holdings_set_multi_institutions

holdings_set_multi_institutions(
    oclcNumber: Union[int, str],
    instSymbols: str,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Batch sets intitution holdings for multiple intitutions

Uses /ih/institutionlist endpoint

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
instSymbols	str	a comma-separated list of OCLC symbols of the institution whose holdings are being set	required
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def holdings_set_multi_institutions(
    self,
    oclcNumber: Union[int, str],
    instSymbols: str,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Batch sets intitution holdings for multiple intitutions

    Uses /ih/institutionlist endpoint

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        instSymbols:            a comma-separated list of OCLC symbols of the
                                institution whose holdings are being set
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` object
    """
    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber:
        raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

    url = self._url_bib_holdings_multi_institution_batch_action()
    header = {"Accept": response_format}
    payload = {
        "oclcNumber": oclcNumber,
        "instSymbols": instSymbols,
    }

    # prep request
    req = Request("POST", 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_unset

holdings_unset(
    oclcNumbers: Union[str, List],
    cascade: str = "0",
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> List[Response]

Set institution holdings for multiple OCLC numbers Uses /ih/datalist endpoint.

Parameters:

Name	Type	Description	Default
oclcNumbers	Union[str, List]	list of OCLC control numbers for which holdings should be set; they can be integers or strings with or without OCLC # prefix; if str the numbers must be separated by comma	required
cascade	str	0 or 1, default 0; 0 - don't remove holdings if local holding record or local bibliographic records exists; 1 - remove holding and delete local holdings record and local bibliographic record	'0'
inst	Optional[str]	registry ID of the institution whose holdings are being checked	None
instSymbol	Optional[str]	optional; OCLC symbol of the institution whose holdings are being checked	None
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: list of requests.Response objects

Source code in bookops_worldcat\metadata_api.py

def holdings_unset(
    self,
    oclcNumbers: Union[str, List],
    cascade: str = "0",
    inst: Optional[str] = None,
    instSymbol: Optional[str] = None,
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> List[Response]:
    """
    Set institution holdings for multiple OCLC numbers
    Uses /ih/datalist endpoint.

    Args:
        oclcNumbers:            list of OCLC control numbers for which holdings
                                should be set;
                                they can be integers or strings with or
                                without OCLC # prefix;
                                if str the numbers must be separated by comma
        cascade:                0 or 1, default 0;
                                0 - don't remove holdings if local holding
                                record or local bibliographic records exists;
                                1 - remove holding and delete local holdings
                                record and local bibliographic record
        inst:                   registry ID of the institution whose holdings
                                are being checked
        instSymbol:             optional; OCLC symbol of the institution whose
                                holdings are being checked
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        list of `requests.Response` objects
    """
    responses = []

    try:
        vetted_numbers = verify_oclc_numbers(oclcNumbers)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    url = self._url_bib_holdings_batch_action()
    header = {"Accept": response_format}

    # split into batches of 50 and issue request for each batch
    for batch in self._split_into_legal_volume(vetted_numbers):
        payload = {
            "oclcNumbers": batch,
            "cascade": cascade,
            "inst": inst,
            "instSymbol": instSymbol,
        }

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

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

        responses.append(query.response)

    return responses

holdings_unset_multi_institutions

holdings_unset_multi_institutions(
    oclcNumber: Union[int, str],
    instSymbols: str,
    cascade: str = "0",
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Batch unsets intitution holdings for multiple intitutions

Uses /ih/institutionlist endpoint

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
instSymbols	str	a comma-separated list of OCLC symbols of the institution whose holdings are being set	required
cascade	str	0 or 1, default 0; 0 - don't remove holdings if local holding record or local bibliographic records exists; 1 - remove holding and delete local holdings record and local bibliographic record	'0'
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def holdings_unset_multi_institutions(
    self,
    oclcNumber: Union[int, str],
    instSymbols: str,
    cascade: str = "0",
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Batch unsets intitution holdings for multiple intitutions

    Uses /ih/institutionlist endpoint

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        instSymbols:            a comma-separated list of OCLC symbols of the
                                institution whose holdings are being set
        cascade:                0 or 1, default 0;
                                0 - don't remove holdings if local holding
                                record or local bibliographic records exists;
                                1 - remove holding and delete local holdings
                                record and local bibliographic record
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` object
    """
    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber:
        raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

    url = self._url_bib_holdings_multi_institution_batch_action()
    header = {"Accept": response_format}
    payload = {
        "oclcNumber": oclcNumber,
        "instSymbols": instSymbols,
        "cascade": cascade,
    }

    # prep request
    req = Request("DELETE", 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

search_brief_bib_other_editions

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

Retrieve other editions related to bibliographic resource with provided OCLC #. Uses /brief-bibs/{oclcNumber}/other-editions endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string with or without OCLC # prefix	required
deweyNumber	Optional[str]	limits the response to the specified dewey classification number(s); for multiple values repeat the parameter, example: '794,180'	None
datePublished	Optional[str]	restricts the response to one or more dates, or to a range, examples: '2000' '2000-2005' '2000,2005'	None
heldByGroup	Optional[str]	restricts to holdings held by group symbol	None
heldBySymbol	Optional[str]	restricts to holdings with specified intitution symbol	None
heldByInstitutionID	Optional[Union[str, int]]	restrict to specified institution regisgtryId	None
inLanguage	Optional[str]	restrics the response to the single specified language, example: 'fre'	None
inCatalogLanguage	Optional[str]	restrics the response to specified cataloging language, example: 'eng'; default 'eng'	None
materialType	Optional[str]	restricts responses to specified material type, example: 'bks', 'vis'	None
catalogSource	Optional[str]	restrict to responses to single OCLC symbol as the cataloging source, example: 'DLC'	None
itemType	Optional[str]	restricts reponses to single specified OCLC top-level facet type, example: 'book'	None
itemSubType	Optional[str]	restricts responses to single specified OCLC sub facet type, example: 'digital'	None
retentionCommitments	Optional[bool]	restricts responses to bibliographic records with retention commitment; True or False, default False	None
spProgram	Optional[str]	restricts responses to bibliographic records associated with particular shared print program	None
genre	Optional[str]	genre to limit results to	None
topic	Optional[str]	topic to limit results to	None
subtopic	Optional[str]	subtopic to limit results to	None
audience	Optional[str]	audience to limit results to, example: juv, nonJuv	None
content	Optional[str]	content to limit resutls to, example: fic, nonFic, fic,bio	None
openAccess	Optional[bool]	filter to only open access content, False or True	None
peerReviewed	Optional[bool]	filter to only peer reviewed content, False or True	None
facets	Optional[str]	list of facets to restrict responses	None
groupVariantRecords	Optional[bool]	whether or not to group variant records. options: False, True (default False)	None
preferredLanguage	Optional[str]	language of metadata description,	None
offset	Optional[int]	start position of bibliographic records to return; default 1	None
limit	Optional[int]	maximum nuber of records to return; maximum 50, default 10	None
orderBy	Optional[str]	sort of restuls; available values: +date, -date, +language, -language; default value: -date	None
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def search_brief_bib_other_editions(
    self,
    oclcNumber: Union[int, str],
    deweyNumber: Optional[str] = None,
    datePublished: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldBySymbol: Optional[str] = None,
    heldByInstitutionID: Optional[Union[str, int]] = None,
    inLanguage: Optional[str] = None,
    inCatalogLanguage: Optional[str] = None,
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[str] = None,
    itemSubType: Optional[str] = None,
    retentionCommitments: Optional[bool] = None,
    spProgram: Optional[str] = None,
    genre: Optional[str] = None,
    topic: Optional[str] = None,
    subtopic: Optional[str] = None,
    audience: Optional[str] = None,
    content: Optional[str] = None,
    openAccess: Optional[bool] = None,
    peerReviewed: Optional[bool] = None,
    facets: Optional[str] = None,
    groupVariantRecords: Optional[bool] = None,
    preferredLanguage: Optional[str] = None,
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    orderBy: Optional[str] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Retrieve other editions related to bibliographic resource with provided
    OCLC #.
    Uses /brief-bibs/{oclcNumber}/other-editions endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be an
                                integer, or string with or without OCLC # prefix
        deweyNumber:            limits the response to the
                                specified dewey classification number(s);
                                for multiple values repeat the parameter,
                                example:
                                    '794,180'
        datePublished:          restricts the response to one or
                                more dates, or to a range,
                                examples:
                                    '2000'
                                    '2000-2005'
                                    '2000,2005'
        heldByGroup:            restricts to holdings held by group symbol
        heldBySymbol:           restricts to holdings with specified intitution
                                symbol
        heldByInstitutionID:    restrict to specified institution regisgtryId
        inLanguage:             restrics the response to the single
                                specified language, example: 'fre'
        inCatalogLanguage:      restrics the response to specified
                                cataloging language, example: 'eng';
                                default 'eng'
        materialType:           restricts responses to specified material type,
                                example: 'bks', 'vis'
        catalogSource:          restrict to responses to single OCLC symbol as
                                the cataloging source, example: 'DLC'
        itemType:               restricts reponses to single specified OCLC
                                top-level facet type, example: 'book'
        itemSubType:            restricts responses to single specified OCLC
                                sub facet type, example: 'digital'
        retentionCommitments:   restricts responses to bibliographic records
                                with retention commitment; True or False,
                                default False
        spProgram:              restricts responses to bibliographic records
                                associated with particular shared print
                                program
        genre:                  genre to limit results to
        topic:                  topic to limit results to
        subtopic:               subtopic to limit results to
        audience:               audience to limit results to,
                                example:
                                    juv,
                                    nonJuv
        content:                content to limit resutls to,
                                example:
                                    fic,
                                    nonFic,
                                    fic,bio
        openAccess:             filter to only open access content, False or True
        peerReviewed:           filter to only peer reviewed content, False or True
        facets:                 list of facets to restrict responses
        groupVariantRecords:    whether or not to group variant records.
                                options: False, True (default False)
        preferredLanguage:      language of metadata description,
        offset:                 start position of bibliographic records to
                                return; default 1
        limit:                  maximum nuber of records to return;
                                maximum 50, default 10
        orderBy:                sort of restuls;
                                available values:
                                    +date, -date, +language, -language;
                                default value: -date
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` object
    """
    try:
        oclcNumber = verify_oclc_number(oclcNumber)
    except InvalidOclcNumber:
        raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

    url = self._url_brief_bib_other_editions(oclcNumber)
    header = {"Accept": "application/json"}
    payload = {
        "deweyNumber": deweyNumber,
        "datePublished": datePublished,
        "heldByGroup": heldByGroup,
        "heldBySymbol": heldBySymbol,
        "heldByInstitutionID": heldByInstitutionID,
        "inLanguage": inLanguage,
        "inCatalogLanguage": inCatalogLanguage,
        "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,
        "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

search_brief_bibs

search_brief_bibs(
    q: str,
    deweyNumber: Optional[str] = None,
    datePublished: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    inLanguage: Optional[str] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[str] = None,
    itemSubType: Optional[str] = None,
    retentionCommitments: Optional[bool] = None,
    spProgram: Optional[str] = None,
    facets: Optional[str] = None,
    groupRelatedEditions: Optional[bool] = None,
    groupVariantRecords: Optional[bool] = None,
    preferredLanguage: Optional[str] = None,
    orderBy: Optional[str] = "mostWidelyHeld",
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Send a GET request for brief bibliographic resources. Uses /brief-bibs endpoint.

Parameters:

Name	Type	Description	Default
q	str	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	required
deweyNumber	Optional[str]	limits the response to the specified dewey classification number(s); for multiple values repeat the parameter, example: '794,180'	None
datePublished	Optional[str]	restricts the response to one or more dates, or to a range, examples: '2000' '2000-2005' '2000,2005'	None
heldByGroup	Optional[str]	restricts to holdings held by group symbol	None
inLanguage	Optional[str]	restrics the response to the single specified language, example: 'fre'	None
inCatalogLanguage	Optional[str]	restrics the response to specified cataloging language, example: 'eng'; default 'eng'	'eng'
materialType	Optional[str]	restricts responses to specified material type, example: 'bks', 'vis'	None
catalogSource	Optional[str]	restrict to responses to single OCLC symbol as the cataloging source, example: 'DLC'	None
itemType	Optional[str]	restricts reponses to single specified OCLC top-level facet type, example: 'book'	None
itemSubType	Optional[str]	restricts responses to single specified OCLC sub facet type, example: 'digital'	None
retentionCommitments	Optional[bool]	restricts responses to bibliographic records with retention commitment; True or False	None
spProgram	Optional[str]	restricts responses to bibliographic records associated with particular shared print program	None
facets	Optional[str]	list of facets to restrict responses	None
groupRelatedEditions	Optional[bool]	whether or not use FRBR grouping, options: False, True (default is False)	None
groupVariantRecords	Optional[bool]	whether or not to group variant records. options: False, True (default False)	None
preferredLanguage	Optional[str]	language of metadata description, default value "en" (English)	None
orderBy	Optional[str]	results sort key; options: 'recency' 'bestMatch' 'creator' 'library' 'publicationDateAsc' 'publicationDateDesc' 'mostWidelyHeld' 'title'	'mostWidelyHeld'
offset	Optional[int]	start position of bibliographic records to return; default 1	None
limit	Optional[int]	maximum nuber of records to return; maximum 50, default 10	None
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns:

Type	Description
Response	requests.Response object

Source code in bookops_worldcat\metadata_api.py

def search_brief_bibs(
    self,
    q: str,
    deweyNumber: Optional[str] = None,
    datePublished: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    inLanguage: Optional[str] = None,
    inCatalogLanguage: Optional[str] = "eng",
    materialType: Optional[str] = None,
    catalogSource: Optional[str] = None,
    itemType: Optional[str] = None,
    itemSubType: Optional[str] = None,
    retentionCommitments: Optional[bool] = None,
    spProgram: Optional[str] = None,
    facets: Optional[str] = None,
    groupRelatedEditions: Optional[bool] = None,
    groupVariantRecords: Optional[bool] = None,
    preferredLanguage: Optional[str] = None,
    orderBy: Optional[str] = "mostWidelyHeld",
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Send a GET request for brief bibliographic resources.
    Uses /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,180'
        datePublished:          restricts the response to one or
                                more dates, or to a range,
                                examples:
                                    '2000'
                                    '2000-2005'
                                    '2000,2005'
        heldByGroup:            restricts to holdings held by group symbol
        inLanguage:             restrics the response to the single
                                specified language, example: 'fre'
        inCatalogLanguage:      restrics the response to specified
                                cataloging language, example: 'eng';
                                default 'eng'
        materialType:           restricts responses to specified material type,
                                example: 'bks', 'vis'
        catalogSource:          restrict to responses to single OCLC symbol as
                                the cataloging source, example: 'DLC'
        itemType:               restricts reponses to single specified OCLC
                                top-level facet type, example: 'book'
        itemSubType:            restricts responses to single specified OCLC
                                sub facet type, example: 'digital'
        retentionCommitments:   restricts responses to bibliographic records
                                with retention commitment; True or False
        spProgram:              restricts responses to bibliographic records
                                associated with particular shared print
                                program
        facets:                 list of facets to restrict responses
        groupRelatedEditions:   whether or not use FRBR grouping,
                                options: False, True (default is False)
        groupVariantRecords:    whether or not to group variant records.
                                options: False, True (default False)
        preferredLanguage:      language of metadata description,
                                default value "en" (English)
        orderBy:                results sort key;
                                options:
                                    'recency'
                                    'bestMatch'
                                    'creator'
                                    'library'
                                    'publicationDateAsc'
                                    'publicationDateDesc'
                                    'mostWidelyHeld'
                                    'title'
        offset:                 start position of bibliographic records to
                                return; default 1
        limit:                  maximum nuber of records to return;
                                maximum 50, default 10
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks

    Returns:
        `requests.Response` object

    """
    if not q:
        raise WorldcatSessionError("Argument 'q' is requried to construct query.")

    url = self._url_brief_bib_search()
    header = {"Accept": "application/json"}
    payload = {
        "q": q,
        "deweyNumber": deweyNumber,
        "datePublished": datePublished,
        "heldByGroup": heldByGroup,
        "inLanguage": inLanguage,
        "inCatalogLanguage": inCatalogLanguage,
        "materialType": materialType,
        "catalogSource": catalogSource,
        "itemType": itemType,
        "itemSubType": itemSubType,
        "retentionCommitments": retentionCommitments,
        "spProgram": spProgram,
        "facets": facets,
        "groupRelatedEditions": groupRelatedEditions,
        "groupVariantRecords": groupVariantRecords,
        "preferredLanguage": preferredLanguage,
        "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

search_current_control_numbers

search_current_control_numbers(
    oclcNumbers: Union[str, List[Union[str, int]]],
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Retrieve current OCLC control numbers Uses /bib/checkcontrolnumbers endpoint.

Parameters:

Name	Type	Description	Default
oclcNumbers	Union[str, List[Union[str, int]]]	list of OCLC control numbers to be checked; they can be integers or strings with or without OCLC # prefix; if str the numbers must be separated by comma	required
response_format	str	'application/atom+json' (default) or 'application/atom+xml'	'application/atom+json'
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns:

Type	Description
Response	requests.Response object

Source code in bookops_worldcat\metadata_api.py

def search_current_control_numbers(
    self,
    oclcNumbers: Union[str, List[Union[str, int]]],
    response_format: str = "application/atom+json",
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Retrieve current OCLC control numbers
    Uses /bib/checkcontrolnumbers endpoint.

    Args:
        oclcNumbers:            list of OCLC control numbers to be checked;
                                they can be integers or strings with or
                                without OCLC # prefix;
                                if str the numbers must be separated by comma
        response_format:        'application/atom+json' (default) or
                                'application/atom+xml'
        hooks:                  Requests library hook system that can be
                                used for signal event handling, see more at:
                                https://requests.readthedocs.io/en/master/user/advanced/#event-hooks

    Returns:
        `requests.Response` object
    """

    try:
        vetted_numbers = verify_oclc_numbers(oclcNumbers)
    except InvalidOclcNumber as exc:
        raise WorldcatSessionError(exc)

    header = {"Accept": response_format}
    url = self._url_bib_check_oclc_numbers()
    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

search_general_holdings

search_general_holdings(
    oclcNumber: Union[int, str] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    preferredLanguage: Optional[str] = None,
    heldInCountry: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: Optional[str] = None,
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response

Given a known item gets summary of holdings. Uses /bibs-summary-holdings endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string that can include OCLC # prefix	None
isbn	Optional[str]	ISBN without any dashes, example: '978149191646x'	None
issn	Optional[str]	ISSN (hyphenated, example: '0099-1234')	None
holdingsAllEditions	Optional[bool]	get holdings for all editions; options: True or False	None
holdingsAllVariantRecords	Optional[bool]	get holdings for specific edition across variant records; options: False, True	None
preferredLanguage	Optional[str]	language of metadata description; default 'en' (English)	None
heldInCountry	Optional[str]	restricts to holdings held by institutions in requested country	None
heldByGroup	Optional[str]	limits to holdings held by indicated by symbol group	None
lat	Optional[float]	limit to latitude, example: 37.502508	None
lon	Optional[float]	limit to longitute, example: -122.22702	None
distance	Optional[int]	distance from latitude and longitude	None
unit	Optional[str]	unit of distance param; options: 'M' (miles) or 'K' (kilometers)	None
offset	Optional[int]	start position of bibliographic records to return; default 1	None
limit	Optional[int]	maximum nuber of records to return; maximum 50, default 10	None
hooks	Optional[Dict[str, Callable]]	Requests library hook system that can be used for signal event handling, see more at: https://requests.readthedocs.io/en/master/user/advanced/#event-hooks	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def search_general_holdings(
    self,
    oclcNumber: Union[int, str] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    holdingsAllEditions: Optional[bool] = None,
    holdingsAllVariantRecords: Optional[bool] = None,
    preferredLanguage: Optional[str] = None,
    heldInCountry: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    lat: Optional[float] = None,
    lon: Optional[float] = None,
    distance: Optional[int] = None,
    unit: Optional[str] = None,
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Given a known item gets summary of holdings.
    Uses /bibs-summary-holdings endpoint.

    Args:
        oclcNumber:                 OCLC bibliographic record number; can be
                                    an integer, or string that can include
                                    OCLC # 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: False, True
        preferredLanguage:          language of metadata description;
                                    default 'en' (English)
        heldInCountry:              restricts to holdings held by institutions
                                    in requested country
        heldByGroup:                limits to holdings held by indicated by
                                    symbol group
        lat:                        limit to latitude, example: 37.502508
        lon:                        limit to longitute, example: -122.22702
        distance:                   distance from latitude and longitude
        unit:                       unit of distance param; options:
                                    'M' (miles) or 'K' (kilometers)
        offset:                     start position of bibliographic records to
                                    return; default 1
        limit:                      maximum nuber of records to return;
                                    maximum 50, default 10
        hooks:                      Requests library hook system that can be
                                    used for signal event handling, see more at:
                                    https://requests.readthedocs.io/en/master/user/advanced/#event-hooks
    Returns:
        `requests.Response` object
    """
    if not any([oclcNumber, isbn, issn]):
        raise WorldcatSessionError(
            "Missing required argument. "
            "One of the following args are required: oclcNumber, issn, isbn"
        )
    if oclcNumber is not None:
        try:
            oclcNumber = verify_oclc_number(oclcNumber)
        except InvalidOclcNumber:
            raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

    url = self._url_member_general_holdings()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "isbn": isbn,
        "issn": issn,
        "holdingsAllEditions": holdingsAllEditions,
        "holdingsAllVariantRecords": holdingsAllVariantRecords,
        "preferredLanguage": preferredLanguage,
        "heldInCountry": heldInCountry,
        "heldByGroup": heldByGroup,
        "lat": lat,
        "lon": lon,
        "distance": distance,
        "unit": unit,
        "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

search_shared_print_holdings

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

Finds member shared print holdings for specified item. Uses /bibs-retained-holdings endpoint.

Parameters:

Name	Type	Description	Default
oclcNumber	Union[int, str]	OCLC bibliographic record number; can be an integer, or string that can include OCLC # prefix	None
isbn	Optional[str]	ISBN without any dashes, example: '978149191646x'	None
issn	Optional[str]	ISSN (hyphenated, example: '0099-1234')	None
heldByGroup	Optional[str]	restricts to holdings held by group symbol	None
heldInState	Optional[str]	restricts to holings held by institutions in requested state, example: "NY"	None
itemType	Optional[str]	restricts results to specified item type (example 'book' or 'vis')	None
itemSubType	Optional[str]	restricts results to specified item sub type examples: 'book-digital' or 'audiobook-cd'	None
offset	Optional[int]	start position of bibliographic records to return; default 1	None
limit	Optional[int]	maximum nuber of records to return; maximum 50, default 10	None

Returns: requests.Response object

Source code in bookops_worldcat\metadata_api.py

def search_shared_print_holdings(
    self,
    oclcNumber: Union[int, str] = None,
    isbn: Optional[str] = None,
    issn: Optional[str] = None,
    heldByGroup: Optional[str] = None,
    heldInState: Optional[str] = None,
    itemType: Optional[str] = None,
    itemSubType: Optional[str] = None,
    offset: Optional[int] = None,
    limit: Optional[int] = None,
    hooks: Optional[Dict[str, Callable]] = None,
) -> Response:
    """
    Finds member shared print holdings for specified item.
    Uses /bibs-retained-holdings endpoint.

    Args:
        oclcNumber:             OCLC bibliographic record number; can be
                                an integer, or string that can include
                                OCLC # 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 holings held by institutions
                                in requested state, example: "NY"
        itemType:               restricts results to specified item type (example
                                'book' or 'vis')
        itemSubType:            restricts results to specified item sub type
                                examples: 'book-digital' or 'audiobook-cd'
        offset:                 start position of bibliographic records to
                                return; default 1
        limit:                  maximum nuber of records to return;
                                maximum 50, default 10
        ""
    Returns:
        `requests.Response` object
    """
    if not any([oclcNumber, isbn, issn]):
        raise WorldcatSessionError(
            "Missing required argument. "
            "One of the following args are required: oclcNumber, issn, isbn"
        )

    if oclcNumber is not None:
        try:
            oclcNumber = verify_oclc_number(oclcNumber)
        except InvalidOclcNumber:
            raise WorldcatSessionError("Invalid OCLC # was passed as an argument")

    url = self._url_member_shared_print_holdings()
    header = {"Accept": "application/json"}
    payload = {
        "oclcNumber": oclcNumber,
        "isbn": isbn,
        "issn": issn,
        "heldByGroup": heldByGroup,
        "heldInState": heldInState,
        "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