Workspace_logos

>>>

GET /api/v3/workspaces/workspace_logos
List of Workspace Logos. Last update: 16/10/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 11,
    "name": "NAME",
    "common_media_file": false,
    "media_type": "photo",
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/S3KEY.png",
    "file_size": "58.6 KB",
    "created_date": "12/26/22",
    "note": null,
    "is_cutout": false,
    "default_logo": true (NOTE: Added 16/10/23)
  },
  ...
]
>>>

POST /api/v3/workspaces/workspace_logos
Create Workspace Logo. Last update: 29/11/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "workspace_logo": {
    "name": "NAME",
    "s3_key": "S3KEY",
    "format_type": "png",
    "size": "60000",
    "location": signUpForm,
    ":is_cutout": false (NOTE: Added 29/11/23)
  }
}

Success response body ↑

{
  "id": 11,
  "name": "NAME",
  "common_media_file": false,
  "media_type": "photo",
  "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/S3KEY.png",
  "file_size": "58.6 KB",
  "created_date": "12/26/22",
  "note": null,
  "is_cutout": false,
  "default_logo": true (NOTE: Added 16/10/23)
}

Params

Param name Description
workspace_logo
required

Validations:

  • Must be a Hash
workspace_logo[name]
required

Validations:

  • Must be a String
workspace_logo[s3_key]
required

Validations:

  • Must be a String
workspace_logo[format_type]
required

Validations:

  • Must be a String
workspace_logo[size]
required

Validations:

  • Must be a Integer
workspace_logo[location]
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, templateBranding.
workspace_logo[is_cutout]
optional

Is this file cotout

Validations:

  • Must be one of: true, false, 1, 0.
>>>

PUT /api/v3/workspaces/workspace_logos/:id
Update Workspace Logo. Last update: 16/10/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "workspace_logo": {
    "default_logo": true
  }
}

Success response body ↑

[
  {
    "id": 11,
    "name": "NAME",
    "common_media_file": false,
    "media_type": "photo",
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/S3KEY.png",
    "file_size": "58.6 KB",
    "created_date": "12/26/22",
    "note": null,
    "is_cutout": false,
    "default_logo": true (NOTE: Added 16/10/23)
  },
  ...
]

Params

Param name Description
workspace_logo
required

Validations:

  • Must be a Hash
workspace_logo[default_logo]
required

Validations:

  • Must be one of: true, false, 1, 0.
>>>

DELETE /api/v3/workspaces/workspace_logos/:id
Destroy Workspace Logo. Last update: 16/10/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 11,
    "name": "NAME",
    "common_media_file": false,
    "media_type": "photo",
    "link_for_preview": "https://s3.amazonaws.com/gipper-college-logos-development/S3KEY.png",
    "file_size": "58.6 KB",
    "created_date": "12/26/22",
    "note": null,
    "is_cutout": false,
    "default_logo": true (NOTE: Added 16/10/23)
  },
  ...
]

Params

Param name Description
id
required

Validations:

  • Must be a Integer