Pick up branches for hold request

Get pick up branches

GET /api/.../circulation/pickupbranch/{id}?usemodifyperm=true;

Return list of valid hold request pick up branches. These objects has values for OrganizationID and Name.

Note: If the user does not have permission to set any pickup branches, then the API will return all branches, based upon existing native staff client behavior. Adding and updating a hold request will ultimately verify override permissions with the pickup branch. This was done to ensure a valid list of pickup branches will be available.

Request Information

Parameters
Name Type Required Description
id Integer Yes Filter by organization Id.
usemodifyperm Boolean No Indicates whether Hold Requests Modify permission should be used for filtering. Defaults to Hold Requests Create permission.

Response Information

Example
application/json, text/json 
[
    {
        "OrganizationID":3,
        "ParentOrganizationID":null,
        "OrganizationCodeID":0,
        "Name":"Amsterdam Free Library",
        "Abbreviation":null,
        "SA_ContactPersonID":0,
        "CreatorID":0,"ModifierID":null,
        "CreationDate":null,
        "ModificationDate":null,
        "DisplayName":null
    },
    {   
        "OrganizationID":5,
        "ParentOrganizationID":null,
        "OrganizationCodeID":0,
        "Name":"Argyle Free Library",
        "Abbreviation":null,
        "SA_ContactPersonID":0,
        "CreatorID":0,
        "ModifierID":null,
        "CreationDate":null,
        "ModificationDate":null,
        "DisplayName":null
    }
]

HTTP Response Codes

Code Description
200 OK. Success