PUT /api/.../publicationpatterns/{id}?ignorestatus={false}
Update publication pattern.
| Name | Type | Required | Description |
|---|---|---|---|
| id | Integer | Yes | The unique id assigned to the publication pattern. |
| DtoPubPatternOptionsUpdateInfo | Publication pattern Information | Yes | Define this parameter in the request body. |
| ignorestatus | bool | Yes | Indicator to allow updating the publication pattern if issues/parts exist. Default is false if not specified. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| ArrivalDuration | Integer | Yes | Number of days the linked Issue/Part record should be arriving in the library before or after its publication date (ie. chronology date). For a template, this field should always be NULL. |
| ArrivalTime | String | Yes | The linked Issue/Part record should be arriving in the library before or after its publication date (ie. chronology date). For a template, this field should always be NULL. |
| CalendarChange | String | Yes | 853/4/5 subfield $x. Contains one or more two- or four-char numeric codes separated by comma that indicate the chronological point at which pattern's highest level enumeration increments or changes. |
| CalendarUnit | Int | Yes | Value is used to validate the CalendarChange free text value. Valid Values: Season - 2, Month - 4, Day Of Month - 8 |
| EndDate | DateTime | Yes | Date by when prediction for pattern or template stops. |
| Frequency | Int | No | 853/4/5 subfield $x. Pattern's frequency. FK, references to MfhdFrequencies(FrequencyID). |
| ItemRecordCreateCode | Integer | Yes | Indicates the following methodology of item record creation during pattern's linked Issue/Part record check-in: 0 or NULL- no item record gets automatically created by Polaris; 1- one linked item record gets automatically created by Polaris without prompting user to input item record barcode; 2- one linked item record gets automatically created by Polaris with prompting user to input item record barcode; For a template, this field should always be NULL. |
| NumberToPredict | Byte | Yes | Maximum number of Issue/Part records that can be automatically predicted for a pattern at a time. For a template, this field should always be NULL. |
| NoteNonPub | String | Yes | Subfield 866/7/8 subfield $x (where user can enter non public note relating to the textual holding. E.g. Incomplete volumes unbound). |
| NotePub | String | Yes | Subfield 86/7/8 subfield $z (where user can enter public note which should display in the PAC relating to the textual holding. E.g. Some issues missing). |
| PubPatternID | Integer | Yes | The unique id assigned to the publication pattern. |
| StartDate | DateTime | No | Date when prediction for a pattern or template starts. |
| TypeOfSupIndex | String | Yes | 854/5 subfield $o. Type of supplementary material/Index. For a template, this field should always be NULL. |
| TextualHoldings | String | Yes | 866/7/8 $a. Textual description which may include the captions and enumeration and chronology for the holdings of the bibiographic item in the collections of the reporting organization. Refers to 866-868 fields (basic bib, supplement and index)of the holdings record. E.g. 1937-1968, plus 1969-1978 cumulative vol. |
| UnitPrice | Decimal | No | Unit price of an individual issue/part. |
| NorthernHemisphere | Boolean | No | If set to 'true', the designation will be set based on seasons in the Northern Hemisphere. |
| MfhdChronCaptions | List of DtoSerialIssueRecordChronology objects | Yes | Publication Pattern Chronology Data. At least one level of Chronology or Enumeration is required in order to update a publication pattern |
| MfhdEnumCaptions | List of DtoSerialIssueRecordEnumeration objects | Yes | Publication Pattern Enumeration Data. At least one level of Chronology or Enumeration is required in order to update a publication pattern |
| MfhdRegularityPatterns | List of DtoMfhdRegularityPatternInfo objects | Yes | Publication Pattern Regularity Patterns |
| Property | Type | Nullable | Description |
|---|---|---|---|
| ChronCap | Byte | Yes | Chronology Caption ID defined in ChronCapCodes |
| LevelNum | Byte | Yes | Indicates level of chronolgy. 1, 2, 3 or 4 indicates $i, $j, $k or $l accordingly. |
| IsAlter | Boolean | Yes | Indicates whether it is a $m or not. If 1, then this is a subfield $m. $m - alternative numbering scheme, chronology. |
| FormatID | Byte | Yes | Chronology caption format ID defined in MfhdChronFormats |
| ChronValue | String | Yes | Prediction start value of the subfield. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| LevelNum | Byte | Yes | Indicates level of enumeration. If IsAlter is 1 and LevelNum is 1, 2, 3 or 4, then indicates $a, $b, $c, $d, $e, $f; if IsAlter is 0 and LevelNum is 1 or 2 then indicates $g or $h accordingly. |
| IsAlter | Boolean | Yes | Indicates if it's a subfield $g, $h, or not. If 1, then it's $g or $h. |
| EnumCap | String | Yes | Enumeration caption (subfield $a-$h). |
| FormatID | Byte | Yes | Enumration caption format ID. FK, references MfhdEnumFormats.FormatID. |
| BibUnits | Integer | Yes | Bibliographic units per next higher level (subfield $u). An integer value is expected. |
| NumSchemeID | Byte | Yes | Numbering continuity (subfield $v). FK, references MfhdNumberingScheme.SchemeID. |
| EnumValue | String | Yes | Prediction start value of the subfield. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| PubPatternID | Int | No | The unique id assigned to the publication pattern. |
| PubCode | Char | Yes | Publication code. Can be one of the following values defined by MARC21 Format but can not be NULL: p - Published, c - Combined, o - Omitted |
| ChronCode | Int | Yes | Chronology type code defined by MARC21 Format for 853/4/5 $y. FK, references to MfhdChronCodes(CodeID). |
| CodePattern | String | Yes | Chronology code. For example, if CodePattern is MMDD, and Patterns is 1224, that means month = 12 and day of month = 24 which is Dec 24. |
| Patterns | String | Yes | Regularity pattern values. |
{
"PubPatternID":"1640",
"ArrivalTime":"A",
"ArrivalDuration":2,
"ItemRecordCreateCode":1,
"NumberToPredict":"3",
"NoteNonPub":null,
"NotePub":null,
"TypeOfSupIndex":null,
"TextualHoldings":null,
"UnitPrice":1,
"StartDate":"2022-09-26",
"Frequency":2,
"Designation": "cap1 A Cap1 1 Cap2 z (Autumn Monday Sep.)",
"TemplateNote":"Template Note",
"CalendarChange": null,
"MfhdChronCaptions":[
{
"ChronCap": 4,
"LevelNum": 1,
"IsAlter": false,
"FormatID": 3,
"ChronValue": "09"
},
{
"ChronCap": 7,
"LevelNum": 2,
"IsAlter": false,
"FormatID": 2,
"ChronValue": "mo"
},
{
"ChronCap": 2,
"LevelNum": 3,
"IsAlter": false,
"FormatID": 2,
"ChronValue": "23"
}
],
"MfhdEnumCaptions":[
{
"LevelNum": 1,
"IsAlter": false,
"EnumCap": "cap1",
"FormatID": 3,
"BibUnits": 0,
"NumSchemeID": 2,
"EnumValue": "A"
},
{
"LevelNum": 2,
"IsAlter": false,
"EnumCap": "Cap1",
"FormatID": 1,
"BibUnits": 1,
"NumSchemeID": 2,
"EnumValue": "1"
},
{
"LevelNum": 3,
"IsAlter": false,
"EnumCap": "Cap2",
"FormatID": 4,
"BibUnits": 2,
"NumSchemeID": 2,
"EnumValue": "z"
}
],
"MfhdRegularityPatterns":
[
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "01"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "02"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "03"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "04"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "05"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "06"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "07"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "08"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "09"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "10"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "11"
},
{
"PubPatternID": 1640,
"PubCode": "p",
"ChronCode": 4,
"CodePattern": "MM",
"Patterns": "12"
}
]
}
{
"ErrorCode": 20049,
"Message": "There are one or more issues/parts with a status of 'Claimed'",
"MessageDetail": null,
"StackTrace": null,
"InnerException": null,
"Data": null
}
Returns a result object with a success or failure message (Message) and if predict issue process should be initiated or not (PredictIssues).
{
"Succeeded": true,
"PredictIssues": true
}
| Code | Description |
|---|---|
| 200 | OK. Success |
| 400 |
FAILURE.
|
Permission IDs found here.
CR_AccessSerials_Allow (),
CR_SerialCopyRecords_Access (based on owner ID),
CR_SerialCopyRecords_Modify (based on owner ID)