GET /api/.../weedingcriteria/{id}
Return properties of a weeding criteria.
| Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | The id of the weeding criteria. |
{
"WeedingCriteriaID": 3,
"Name": "Weeding Criteria - Template 1",
"WeedingTemplateID": 1,
"WeedingTemplateName": "Sample Weeding Template 1",
"CreatorID": 1,
"CreatorName": "PolarisExec",
"CreationDate": "2023-05-04T15:50:57.263-04:00",
"ModifierID": 1,
"ModifierName": "PolarisExec",
"ModificationDate": "2023-05-04T15:55:12.547-04:00",
"QueryText": "FREQ = a",
"NewerThanValue": 11,
"NewerThanTerm": "Y",
"OlderThanValue": 58,
"OlderThanTerm": "M",
"LifetimeCircCount": 20,
"LifetimeCircTerm": "O",
"LifetimeInHouseUse": 20,
"LifetimeInHouseTerm": "U",
"YTDCircCount": 4,
"YTDCircTerm": "U",
"YTDInHouseUse": 4,
"YTDInHouseTerm": "U"
}
| Code | Description |
|---|---|
| 200 | OK. Success |
| 404 | Not Found |
POST /api/.../weedingcriteria
Create a new weeding criteria.
| Name | Type | Required | Description |
|---|---|---|---|
| Weeding Criteria Data | DtoWeedingCriteriaData | Yes | Define this parameter in the request body. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| Name | string | No | The unique name assigned to the weeding criteria. |
| WeedingTemplateID | integer | No | The unique id assigned to the weeding template. |
| QueryText | string | Yes | The search command to qualify items. |
| NewerThanValue | integer | Yes | The numeric value for items to be newer than for comparisons. Accepts: 0 - 999 Must be used with "NewerThanTerm" property. |
| NewerThanTerm | string | Yes | The indicator term for the "NewerThanValue" property. Accepts: M (Months), Y (Years) Must be used with "NewerThanValue" property. |
| OlderThanValue | integer | Yes | The numeric value for items to be older than for comparisons. Accepts: 0 - 999 Must be used with "OlderThanTerm" property. |
| OlderThanTerm | string | Yes | The indicator term for the "OlderThanValue" property. Accepts: M (Months), Y (Years) Must be used with "OlderThanValue" property. |
| LifetimeCircCount | integer | Yes | The numeric value for items' lifetime circulation count for comparisons. Accepts: 0 - 999 Must be used with "LifetimeCircTerm" property. |
| LifetimeCircTerm | string | Yes | The indicator term for the "LifetimeCircCount" property. Accepts: O (Over), U (Under) Must be used with "LifetimeCircCount" property. |
| LifetimeInHouseUse | integer | Yes | The numeric value for items' lifetime in house use for comparisons. Accepts: 0 - 999 Must be used with "LifetimeInHouseTerm" property. |
| LifetimeInHouseTerm | string | Yes | The indicator term for the "LifetimeInHouseUse". Accepts: O (Over), U (Under) Must be used with "LifetimeInHouseUse" property. |
| YTDCircCount | integer | Yes | The numeric value for items' year to date circulation count for comparisons. Accepts: 0 - 999 Must be used with "YTDCircTerm" property. |
| YTDCircTerm | string | Yes | The indicator term for the "YTDCircCount" property. Accepts: O (Over), U (Under) Must be used with "YTDCircCount" property. |
| YTDInHouseUse | integer | Yes | The numeric value for items' year to date in house use for comparisons. Accepts: 0 - 999 Must be used with "YTDInHouseTerm" property. |
| YTDInHouseTerm | string | Yes | The indicator term for the "YTDInHouseUse". Accepts: O (Over), U (Under) Must be used with "YTDInHouseUse" property. |
The added WeedingCriteriaID is returned upon success.
82
| Code | Description |
|---|---|
| 200 | OK. Success |
| 404 | Not Found |
PUT /api/.../weedingcriteria/{id}
Update a weeding criteria.
| Name | Type | Required | Description |
|---|---|---|---|
| Weeding Criteria Data | DtoWeedingCriteriaData | Yes |
| Property | Type | Nullable | Description |
|---|---|---|---|
| WeedingCriteriaID | integer | No | The unique id assigned to the weeding criteria. |
| Name | string | No | The unique name assigned to the weeding criteria. |
| WeedingTemplateID | integer | No | The unique id assigned to the weeding template. |
| QueryText | string | Yes | The search command to qualify items. |
| NewerThanValue | integer | Yes | The numeric value for items to be newer than for comparisons. Accepts: 0 - 999 Must be used with "NewerThanTerm" property. |
| NewerThanTerm | string | Yes | The indicator term for the "NewerThanValue" property. Accepts: M (Months), Y (Years) Must be used with "NewerThanValue" property. |
| OlderThanValue | integer | Yes | The numeric value for items to be older than for comparisons. Accepts: 0 - 999 Must be used with "OlderThanTerm" property. |
| OlderThanTerm | string | Yes | The indicator term for the "OlderThanValue" property. Accepts: M (Months), Y (Years) Must be used with "OlderThanValue" property. |
| LifetimeCircCount | integer | Yes | The numeric value for items' lifetime circulation count for comparisons. Accepts: 0 - 999 Must be used with "LifetimeCircTerm" property. |
| LifetimeCircTerm | string | Yes | The indicator term for the "LifetimeCircCount" property. Accepts: O (Over), U (Under) Must be used with "LifetimeCircCount" property. |
| LifetimeInHouseUse | integer | Yes | The numeric value for items' lifetime in house use for comparisons. Accepts: 0 - 999 Must be used with "LifetimeInHouseTerm" property. |
| LifetimeInHouseTerm | string | Yes | The indicator term for the "LifetimeInHouseUse". Accepts: O (Over), U (Under) Must be used with "LifetimeInHouseUse" property. |
| YTDCircCount | integer | Yes | The numeric value for items' year to date circulation count for comparisons. Accepts: 0 - 999 Must be used with "YTDCircTerm" property. |
| YTDCircTerm | string | Yes | The indicator term for the "YTDCircCount" property. Accepts: O (Over), U (Under) Must be used with "YTDCircCount" property. |
| YTDInHouseUse | integer | Yes | The numeric value for items' year to date in house use for comparisons. Accepts: 0 - 999 Must be used with "YTDInHouseTerm" property. |
| YTDInHouseTerm | string | Yes | The indicator term for the "YTDInHouseUse". Accepts: O (Over), U (Under) Must be used with "YTDInHouseUse" property. |
True is returned upon success.
true
| Code | Description |
|---|---|
| 200 | OK. Success |
| 404 | Not Found |
DELETE /api/.../weedingcriteria/{id}
Delete a weeding criteria.
| Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | The id of the weeding criteria. |
True is returned upon success.
true
| Code | Description |
|---|---|
| 200 | OK. Success |
| 404 | Not Found |
DELETE /api/.../weedingcriteria
Delete multiple weeding criteria.
| Name | Type | Required | Description |
|---|---|---|---|
| id | List of Integer | Yes | The ids of the weeding criteria provided in the request body. |
True is returned upon success.
true
| Code | Description |
|---|---|
| 200 | OK. Success |
| 404 | Not Found |
POST /api/.../weedingcriteria?type=testquery
Test a new weeding criteria search.
| Name | Type | Required | Description |
|---|---|---|---|
| Weeding Criteria Data | DtoWeedingCriteriaData | Yes | Define this parameter in the request body. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| QueryText | string | No | The search command to qualify items. |
| All other properties are not required. |
No content is returned when valid. An exception is returned with error details when invalid.
| Code | Description |
|---|---|
| 204 | No Content. Success |
| 400 | Invalid |