Synch_GetDeletedBibsPaged

This method returns a list of bibliographic record IDs for records that have been deleted since a specified date and time. The paged method allows the retrieval of the ID list in smaller packets. If the library does not retain deleted records, you cannot use this method.

A date, last record ID, and number of records to return must be specified. When retrieving the first set of records, the "lastid" of 0 forces the process to start at the beginning of the list. When retrieving subsequent records, the "lastid" value is set to the last retrieved record ID.

Important: This method provides a list of bibliographic records that have been deleted in the Polaris ILS. The method has a date and time parameter. If the time element is not specified, midnight of the day specified is assumed. Use the lastid parameter to specify the starting point in the 'paged' list. Use 0 to start at the beginning. Use the nrecs parameter to specify the number of records to return. This method returns a generic BibIDListGetResult XML structure (see below).

  GET /protected/1/{AccessToken}/synch/bibs/deleted/paged?deletedate=1/1/
2017&lastid=0&nrecs=10
 

Authorization required?

Yes

Protected method?

Yes

Query String Parameters

Name

Value

Required

Description/Notes

deletedate

YYYY-MM-DDTHH:MM:SS

Yes

Start date and time (records that have been deleted since this date/time)

lastid Use 0 when starting the retrieval process. Otherwise, use the last retrieved ID No  
nrecs Number of records to return Yes  

XML Elements Returned

Name

Description/Notes

PAPIErrorCode

PAPI Error code: Negative values represent errors and are defined elsewhere.

Note: On successful completion, the PAPI error code is populated with a positive integer representing the number of rows returned.

ErrorMessage

Error or information message

BibIDListRows

List of Bibliographic record IDs

BibIDListRow

Container for data

BibliographicRecordID

The Bibliographic Record ID

Example

https://[HOSTNAME]/PAPISevice/REST/protected/v1/1033/100/1/rGhOMQjR7MXZuJYREw6TQ
HPGsy1tlZPr/synch/bibs/deleted/paged?deletedate=1/1/2017&lastid=0&nrecs=10

Return

HTTP/1.1 200 OK

<BibIDListGetResult

xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<PAPIErrorCode>0</PAPIErrorCode>

<ErrorMessage/>

<BibIDListRows>

<BibIDListRow>

<BibliographicRecordID>803851</BibliographicRecordID>

</BibIDListRow>

</BibIDListRows>

</BibIDListGetResult>