Patron Messages

List All Patron Imports

GET /api/.../patronimports

Returns all patron imports

Response Information

Example
application/json, text/json 
[
  {
    "PatronImportID": 1,
    "PolarisUserID": 1,
    "TotalRecords": 123,
    "UserName": "PolarisExec",
    "PatronImportStatusID": 1,
    "Status": "Created",
    "Started": null,
    "Ended": null,
    "FileID": "FileID",
    "FileName": "FileName"
  },
  {
    "PatronImportID": 2,
    "PolarisUserID": 1,
    "TotalRecords": 55,
    "UserName": "PolarisExec",
    "PatronImportStatusID": 1,
    "Status": "Created",
    "Started": null,
    "Ended": null,
    "FileID": "FileIDTest",
    "FileName": "FileNameTest"
  }
]

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.

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