API Reference - Users Portfolio Tags

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108069

← Back to API Reference | Getting Started

Users Portfolio Tags

Users Portfolio Tags associates text tags with individual portfolio photos uploaded by members. Each record links a tag string to a specific photo and user, enabling keyword-based discovery and filtering of portfolio content.

Model name in URL: users_portfolio_tags — DB table: users_portfolio_tags

The Users Portfolio Tags Object

FieldTypeDescription
tag_idintegerUnique portfolio tag record ID (primary key, read-only)
photo_idintegerID of the portfolio photo this tag is attached to (foreign key to users_portfolio)
tagstringThe tag text string (default empty string)
user_idintegerID of the member who owns this portfolio tag
rel_idintegerID of the related portfolio group or album record
rel_dbstringName of the related database/table for the portfolio group reference

List Users Portfolio Tag Records

GET /api/v2/users_portfolio_tags/get

Returns a paginated list of users portfolio tag records.

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_portfolio_tags/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "tag_id": "1",
      "photo_id": "10",
      "tag": "landscape",
      "user_id": "42",
      "rel_id": "5",
      "rel_db": "users_portfolio_groups"
    },
    {
      "tag_id": "2",
      "photo_id": "10",
      "tag": "architecture",
      "user_id": "42",
      "rel_id": "5",
      "rel_db": "users_portfolio_groups"
    }
  ],
  "total": "314",
  "current_page": 1,
  "total_pages": 13,
  "next_page": "MipfKjI1"
}

Retrieve a Users Portfolio Tag Record

GET /api/v2/users_portfolio_tags/get/{tag_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/users_portfolio_tags/get/1" \
  -H "X-Api-Key: your-api-key-here"
Known Issue: The single-record GET endpoint is not functional for this model due to a primary key configuration issue. Use the list endpoint with property=tag_id&property_value={id} to retrieve a specific record instead.

Expected Response Format

Copy
{
  "status": "success",
  "message": [
    {
      "tag_id": "1",
      "photo_id": "10",
      "tag": "landscape",
      "user_id": "42",
      "rel_id": "5",
      "rel_db": "users_portfolio_groups"
    }
  ],
  "total": "314",
  "current_page": 1,
  "total_pages": 314
}

Create a Users Portfolio Tag Record

POST /api/v2/users_portfolio_tags/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/users_portfolio_tags/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "photo_id=10" \
  -d "tag=landscape" \
  -d "user_id=1" \
  -d "rel_id=5" \
  -d "rel_db=users_portfolio_groups"

Example Response

Copy
{
  "status": "success",
  "message": {
    "tag_id": "315",
    "photo_id": "10",
    "tag": "landscape",
    "user_id": "1",
    "rel_id": "5",
    "rel_db": "users_portfolio_groups"
  }
}

Update a Users Portfolio Tag Record

PUT /api/v2/users_portfolio_tags/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/users_portfolio_tags/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "tag_id=1" \
  -d "tag=architecture"

Example Response

Copy
{
  "status": "success",
  "message": {
    "tag_id": "1",
    "photo_id": "10",
    "tag": "architecture",
    "user_id": "42",
    "rel_id": "5",
    "rel_db": "users_portfolio_groups"
  }
}

Delete a Users Portfolio Tag Record

DELETE /api/v2/users_portfolio_tags/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/users_portfolio_tags/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "tag_id=1"

Example Response

Copy
{
  "status": "success",
  "message": "users_portfolio_tags record was deleted"
}