MARCcat API documentation version v1.4

https://github.com/folio-org/mod-marccat

MARCcat API

This documents the API calls for interacting with an marc authority or bibliographic record

/marccat

get delete put

get post

Collection of mergedSearch items.

get

Return a list of marc records and search metadata

post

Create a new mergedSearch item.

Create a new mergedSearch item.

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query’s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query’s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

Example:

{
  "results": [
    {
      "searchingView": 1,
      "displayQuery": "na \"manzoni\"",
      "from": 1,
      "to": 1,
      "numFound": 1271,
      "docs": [
        {
          "recordView": 1,
          "countDoc": 0,
          "queryForAssociatedDoc": null,
          "tagHighlighted": "100, 245",
          "data": {
            "leader": "00000nam  2200000 i 4500",
            "fields": [
              {
                "001": "000006570036"
              },
              {
                "005": "20170216093555.0"
              },
              {
                "008": "170216s19uu    gw     e      000 0 ger c"
              },
              {
                "040": {
                  "subfields": [
                    {
                      "a": "IT-TrCB"
                    },
                    {
                      "b": "ita"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "300": {
                  "subfields": [
                    {
                      "a": "440 p."
                    },
                    {
                      "c": "20 cm"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "082": {
                  "subfields": [
                    {
                      "a": "853.7"
                    },
                    {
                      "2": "22"
                    }
                  ],
                  "ind1": "0",
                  "ind2": " "
                }
              },
              {
                "997": {
                  "subfields": [
                    {
                      "a": "CBT-1-dv-ath-ma"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "700": {
                  "subfields": [
                    {
                      "a": "Langen, Adolf"
                    },
                    {
                      "t": "rl. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "700": {
                  "subfields": [
                    {
                      "a": "Bülow, Eduard von"
                    },
                    {
                      "t": "rl. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "100": {
                  "subfields": [
                    {
                      "a": "Manzoni, Alessandro"
                    },
                    {
                      "a": "ut. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "245": {
                  "subfields": [
                    {
                      "a": "Die Verlobten :"
                    },
                    {
                      "b": "eine mailänder Geschichte /"
                    },
                    {
                      "c": "von Alessandro Manzoni ; nach Eduard von Bülows uebersetzung neu bearbeitet von Adolf Langen"
                    }
                  ],
                  "ind1": "0",
                  "ind2": "4"
                }
              },
              {
                "260": {
                  "subfields": [
                    {
                      "a": "Berlin :"
                    },
                    {
                      "b": "Schreitersche Verlagshandlung,"
                    },
                    {
                      "c": "[19--?]"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

  • Location: required(string)

    URI to the created mergedSearch item

Body

Media type: application/json

Type: any

Example:

{
  "results": [
    {
      "searchingView": 1,
      "displayQuery": "na \"manzoni\"",
      "from": 1,
      "to": 1,
      "numFound": 1271,
      "docs": [
        {
          "recordView": 1,
          "countDoc": 0,
          "queryForAssociatedDoc": null,
          "tagHighlighted": "100, 245",
          "data": {
            "leader": "00000nam  2200000 i 4500",
            "fields": [
              {
                "001": "000006570036"
              },
              {
                "005": "20170216093555.0"
              },
              {
                "008": "170216s19uu    gw     e      000 0 ger c"
              },
              {
                "040": {
                  "subfields": [
                    {
                      "a": "IT-TrCB"
                    },
                    {
                      "b": "ita"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "300": {
                  "subfields": [
                    {
                      "a": "440 p."
                    },
                    {
                      "c": "20 cm"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "082": {
                  "subfields": [
                    {
                      "a": "853.7"
                    },
                    {
                      "2": "22"
                    }
                  ],
                  "ind1": "0",
                  "ind2": " "
                }
              },
              {
                "997": {
                  "subfields": [
                    {
                      "a": "CBT-1-dv-ath-ma"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              },
              {
                "700": {
                  "subfields": [
                    {
                      "a": "Langen, Adolf"
                    },
                    {
                      "t": "rl. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "700": {
                  "subfields": [
                    {
                      "a": "Bülow, Eduard von"
                    },
                    {
                      "t": "rl. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "100": {
                  "subfields": [
                    {
                      "a": "Manzoni, Alessandro"
                    },
                    {
                      "a": "ut. "
                    }
                  ],
                  "ind1": "1",
                  "ind2": " "
                }
              },
              {
                "245": {
                  "subfields": [
                    {
                      "a": "Die Verlobten :"
                    },
                    {
                      "b": "eine mailänder Geschichte /"
                    },
                    {
                      "c": "von Alessandro Manzoni ; nach Eduard von Bülows uebersetzung neu bearbeitet von Adolf Langen"
                    }
                  ],
                  "ind1": "0",
                  "ind2": "4"
                }
              },
              {
                "260": {
                  "subfields": [
                    {
                      "a": "Berlin :"
                    },
                    {
                      "b": "Schreitersche Verlagshandlung,"
                    },
                    {
                      "c": "[19--?]"
                    }
                  ],
                  "ind1": " ",
                  "ind2": " "
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to add mergedSearch -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create mergedSearch -- unauthorized

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get delete put

Entity representing a searchVertical

get

Return a list of marc records in text formats

delete

Delete searchVertical item with given {searchVerticalId}

put

Update searchVertical item with given {searchVerticalId}

get delete put

Entity representing a searchAuth

get

Return a list of marc authority records and search metadata

delete

Delete searchAuth item with given {searchAuthId}

put

Update searchAuth item with given {searchAuthId}

post get delete put

Entity representing a authority-record

post

Create authority record

get

Retrieve authority-record item with given {authority-recordId}

delete

Delete authority-record item with given {authority-recordId}

put

Update authority-record item with given {authority-recordId}

Create authority record

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 201

Authority created

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Required String parameter 'lang' is not present

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Error in validation

post get

Collection of authority-record items.

post

Get authority record

get

Retrieve a list of authority-record items.

Get authority record

URI Parameters

  • idRecord: required(string)

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 200

Return an authority record

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Required String parameter 'lang' is not present

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Error in validation

Retrieve a list of authority-record items.

URI Parameters

  • idRecord: required(string)

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 200

Returns a list of authority-record items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

Example:

{
  "authorityRecord": {
    "id": 282,
    "canadianContentIndicator": "0",
    "verificationLevel": "1",
    "leader": {
      "code": "000",
      "value": "00000nz   2200000n  4500"
    },
    "fields": [
      {
        "code": "001",
        "mandatory": true,
        "fieldStatus": "unchanged",
        "fixedField": {
          "keyNumber": 0,
          "categoryCode": 1,
          "headerTypeCode": 11,
          "code": "001",
          "displayValue": "000000000282",
          "sequenceNumber": 0,
          "attributes": {
            
          }
        },
        "added": false
      },
      {
        "code": "005",
        "mandatory": false,
        "fieldStatus": "unchanged",
        "fixedField": {
          "keyNumber": 0,
          "categoryCode": 1,
          "headerTypeCode": 12,
          "code": "005",
          "displayValue": "20201014123504.715",
          "sequenceNumber": 0,
          "attributes": {
            
          }
        },
        "added": false
      },
      {
        "code": "008",
        "mandatory": true,
        "fieldStatus": "unchanged",
        "fixedField": {
          "keyNumber": 0,
          "categoryCode": 1,
          "headerTypeCode": 10,
          "code": "008",
          "displayValue": "201001 n acanaaabn           n aaa     d",
          "sequenceNumber": 0,
          "attributes": {
            
          }
        },
        "added": false
      },
      {
        "code": "040",
        "mandatory": true,
        "fieldStatus": "unchanged",
        "variableField": {
          "keyNumber": 0,
          "categoryCode": 1,
          "headingTypeCode": "1",
          "itemTypeCode": "-1",
          "functionCode": "-1",
          "ind1": " ",
          "ind2": " ",
          "code": "040",
          "displayValue": "aSCAbeng",
          "subfields": [],
          "sequenceNumber": 0,
          "skipInFiling": 0
        },
        "added": false
      },
      {
        "code": "100",
        "mandatory": false,
        "fieldStatus": "unchanged",
        "variableField": {
          "keyNumber": 0,
          "categoryCode": 2,
          "headingTypeCode": "2",
          "itemTypeCode": "3",
          "functionCode": "-1",
          "ind1": "1",
          "ind2": " ",
          "code": "100",
          "displayValue": "aIbaiScanbit2",
          "subfields": [],
          "sequenceNumber": 0,
          "skipInFiling": 0
        },
        "added": false
      },
      {
        "code": "400",
        "mandatory": false,
        "fieldStatus": "unchanged",
        "variableField": {
          "keyNumber": 0,
          "categoryCode": 2,
          "headingTypeCode": "2",
          "itemTypeCode": "5",
          "functionCode": "2",
          "ind1": "3",
          "ind2": " ",
          "code": "400",
          "displayValue": "wnaxnaScanbit",
          "subfields": [],
          "sequenceNumber": 0,
          "skipInFiling": 0
        },
        "added": false
      },
      {
        "code": "400",
        "mandatory": false,
        "fieldStatus": "unchanged",
        "variableField": {
          "keyNumber": 0,
          "categoryCode": 2,
          "headingTypeCode": "2",
          "itemTypeCode": "3",
          "functionCode": "2",
          "ind1": "1",
          "ind2": " ",
          "code": "400",
          "displayValue": "aVitoria",
          "subfields": [],
          "sequenceNumber": 0,
          "skipInFiling": 0
        },
        "added": false
      },
      {
        "code": "670",
        "mandatory": false,
        "fieldStatus": "unchanged",
        "variableField": {
          "keyNumber": 51,
          "categoryCode": 7,
          "headingTypeCode": "21",
          "itemTypeCode": "-1",
          "functionCode": "-1",
          "ind1": " ",
          "ind2": " ",
          "code": "670",
          "displayValue": "aEmpresa",
          "subfields": [],
          "sequenceNumber": 0,
          "skipInFiling": 0
        },
        "added": false
      }
    ],
    "recordView": -1
  }
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

unable to list authority-record -- malformed parameter 'query', syntax error at column 6

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

get

Collection of from-template items.

get

Get authority record template

Get authority record template

URI Parameters

  • idTemplate: required(string)

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 200

Return an authority template

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

Example:

{
  "id": 362,
  "canadianContentIndicator": "0",
  "verificationLevel": "1",
  "leader": {
    "code": "000",
    "value": "00215nz   2200097n  4500"
  },
  "fields": [
    {
      "code": "001",
      "mandatory": true,
      "fieldStatus": "unchanged",
      "fixedField": {
        "keyNumber": 0,
        "categoryCode": 1,
        "headerTypeCode": 11,
        "code": "001",
        "displayValue": "00000000362",
        "sequenceNumber": 0,
        "attributes": {
          
        }
      },
      "added": false
    },
    {
      "code": "005",
      "mandatory": true,
      "fieldStatus": "unchanged",
      "fixedField": {
        "categoryCode": 1,
        "description": "046 Special Coded Dates",
        "headerTypeCode": 12,
        "code": "005",
        "displayValue": "20201026102004.",
        "sequenceNumber": 0,
        "attributes": {
          
        }
      },
      "added": false
    },
    {
      "code": "008",
      "mandatory": true,
      "fieldStatus": "unchanged",
      "fixedField": {
        "keyNumber": 0,
        "categoryCode": 1,
        "headerTypeCode": 10,
        "code": "008",
        "displayValue": "201026 n acanaaabn           n aaa     u",
        "dateEnteredOnFile": "201026",
        "sequenceNumber": 0,
        "attributes": {
          "dateEnteredOnFile": "201026"
        }
      },
      "added": false
    },
    {
      "code": "040",
      "mandatory": true,
      "fieldStatus": "unchanged",
      "variableField": {
        "keyNumber": 0,
        "categoryCode": 1,
        "headingTypeCode": "1",
        "itemTypeCode": "-1",
        "functionCode": "-1",
        "ind1": " ",
        "ind2": " ",
        "code": "040",
        "displayValue": "\u001faSCA\u001fbeng",
        "subfields": [],
        "sequenceNumber": 0,
        "skipInFiling": 0
      },
      "added": false
    }
  ],
  "recordView": 0
}

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Required String parameter 'lang' is not present

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Error in validation

post get

Collection of fixed-field-display-value items.

post

Change the display value for 008 tag

get

Retrieve a list of fixed-field-display-value items.

Change the display value for 008 tag

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 201

Display value for 008 changed

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Required String parameter 'lang' is not present

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Error in validation

post get

Collection of auth-fixed-fields-code-group items.

post

Get authority control fields values

get

Retrieve a list of auth-fixed-fields-code-group items.

Get authority control fields values

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

HTTP status code 200

Return the fixed values for authority

HTTP status code 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Required String parameter 'lang' is not present

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Error in validation

get

Collection of auth-header-type items.

get

Get the value for the header type of 008 authority tag