2 Layout endpoints
Tim Svensson edited this page 2026-05-11 11:43:44 +00:00

Layout endpoints

POST /layout/getSpecificLayout

Path to endpoint

POST /layout/getSpecificLayout

Required values

  • UserID: user id
  • ID: layout id

Return values

Returns JSON layout data.

When no error occurs

  • Returns the requested layout
  • Status: 200 OK

When error occurs

  • Layout not found or request failed
  • Status: 404 Not Found

POST /layout/getFavoriteLayout

Path to endpoint

POST /layout/getFavoriteLayout

Required values

  • userId: user id

Return values

Returns JSON layout data.

When no error occurs

  • Returns the user's favorite layout
  • Status: 200 OK

When error occurs

  • Favorite layout not found or request failed
  • Status: 404 Not Found

POST /layout/getLayoutNameAndID

Path to endpoint

POST /layout/getLayoutNameAndID

Required values

  • userId: user id

Return values

Returns JSON containing layout names and layout ids.

When no error occurs

  • Returns layout names and ids for the user
  • Status: 200 OK

When error occurs

  • Layouts not found or request failed
  • Status: 404 Not Found

POST /layout/saveSpecificLayout

Path to endpoint

POST /layout/saveSpecificLayout

Required values

  • UserID: user id
  • ID: layout id
  • JsonPayload: layout data to save

Return values

Returns JSON result from the save operation.

When no error occurs

  • Saves/updates the specific layout
  • Status: 200 OK

When error occurs

  • Layout could not be saved or request failed
  • Status: 404 Not Found

POST /layout/saveNewLayout

Path to endpoint

POST /layout/saveNewLayout

Required values

  • UserID: user id
  • Name: name of the new layout
  • JsonPayload: layout data to save

Return values

Returns JSON result from the save operation.

When no error occurs

  • Saves a new layout
  • Status: 200 OK

When error occurs

  • New layout could not be saved or request failed
  • Status: 404 Not Found