Patron Imports

List All Patron Imports

GET /api/.../patronimports

Returns all patron imports

Response Information

Example
application/json, text/json 
[
  {
    "PatronImportID": 159,
    "PolarisUserID": 2157,
    "TotalRecords": 1,
    "UserName": "test.user",
    "PatronImportStatusID": 3,
    "Status": "Completed",
    "Started": "2025-06-05T16:42:29.307+02:00",
    "Ended": "2025-06-05T16:42:48.48+02:00",
    "LogonBranchID": 3,
    "WorkstationID": 1300,
    "AdminLanguageID": 1154,
    "SiteDomain": "polaris",
    "FileID": "2dfc450f-0036-422e-8177-30578887906a_csv",
    "FileName": "123.csv",
    "SupressVerifyPatronDataBlock": false
  },
  {
    "PatronImportID": 158,
    "PolarisUserID": 2157,
    "TotalRecords": 0,
    "UserName": "test.user",
    "PatronImportStatusID": 4,
    "Status": "Failed",
    "Started": "2025-06-05T14:55:37.447+02:00",
    "Ended": "2025-06-05T09:00:50.267+02:00",
    "LogonBranchID": 3,
    "WorkstationID": 1300,
    "AdminLanguageID": 1154,
    "SiteDomain": "polaris",
    "FileID": "7c1ac81f-3e59-49d0-9c6c-7d4360c68119_csv",
    "FileName": "1234.csv",
    "SupressVerifyPatronDataBlock": false
  },
  {
    "PatronImportID": 157,
    "PolarisUserID": 2157,
    "TotalRecords": 1,
    "UserName": "test.user",
    "PatronImportStatusID": 3,
    "Status": "Completed",
    "Started": "2025-06-05T14:36:02.717+02:00",
    "Ended": "2025-06-05T14:36:15.95+02:00",
    "LogonBranchID": 3,
    "WorkstationID": 1300,
    "AdminLanguageID": 1154,
    "SiteDomain": "polaris",
    "FileID": "ed42f77d-2bf1-412f-92c2-b7beb1b3ac50_csv",
    "FileName": "test.csv",
    "SupressVerifyPatronDataBlock": false
  }
]

HTTP Response Codes

Code Description
200 OK. Success

Create a Patron Import

POST /api/.../patronimports

Creating patron import that will be executed in a background

POST Form Data
Name Type Required Description
FileID string Yes File ID of uploaded file. This file ID is returned from endpoint that uploads file.
File Name String Yes Original file name that user uploaded.
SupressVerifyPatronDataBlock bool Yes If value is false patrons will be created without verify data block

Response Information

The response will be empty in case of success (200). In case of an error, the error message will be returned.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE

Delete Patron Import

DELETE /api/.../patronimports/{id}

Deleting the patron import, including the file and report.

Parameters
Name Type Required Description
PatronImportID integer Yes Patron Import ID

Response Information

The response will be empty in case of success (200). In case of an error, the error message will be returned.

Get patron import template file

GET /api/.../patronimports/template

Returns a patron import csv template.