Validate Enumeration

Validate Enumeration

POST /api/.../serialissueenumeration

Validate Enumeration

Request Information

Parameters
Name Type Required Description
DtoSerialIssueRecordEnumeration Serial issue Enumeration Information Yes Define this parameter in the request body.
validateOnly boolean No Flag indicating execution will only validate the data. When set to true, the data is validated without persisting to the database. Default is true if not specified.
DtoSerialIssueRecordEnumeration
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.
Example
application/json, text/json 
 Invalid data:
 { 
        "LevelNum": 1,
        "IsAlter": false,
        "EnumCap": "cap1",
        "FormatID": 1,
        "BibUnits": 0,
        "NumSchemeID": 2,
        "EnumValue": "A" 
}

 Valid data:
 { 
        "LevelNum": 1,
        "IsAlter": false,
        "EnumCap": "cap1",
        "FormatID": 3,
        "BibUnits": 0,
        "NumSchemeID": 2,
        "EnumValue": "A" 
}

Response Information

Error information is returned if validation fails
    {
        "Success": false,
        "Message": "Enter the Start value in Arabic numbers, without punctuation,  when the enumeration format is equal to Number, Numeral or Roman."
    }

Returns a result object with a success or failure message (Message).

Example for Success
application/json, text/json 
{
  "Success": true,
  "Message": null
}

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid enumeration information