Collections

List Collections

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

Return a list of all collections for an individual organization.

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

Return a list of all collection for an individual organization. Include the '(none)' entry for a user listbox or combobox. If 'includeABR' set to true, return a list of all collections for an individual organization with collection name includes abbreviation in parenthesis.

Request Information

Parameters
Name Type Required Description
orgid Integer Yes Filter by organization Id. Providing 0 will return a list of all unique collections
includeEmptyObject Boolean No Set to 'true' to return an empty object with CollectionID set to '0' and Name set to '(none)'. This may be used when populating a listbox for a user selection. Must be used with the orgid parameter.
includeABR Boolean No Set to 'true' to returns collection name includes abbreviation in parenthesis.'. Must be used with the orgid parameter.

Response Information

Example
application/json, text/json 
[
    {
        "CollectionID":222,
        "Name":"  space in name test (  spnt)",
        "Abbreviation":"  spnt"
    },
    {
        "CollectionID":220,
        "Name":"VHS (Juv)  (VHS-Juv)",
        "Abbreviation":"VHS-Juv"
    }
 ]

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request
404 Invalid organization ID