Storage Group - GET

Storage Group - GET API Endpoint
StoRegister - Login

List of Storage Groups API

The list of storage groups, which represent different sizes available for storage, such as small, medium, large, etc.

GET
/v1/common/storage/group
Request Content Type
application/json
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

Response Payload:

  • succeeded boolean

    Indicates whether the request to retrieve storage group information was successful.

  • status string

    Describes the status of the request to retrieve storage group information.

  • data object

    Array containing storage group information.

  • pagination object

    Details about pagination, including current page number, total number of pages, and overall count of items.

  • errors array

    Holds any error information if applicable.

Storage Group Option Details

Details about the storage group option.

array data
  • id integer
    ID for the storage group.
  • name string
    Name of the storage group (e.g., "Extra Small", "Small", "Medium").

Request Header

Authorization: X-API-Key --api-key--

API Response

{

    "data": [
        {
            "id": 1,
            "name": "Extra Small"
        },
        {
            "id": 2,
            "name": "Small"
        },
        {
            "id": 3,
            "name": "Medium"
        },
        {
            "id": 4,
            "name": "Large"
        },
        {
            "id": 5,
            "name": "Extra Large"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageCount": 5,
        "totalCount": 5
    },
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation