Batch Party Service

Service for submitting and managing batch party searches.

class pacersdk.services.batch_party.BatchPartyService(token_provider: Callable[[], str], config: dict, token: str | None = None)

Bases: object

Provides access to the batch party search API endpoint.

delete(report_id: str) → dict

Delete a submitted batch party report by ID.

Parameters:

report_id – Batch report identifier.

Returns:

Response status or message.

download(report_id: str) → ReportList

Download results of a completed batch party search job.

Parameters:

report_id – The report identifier.

Returns:

ReportList object.

listall() → ReportList

Retrieve a list of all current batch party jobs.

Returns:

ReportList object.

status(report_id: str) → ReportList

Query the status of a batch party search job.

Parameters:

report_id – The report identifier.

Returns:

ReportList object.

submit(criteria: PartySearchCriteria) → ReportInfo

Submit a batch party search job.

Parameters:

criteria – PartySearchCriteria with optional filters.

Returns:

ReportInfo object.