Bibliographic Templates

Create Bibliographic Template

POST /api/.../templates/{objectid}

Creates a bibliographic template.

Parameters
Name Type Required Description
objectid Integer Yes ID of Object Type to create for: Bibliographic Template = 5.
Request body
An object of type DtoBibliographicTemplateData in the request body.
application/json, text/json 
{
    "Name": "On order Adult DVD (new)",
    "DisplayInPAC": false,
    "DoNotOverlay": true,
    "RecordOwnerID": 1,
    "OrganizationOwnerID": 1, //nullable
    "MARC21Record": {
        "leader": "     namb 22     5ub4500",
        "controlfields": [
             {
                "tag": "005",
                "data": "20250917093753.0",
             },
             {
                "tag": "008",
                "data": "200722s2020|||||||||||||||||||||||||||||",
             }
         ],
         "datafields": [
              {
                  "tag": "100",
                  "ind1": "1",
                  "ind2": "0",
                  "subfields": [
                      {
                          "code": "a",
                          "data": "100$a data"
                      }
                  ]
              }
        ]
    }               
}

Response Information

Recored ID of the new bibliographic template is returned upon success.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE due to invalid input or data validation.
403 Forbidden. Permission is denied.

Permission Required

Permission IDs found here.

   AccessCatalogingSubsystem_Allow

   BibliographicTemplates_Create (based on OrganizationOwnerID if available)

Update Bibliographic Template

PUT /api/.../templates/5/{id}

Update a bibliographic template.

Parameters
Name Type Required Description
id Integer Yes ID of Bibliographic Template to update.
Request body
An object of DtoBibliographicTemplateData in the request body.
application/json, text/json 
{
    "BibliographicTemplateID": "13",  
    "Name": "On order Adult DVD (widescreen)",
    "TagsModified": true, //nullable
    "DisplayInPAC": false,
    "DoNotOverlay": true,
    "RecordOwnerID": 1,
    "OrganizationOwnerID": 1, //nullable
    "MARC21Record": {
        "leader": "     namb 22     5ub4500",
        "controlfields": [
             {
                "tag": "005",
                "data": "20250917093753.0",
             },
             {
                "tag": "008",
                "data": "200722s2020|||||||||||||||||||||||||||||",
             }
         ],
         "datafields": [
              {
                  "tag": "245",
                  "ind1": "1",
                  "ind2": "0",
                  "subfields": [
                      {
                          "code": "a",
                          "data": "245$a data"
                      }
                  ]
              },
              {
                   "tag": "260",
                   "ind1": " ",
                   "ind2": " ",
                   "subfields": [
                       {
                           "code": "a"
                       }
                  ]
              }
        ]
    }               
}

Response Information

true is returned upon success.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE due to invalid input or data validation.
403 Forbidden. Permission is denied.
404 Invalid object ID
409 CONFLICT. Template is secured.

Permission Required

Permission IDs found here.

   AccessCatalogingSubsystem_Allow

   BibliographicTemplates_Modify (based on OrganizationOwnerID if available)

   UseOwnBibliographicTemplates_Allow (only if OrganizationOwnerID not available)

DtoBibliographicTemplateData

Property Type Nullable Description
BibliographicTemplateID Int32 N/A Required by PUT request but not by POST request.
Name String No  
TagsModified Boolean N/A Optional property for PUT request to indicate MARC21Record is dirty or not. Ignored by POST request.
DisplayInPAC Boolean No  
DoNotOverlay Boolean No  
RecordOwnerID Int32 No ID of record's Organization.
OrganizationOwnerID Int32 Yes Organization ID of template owner. If null, template owns by its creator.
MARC21Record Object No MARC21Record.leader must be 24-char long; MARC21Record.008 must be 40-char long;