Qodex.ai

List Floorplans

GET {{baseUrl}}/floorplans?page[number]=1&page[size]=20&filter[defaultFloorplan]=<boolean>&filter[isPartOfBuilding.data.id]=<string>&filter[representsFloor.data.id]=<string>&sort=-createdAt

List Floorplans, filtered by user provided parameters

Request Params

KeyDatatypeRequiredDescription
page[number]numberA cursor to the page number for use in “pagination linked list”
page[size]numberNumbers of items to return
filter[defaultFloorplan]stringDefault floorplan to return
filter[isPartOfBuilding.data.id]stringFilter by 'id' of isPartOfBuilding relationship
filter[representsFloor.data.id]stringFilter by 'id' of representsFloor relationship
sortstringSort by createdAt time

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans?page[number]=1\u0026page[size]=20\u0026sort=-createdAt&quot;,&quot;first&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans?page[number]=1\u0026page[size]=20\u0026sort=-createdAt&quot;,&quot;prev&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans?page[number]=1\u0026page[size]=20\u0026sort=-createdAt&quot;,&quot;next&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans?page[number]=1\u0026page[size]=20\u0026sort=-createdAt&quot;,&quot;last&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans?page[number]=1\u0026page[size]=20\u0026sort=-createdAt&quot;},&quot;data&quot;:[{&quot;attributes&quot;:{&quot;name&quot;:&quot;default&quot;,&quot;description&quot;:&quot;Default floorplan&quot;,&quot;defaultFloorplan&quot;:true,&quot;scale&quot;:0.2,&quot;unit&quot;:&quot;mm&quot;,&quot;northDirection&quot;:35.5},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;,&quot;meta&quot;:{&quot;createdAt&quot;:&quot;1958-01-21T09:47:46.721Z&quot;,&quot;updatedAt&quot;:&quot;1971-11-20T09:03:00.761Z&quot;,&quot;createdBy&quot;:&quot;Z0011111&quot;,&quot;updatedBy&quot;:&quot;Z0011111&quot;},&quot;type&quot;:&quot;Floorplan&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans/4fa85f64-6767-4562-c3fc-2c963f66afa6&quot;},&quot;relationships&quot;:{&quot;isPartOfBuilding&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;}},&quot;representsFloor&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;}}}},{&quot;attributes&quot;:{&quot;name&quot;:&quot;default&quot;,&quot;description&quot;:&quot;Default floorplan&quot;,&quot;defaultFloorplan&quot;:false,&quot;scale&quot;:0.2,&quot;unit&quot;:&quot;mm&quot;,&quot;northDirection&quot;:35.5},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;,&quot;meta&quot;:{&quot;createdAt&quot;:&quot;1946-08-23T20:53:16.283Z&quot;,&quot;updatedAt&quot;:&quot;2021-10-05T10:05:16.128Z&quot;,&quot;createdBy&quot;:&quot;Z0011111&quot;,&quot;updatedBy&quot;:&quot;Z0011111&quot;},&quot;type&quot;:&quot;Floorplan&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;/partitions/4fa85f64-8888-2222-c3fc-2c963f66afa6/floorplans/4fa85f64-6767-4562-c3fc-2c963f66afa6&quot;},&quot;relationships&quot;:{&quot;isPartOfBuilding&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;}},&quot;representsFloor&quot;:{&quot;data&quot;:{&quot;type&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;id&quot;:&quot;827d0ae5-6c62-42a7-9367-7aa95512823e&quot;}}}}]}