SA Display Options

Fetch SA check out listview display options by organization ID

GET /api/.../displayoptions/checkoutheader?orgid={id}

This method retrieves the check out header columns specified in SA for the organization.

Request Information

Parameters
Name Type Required Description
orgid Integer No Return default values for a specific organization. If not supplied, the base URL's logged on organization ID will be used.

Response Information

Returns the list of column headers defined in SA for check out.
Properties
Property Type Nullable Description
OptionId Int No Internal column header identifier.
OptionName String No Column header value.
SequenceNumber Int No Defines the order in which the columns are to be displayed. If zeros, order is determined by OptionId.
Possible Values
OptionID OptionName
1 Barcode
2 Due Date
3 Action
4 Title
5 Material Type
6 Call Number
7 Assigned Branch
8 Shelf Location
Example
application/json, text/json 
[
    {
        "OptionId": 1,
        "OptionName": "Barcode",
        "SequenceNumber": 1
    },
    {
        "OptionId": 2,
        "OptionName": "Due Date",
        "SequenceNumber": 2
    },
    {
        "OptionId": 4,
        "OptionName": "Title",
        "SequenceNumber": 3
    }
]

HTTP Response Codes

Code Description
200 OK. Success
404 Not found. Invalid organization ID

Fetch SA normal check in listview display options by organization ID

GET /api/.../displayoptions/normalcheckinheader?orgid={id}

This method retrieves the normal check in header columns specified in SA for the organization.

Request Information

Parameters
Name Type Required Description
orgid Integer No Return default values for a specific organization. If not supplied, the base URL's logged on organization ID will be used.

Response Information

Returns the list of column headers defined in SA for check in.
Properties
Property Type Nullable Description
OptionId Int No Internal column header identifier.
OptionName String No Column header value.
SequenceNumber Int No Defines the order in which the columns are to be displayed. If zeros, order is determined by OptionId.
Possible Values
OptionID OptionName
0 Title
1 Material Type
2 Shelf Location
3 Call Number
4 Patron Name
5 Assigned Branch
6 Collection
Example
application/json, text/json 
[
    {
        "OptionId": 0,
        "OptionName": "Title",
        "SequenceNumber": 1
    },
    {
        "OptionId": 3,
        "OptionName": "Call Number",
        "SequenceNumber": 2
    },
    {
        "OptionId": 4,
        "OptionName": "Patron Name",
        "SequenceNumber": 3
    }
]

HTTP Response Codes

Code Description
200 OK. Success
404 Not found. Invalid organization ID

Fetch SA bulk check in listview display options by organization ID

GET /api/.../displayoptions/bulkcheckinheader?orgid={id}

This method retrieves the bulk check in header columns specified in SA for the organization.

Request Information

Parameters
Name Type Required Description
orgid Integer No Return default values for a specific organization. If not supplied, the base URL's logged on organization ID will be used.

Response Information

Returns the list of column headers defined in SA for check in.
Properties
Property Type Nullable Description
OptionId Int No Internal column header identifier.
OptionName String No Column header value.
SequenceNumber Int No Defines the order in which the columns are to be displayed. If zeros, order is determined by OptionId.
Possible Values
OptionID OptionName
0 Title
1 Material Type
2 Shelf Location
3 Call Number
4 Patron Name
5 Assigned Branch
6 Collection
Example
application/json, text/json 
[
    {
        "OptionId": 0,
        "OptionName": "Title",
        "SequenceNumber": 1
    },
    {
        "OptionId": 3,
        "OptionName": "Call Number",
        "SequenceNumber": 2
    },
    {
        "OptionId": 4,
        "OptionName": "Patron Name",
        "SequenceNumber": 3
    }
]

HTTP Response Codes

Code Description
200 OK. Success
404 Not found. Invalid organization ID