Return Headings Adjust Options

Identifies the available options for adjusting headings.

PUT /api/.../authorityrecords/headings?returnAdjustOptions=1&ids=&isBibliographic=

This API identifies the available options for adjusting headings in a list of authority records based on a specified MARC21 tag. It returns a list of DtoCheckHeadingsAuthorityData objects, excluding any authority records that are not Final.

Request Information

Parameters
Name Type Required Description
isBibliographic Boolean No Indicates MARC tag is from a Bibliographic record. Default to false if omitted.
returnAdjustOptions Integer Yes Indicates to return available adjust options of selected authority records. Possible value is 1.
ids Integer[] Yes List of Polaris record IDs of the selected authority records.
tag DtoMARCTag Yes MARC Tag that is expected to be adjusted by the headings' tags of the selected authority records.
DtoMARCTag
Name Type Description
TagID Integer DB id of the tag. 0 if tag is new.
SequenceNumber Integer Tag position within the MARC21 record.
TagNumber Integer MARC21 tag number.
IndicatorOne Char Indicator one
IndicatorTwo Char Indicator two
Subfields DtoMARCSubfield[] List of MARC21 subfields of the tag.
AssociatedAuthorityRecordID Integer Tag associated authority record ID.
EffectiveTagNumber Integer Effective tag number
BulkAddReportTag String Free text of tag data. For Bulk Add reporting only.
DtoMARCSubfield, see Get MARC Tag for more information.
Request body
Example
application/json, text/json 
        { 
            "TagID": 0,
            "SequenceNumber": 29,
            "TagNumber": 610,
            "IndicatorOne": "1",
            "IndicatorTwo": "2",
            "Subfields": [
                {
                    "BibliographicSubfieldID": 0,
                    "SequenceNumber": 0,
                    "SubfieldDesignator": "a",
                    "Data": "Tester subfield A",
                    "AuthorizingRecordID": null,
                    "NumberOfNonFilingCharacters": 0,
                    "Status": 3
                },
                {
                    "BibliographicSubfieldID": 0,
                    "SequenceNumber": 0,
                    "SubfieldDesignator": "c",
                    "Data": "Tester subfield C",
                    "AuthorizingRecordID": null,
                    "NumberOfNonFilingCharacters": 0,
                    "Status": 3
                }
            ],
            "AssociatedAuthorityRecordID": 0,
            "EffectiveTagNumber": 0,
            "TagStatus": 0,
            "BulkAddReportTag": null
        }

Response Information

DtoCheckHeadingsAuthorityData
Name Type Description
AuthorityRecordID Integer Authority record ID.
CanAdjustBib Boolean Indicates if its associated bib tag can be adjusted.
CanAdjustUsage Boolean Indicates if the usage of the authority record's first heading tag can be adjusted.
AuthorityControlHeadingText String Free text of headings tag data.
FlippedHeadingText String Free text of flipped tag data when CanAdjustBib is true.
Authority008AdjustmentText String Statement of how the authority record's usage will be adjusted. e.g., "008 Heading use, name: a - Appropriate"
Example
application/json, text/json 
[
    {
        "AuthorityRecordID": 123,
        "CanAdjustBib": true,
        "CanAdjustUsage": true,
        "AuthorityControlHeadingText": "130  0 ‡aScience experiments",
        "FlippedHeadingText": "630 00 ‡aScience experiments",
        "Authority008AdjustmentText": "008 Heading use, subject: a - Appropriate"
    },
    {
        "AuthorityRecordID": 286283,
        "CanAdjustBib": true,
        "CanAdjustUsage": false,
        "AuthorityControlHeadingText": "150    ‡aAuthors, English‡vPortraits",
        "FlippedHeadingText": "650  0 ‡aAuthors, English‡vPortraits",
        "Authority008AdjustmentText": ""
    },
    {
        "AuthorityRecordID": 925636,
        "CanAdjustBib": true,
        "CanAdjustUsage": false,
        "AuthorityControlHeadingText": "100 1  ‡aPeng Tester 800 a",
        "FlippedHeadingText": "600 10 ‡aPeng Tester 800 a",
        "Authority008AdjustmentText": ""
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Bad request
404 Not Found. If authority record not found by any of the ids received.