Metadata Object

The metadata object is used in the /v6/bibs/metadata, /v6invoices/metadata, and v6patrons/metadata endpoints. For information about these endpoints, see The Bib API, The Invoice API, and The Patron API - Patron Record.

Click the links below to view the metadata object properties and examples. The examples show the bibs, invoices, and patrons JSON returns using the metadata endpoint.

field

string (optional)

Name of the metadata

Example: 

"field": "materialType"

values

array (optional)

The values property contains a MetaData array consisting of the MatadataValue code and description.

Example: 

"MetadataValue": {
  "code": "a",
  "desc": "books"
}

code

string

The fieldccode.

Example: 

"code": "a"

desc

string (optional)

The field description.

Example: 

"desc": "books"

The preceding list order reflects the sequence in which the data returns.

The following is an example of a JSON return by a call to GET /v6/bibs/metadata with no parameters provided.

[
  {
    "field": "materialType",
    "values": [
      {
        "code": "a",
        "desc": "books"
      },
      {
        "code": "c",
        "desc": "audio cds"
      }
    ]
  }
]

The following is an example of a JSON return by a call to GET /v6/invoices/metadata with no parameters provided.

[
  {
    "field": "useTax",
    "values": [
      {
        "code": "a",
        "desc": "7.75"
      },
      {
        "code": "b",
        "desc": "0.0"
      }
    ]
  }
]

The following is an example of a JSON return by a call to GET /v6/patrons/metadata with no parameters provided:

[
  {
    "field": "patronType",
    "values": [
      {
        "id": "0",
        "desc": "Adult 21 day"
      },
      {
        "id": "1",
        "desc": "Non-Circulating"
      }
    ]
  },
  {
    "field": "pcode1",
    "values": [
      {
        "id": "-",
        "desc": ""
      },
      {
        "id": "f",
        "desc": "Female"
      }
    ]
  },
  {
    "field": "pcode2",
    "values": [
      {
        "id": "-",
        "desc": ""
      },
      {
        "id": "a",
        "desc": "<1920"
      }
    ]
  }, 
  {
    "field": "pcode3",
    "values": [
      {
        "id": "0",
        "desc": "45305"
      }, 
      {
        "id": "1",
        "desc": "45385"
      }
    ]
  }, 
  {
    "field": "mBlock",
    "values": [
      {
        "id": "e",
        "desc": "Verify email"
      }, 
      {
        "id": "a",
        "desc": "Verify address"
      }
    ]
  }, 
  {
    "field": "pMessage",
    "values": [
      {
        "code": "c",
        "desc": "limit 10 items"
      }, 
      {
        "code": "-",
        "desc": "no message"
      }
    ]
  }, 
  {
    "field": "homeLibraryCode",
    "values": [
      {
        "code": "LN005",
        "desc": "Library Name"
      }, 
      {
        "code": "LN019",
        "desc": "Library Name Other"
      }
    ]
  }, 
  {
    "field": "langPref",
    "values": [
      {
        "code": "eng",
        "desc": "english"
      }, 
      {
        "code": "fra",
        "desc": "french"
      }
    ]
  }
]