/
GET ALL Spaces

GET ALL Spaces

REQUEST

HTTP ELEMENT

Value

HTTP ELEMENT

Value

URI

/rest/crud/1.0/spaces

METHOD

GET

QueryParams

item-per-page - limit of item per page - DEFAULT: 100

page-index - what page to display identified by a number, starts with 1 - DEFAULT: 1

?item-per-page=25&page-index=2 //this will display items: 26 to 50 if total rows count is 125

RESPONSE

HTTP STATUS CODE

RESPONSE BODY

HTTP STATUS CODE

RESPONSE BODY

200

currentItemCount - number of rows/item returned

itemsPerPage - number of rows per page, value will always the same as query string “item-per-page”

startIndex - index of the first row returned.

totalItems - total rows counts

pageIndex - index of the current page, value will always the same as query string “page-index”

totalPages - total number of page

data - returned result set

400

error - main category of the error

message - error message

SCENARIO AND POSSIBLE RESPONSE

SCENARIO

RESPONSE

SCENARIO

RESPONSE

POSITIVE

{ "currentItemCount": 1, "itemsPerPage": 100, "startIndex": 1, "totalItems": 1, "pageIndex": 1, "totalPages": 1, "data": [ { "name": "1Albay", "key": "1Albay", "status": "ARCHIVED" } ] }