Loan Period Codes

Get Loan period Code

GET /api/.../loanperiodcodes/{id}

Return an individual LoanPeriodCode.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique Id assigned to loan period code.

Response Information

Example
application/json, text/json 
{
    "LoanPeriodCodeID":5,
    "Description":"New Video"
}

List Of Loan Period Codes

GET /api/.../loanperiodcodes

Return a list of all loan period codes in the system.

GET /api/.../loanperiodcodes?includeEmptyObject=true

Return a list of all loan period codes. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
includeEmptyObject Boolean No Set to 'true' to return an empty object with LoanPeriodCodeID set to '0' and Description set to '(none)'. This may be used when populating a listbox for a user selection.

Response Information

Example
application/json, text/json 
[
    {
    "LoanPeriodCodeID":0,
    "Description":"(None)"
    },
    {
    "LoanPeriodCodeID":14,
    "Description":"10 hours"
    },
    {
    "LoanPeriodCodeID":1,
    "Description":"Audiobook"
    },
    {
    "LoanPeriodCodeID":2,
    "Description":"Audiobook - Short Loan"
    },
    {
    "LoanPeriodCodeID":3,
    "Description":"Music"
    },
    {
    "LoanPeriodCodeID":4,
    "Description":"New Book"
    },
    {
    "LoanPeriodCodeID":5,
    "Description":"New Video"
    },
    {
    "LoanPeriodCodeID":6,
    "Description":"No Loan"
    },
    {
    "LoanPeriodCodeID":7,
    "Description":"Overnight"
    },
    {
    "LoanPeriodCodeID":8,
    "Description":"Short"
    },
    {
    "LoanPeriodCodeID":9,
    "Description":"Standard"
    },
    {
    "LoanPeriodCodeID":13,
    "Description":"Test IHLS Ticket"
    },
    {
    "LoanPeriodCodeID":11,
    "Description":"Test Loan Period"
    },
    {
    "LoanPeriodCodeID":12,
    "Description":"Test Loan Period 2"
    },
    {"LoanPeriodCodeID":10,
    "Description":"Video"
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request