Patron Genders

Get Patron Gender

GET /api/.../patrongenders/{id}

Return an individual Patron Gender.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique Id assigned to patron gender.

Response Information

Example
application/json, text/json 
{
    "GenderID": 2,
    "Description": "Female"
}

List of Patron Genders

GET /api/.../patrongenders/organizations/orgid={orgid}

Return a list of all genders for an individual organization.

GET /api/.../patrongenders/organizations/orgid={orgid}?patronid={patronid}&includeAll=false&includeEmptyObject=true

Return a list of all genders for an individual organization which are visible. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
orgid Integer yes Filter by organization Id.
patronid Integer No Get the gender associated with the specified patron (in case the specified organization is hiding it).
includeEmptyObject Boolean No Set to 'true' to return an empty object with GenderID 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.
includeAll Boolean No Set to 'false' to only include genders visible for the current org.

Response Information

Example
application/json, text/json 
[
  {
    "OrganizationID": 0,
    "GenderID": 0,
    "Display": false,
    "DisplayOrder": 0,
    "Description": "(None)"
  },
  {
    "OrganizationID": 5,
    "GenderID": 1,
    "Display": true,
    "DisplayOrder": 1,
    "Description": "N/A"
  },
  {
    "OrganizationID": 5,
    "GenderID": 2,
    "Display": true,
    "DisplayOrder": 2,
    "Description": "Female"
  },
  {
    "OrganizationID": 5,
    "GenderID": 3,
    "Display": true,
    "DisplayOrder": 3,
    "Description": "Male"
  },
  {
    "OrganizationID": 5,
    "GenderID": 4,
    "Display": true,
    "DisplayOrder": 5,
    "Description": "testA"
  },
  {
    "OrganizationID": 5,
    "GenderID": 10,
    "Display": false,
    "DisplayOrder": 6,
    "Description": "testE"
  }
]