Patron Codes

Get Patron Code

GET /api/.../patroncodes/{id}

Return a single patron code by code id.

Request Information

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

Response Information

Example
application/json, text/json 
{
    "PatronCodeID":1,
    "Description":"Regular"
}

HTTP Response Codes

Code Description
200 OK. Success

List Patron Codes

GET /api/.../patroncodes

Return a list of all patron codes in the system.

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

Return a list of patron codes that belong to a specific organization.

Request Information

Parameters
Name Type Required Description
orgid Integer No The unique id assigned to the organization. Used to filter the list.

Response Information

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

HTTP Response Codes

Code Description
200 OK. Success