Patron Stat Class Codes

Get Patron Stat Class Code

GET /api/.../patronstatclasscodes/{id}

Return a single patron stat class codes by code id.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron stat class code. Used to return a single object.

Response Information

Example
application/json, text/json 
{
  "StatisticalClassID": 1,
  "OrganizationID": 2,
  "Description": "sample string 3"
}

HTTP Response Codes

Code Description
200 OK. Success

List Patron Stat Class Codes

GET /api/.../patronstatclasscodes

Return a list of all patron codes in the system.

GET /api/.../patronstatclasscodes?orgid={orgid}

Return a list of patron stat class codes for a single organization id.

GET /api/.../patronstatclasscodes?orgid={orgid}&includeEmptyObject=true

Return a list of patron stat class codes for a single organization id. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
orgid Integer No The unique id assigned to the organization. Used to filter the list.
includeEmptyObject Boolean No Set to 'true' to return an empty object with StatisticalClassID set to '0' and Description set to '(none)'. This may be used when populating a listbox for a user selection. Must be used with the orgid parameter.

Response Information

Example
application/json, text/json 
[
  {
    "StatisticalClassID": 1,
    "OrganizationID": 2,
    "Description": "sample string 3"
  },
  {
    "StatisticalClassID": 1,
    "OrganizationID": 2,
    "Description": "sample string 3"
  },
  {
    "StatisticalClassID": 1,
    "OrganizationID": 2,
    "Description": "sample string 3"
  }
]

HTTP Response Codes

Code Description
200 OK. Success