GET Visibility Options as Select List

Overview

---

The following table contains information about the GET method in regards to the managing process, more precisely when you want to make a GET request that returns all the visibility options as select-list.

GET Visibility Options as Select List
Method	GET
URL or Endpoint	https://vp-api.gjirafa.tech/api/visibility-options/select-list
Headers	Authorization
Parameters	Not Applicable
Body	Not Applicable

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": [
    {
      "id": 1,
      "name": "Public",
      "iconPath": "https://vp.gjirafa.net/vps/statics/visibility-public.svg"
    },
    {
      "id": 2,
      "name": "Private",
      "iconPath": "https://vp.gjirafa.net/vps/statics/visibility-private.svg"
    },
    {
      "id": 3,
      "name": "Password Protected",
      "iconPath": "https://vp.gjirafa.net/vps/statics/visibility-password-protected.svg"
    }
  ],
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	Indicates whether the response is successful (true) or not (false).
errors	array[string]	Contains any errors that occurred during the request.
messages	array[string]	Contains any messages returned by the backend.
result	array[Object]	Contains the result objects detailing visibility options.
id	integer	The unique identifier for the visibility option.
name	string	The name of the visibility option (e.g., Public, Private, Password Protected).
iconPath	string	The URL path to the icon representing the visibility option.
resultInfo	null	Contains additional information about the result.
statusCode	integer($int32)	The HTTP status code returned by the request.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed