Bulk Waive Criteria

Get Bulk Waive Criteria

GET /api/.../bulkwaivecriteria/{id}

Return properties of a bulk waive criteria.

Request Information

Parameters
Name Type Required Description
id Integer Yes The id of the bulk waive criteria.

Response Information

Example
application/json, text/json 
{
  "BulkWaiveCriteriaID": 2,
  "Name": "Saratoga - Pre-2010 Fines",
  "Note": "Saratoga patrons with fines before 2010",
  "CreatorID": 1,
  "CreatorName": "PolarisExec",
  "CreationDate": "2024-02-09T18:22:47.14-05:00",
  "ModifierID": 1,
  "ModifierName": "PolarisExec",
  "ModificationDate": "2024-02-09T18:58:27.393-05:00",
  "OrganizationOwnerID": 90,
  "OrganizationOwnerName": null,
  "ScheduledRunDate": "2024-02-28T00:00:00-05:00",
  "QueryText": null,
  "FineBeforeDate": "2010-01-01T00:00:00-05:00",
  "PatronLastActivityBeforeDate": "2020-12-01T00:00:00-05:00",
  "FeeReasonCodes": [],
  "PatronCodes": [],
  "Collections": [],
  "MaterialTypes": [
    {
      "Key": 1,
      "Value": "Book"
    },
    {
      "Key": 3,
      "Value": "Video"
    }
  ],
  "OwningBranches": [
    {
      "Key": 90,
      "Value": "Saratoga Springs Public  Library"
    }
  ],
  "PatronBranches": [
    {
      "Key": 90,
      "Value": "Saratoga Springs Public  Library"
    }
  ],
  "ItemBranches": [
    {
      "Key": 90,
      "Value": "Saratoga Springs Public  Library"
    }
  ]
}

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Get Bulk Waive Criteria Job History

GET /api/.../bulkwaivecriteria/{id}?type=history

Return properties of a bulk waive criteria.

Request Information

Parameters
Name Type Required Description
id Integer Yes The id of the bulk waive criteria.
type string Yes The request type. Accepts: history

Response Information

Example
application/json, text/json 
[
  {
    "BulkWaiveJobID": 47,
    "BulkWaiveCriteriaID": 11,
    "RunDate": "2021-06-14T06:37:08.077-04:00",
    "TotalWaiveAmount": 172.63,
    "TransactionsCount": 15,
    "PatronsCount": 10,
    "ItemsCount": 8,
    "ErrorsCount": 0
  },
  {
    "BulkWaiveJobID": 53,
    "BulkWaiveCriteriaID": 11,
    "RunDate": "2021-06-28T06:25:17.145-04:00",
    "TotalWaiveAmount": 103.68,
    "TransactionsCount": 13,
    "PatronsCount": 8,
    "ItemsCount": 7,
    "ErrorsCount": 2
  }
]

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Get All Bulk Waive Criteria

GET /api/.../bulkwaivecriteria

Return brief properties of all bulk waive criteria.

Response Information

Example
application/json, text/json 
[
  {
    "BulkWaiveCriteriaID": 1,
    "Name": "Amsterdam - Inactive before 2020",
    "Note": "Amsterdam patrons inactive in the 2020s",
    "CreatorID": 1,
    "CreatorName": "PolarisExec",
    "CreationDate": "2024-02-09T18:22:47.14-05:00",
    "ModifierID": 1,
    "ModifierName": "PolarisExec",
    "ModificationDate": "2024-02-09T19:00:42.783-05:00",
    "OrganizationOwnerID": 3,
    "OrganizationOwnerName": "Amsterdam Free Library",
    "LastRunDate": null,
    "LastRunJobID": null,
    "ScheduledRunDate": null
  },
  {
    "BulkWaiveCriteriaID": 2,
    "Name": "Saratoga - Pre-2010 Fines",
    "Note": "Saratoga patrons with fines before 2010",
    "CreatorID": 1,
    "CreatorName": "PolarisExec",
    "CreationDate": "2024-02-09T18:22:47.14-05:00",
    "ModifierID": 1,
    "ModifierName": "PolarisExec",
    "ModificationDate": "2024-02-09T18:58:27.393-05:00",
    "OrganizationOwnerID": 90,
    "OrganizationOwnerName": "Saratoga Springs Public  Library",
    "LastRunDate": null,
    "LastRunJobID": null,
    "ScheduledRunDate": "2024-02-28T00:00:00-05:00"
  }
]

HTTP Response Codes

Code Description
200 OK. Success


Create Bulk Waive Criteria

POST /api/.../bulkwaivecriteria

Create a new bulk waive criteria.

Request Information

Parameters
Name Type Required Description
Bulk Waive Criteria Data DtoBulkWaiveCriteriaData Yes Define this parameter in the request body.
DtoBulkWaiveCriteriaData
Property Type Nullable Description
Name string No The unique name assigned to the bulk waive criteria.
Note string Yes The unique id assigned to the bulk waive template.
OrganizationOwnerID integer No The organization identifier owning the criteria.
ScheduledRunDate DateTime Yes The next date when the criteria will be run.
QueryText string Yes The search command to qualify fines.
FineBeforeDate DateTime Yes The date threshold for fine age.
PatronLastActivityBeforeDate DateTime Yes The date threshold for patron inactivity.
FeeReasonCodes List of integers Yes The list of fee reason code identifiers to include.
PatronCodes List of integers Yes The list of patron code identifiers to include.
Collections List of integers Yes The list of collection identifiers to include.
MaterialTypes List of integers Yes The list of material type identifiers to include.
OwningBranches List of integers Yes The list of owning organization identifiers to include.
PatronBranches List of integers Yes The list of patron organization identifiers to include.
ItemBranches List of integers Yes The list of item organization identifiers to include.

Response Information

Example
application/json, text/json 
{
  "BulkWaiveCriteriaID": 11,
  "Preview": {
    "BulkWaiveJobID": 47,
    "BulkWaiveCriteriaID": 11,
    "RunDate": "2021-06-14T06:37:08.077-04:00",
    "TotalWaiveAmount": 172.63,
    "TransactionsCount": 15,
    "PatronsCount": 10,
    "ItemsCount": 8,
    "ErrorsCount": 0
}

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Update Bulk Waive Criteria

PUT /api/.../bulkwaivecriteria/{id}

Update a bulk waive criteria.

Request Information

Parameters
Name Type Required Description
Bulk Waive Criteria Data DtoBulkWaiveCriteriaData Yes
DtoBulkWaiveCriteriaData
Property Type Nullable Description
Name string No The unique name assigned to the bulk waive criteria.
Note string Yes The unique id assigned to the bulk waive template.
OrganizationOwnerID integer No The organization identifier owning the criteria.
ScheduledRunDate DateTime Yes The next date when the criteria will be run.
QueryText string Yes The search command to qualify fines.
FineBeforeDate DateTime Yes The date threshold for fine age.
PatronLastActivityBeforeDate DateTime Yes The date threshold for patron inactivity.
FeeReasonCodes List of integers Yes The list of fee reason code identifiers to include.
PatronCodes List of integers Yes The list of patron code identifiers to include.
Collections List of integers Yes The list of collection identifiers to include.
MaterialTypes List of integers Yes The list of material type identifiers to include.
OwningBranches List of integers Yes The list of owning organization identifiers to include.
PatronBranches List of integers Yes The list of patron organization identifiers to include.
ItemBranches List of integers Yes The list of item organization identifiers to include.

Response Information

Example
application/json, text/json 
{
  "BulkWaiveCriteriaID": 11,
  "Preview": {
    "BulkWaiveJobID": 47,
    "BulkWaiveCriteriaID": 11,
    "RunDate": "2021-06-14T06:37:08.077-04:00",
    "TotalWaiveAmount": 172.63,
    "TransactionsCount": 15,
    "PatronsCount": 10,
    "ItemsCount": 8,
    "ErrorsCount": 0
}

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Delete Bulk Waive Criteria

DELETE /api/.../bulkwaivecriteria/{id}

Delete a bulk waive criteria.

Request Information

Parameters
Name Type Required Description
id Integer Yes The id of the bulk waive criteria.

Response Information

Example
application/json, text/json

True is returned upon success.

true

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Bulk Delete Bulk Waive Criteria

DELETE /api/.../bulkwaivecriteria

Delete multiple bulk waive criteria.

Request Information

Parameters
Name Type Required Description
id List of Integer Yes The ids of the bulk waive criteria provided in the request body.

Response Information

Example
application/json, text/json 
{
  "FailedIDs": [123],
  "LockedIDs": [345],
  "SuccessIDs": [45, 78, 1234]
}

HTTP Response Codes

Code Description
200 OK. Success
404 Not Found


Test Bulk Waive Criteria Query

POST /api/.../bulkwaivecriteria?type=testquery

Test a new bulk waive criteria search.

Request Information

Parameters
Name Type Required Description
Bulk Waive Criteria Data DtoBulkWaiveCriteriaData Yes Define this parameter in the request body.
DtoBulkWaiveCriteriaData (minimal)
Property Type Nullable Description
QueryText string No The search command to qualify transactions.
      All other properties are not required.

Response Information

Example
application/json, text/json

No content is returned when valid. An exception is returned with error details when invalid.

HTTP Response Codes

Code Description
204 No Content. Success
400 Invalid