Item block descriptions

Get Item Block

GET /api/.../itemblocks/{id}

Return a single item block.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the Item Block. Used to return a single object.

Response Information

Example
application/json, text/json 
{
    "ItemBlockID":1,
    "OrganizationID":3,
    "Description":"See Note",
    "SequenceID":1
}

HTTP Response Codes

Code Description
200 OK. Success

List of Item Blocks

GET /api/.../itemblocks

Return a list of all item blocks in the system.

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

Return a list of item blocks that belong to a specific organization.

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

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

Request Information

Parameters
Name Type Required Description
orgid Integer No The unique id assigned to the organization. Used to filter the list.
includeEmptyObject Boolean No Set to 'true' to return an empty object with ItemBlockID 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.

Response Information

Example
application/json, text/json 
[
    {
        "ItemBlockID":1,
        "OrganizationID":3,
        "Description":"See Note","SequenceID":1
    },
    {
        "ItemBlockID":2,
        "OrganizationID":3,
        "Description":"Check Contents",
        "SequenceID":2
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Invalid organization ID
404 FAILURE. Organization ID not found