Skip to main content

FavoritesItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200
Example: 200
results object

Represents a 'Favorite' within the system.

This marks an Entry Screen column value as a favorite so it appears at the top of selection lists.

Accessible in the UI from the Profile menu (upper right) > My Favorites.

base_tableFavoritesTablesEnum (string)

The name of the base Entry Column value table that this favorite is associated with.

Possible values: [projects, groups, codes_tasks, codes_pay_types, codes_bill_types, codes_time_4, codes_time_5, codes_time_6, codes_time_7, codes_expenses, codes_expense_sources, codes_currencies, codes_expense_4, codes_expense_5, codes_expense_6, codes_expense_7, codes_travel_reasons, codes_travel_vehicles, codes_travel_measurements, codes_custom_4, codes_custom_5, codes_custom_6, codes_custom_7]

Example: projects
id_codestring

The ID of the Entry Column value from tablename being favorited.

Example: 1F9E41337EA341219D9D1D023F1D8C24
id_userstring

The ID of the user who owns this favorite.

Example: 64BBA147B9AC41D9978062300826C89F
tablenamestring

The name of the favorites table this favorite is saved in.

Example: projects_favorites
uristring

The URI of the favorite.

Example: /api/v1/favorites/user/64BBA147B9AC41D9978062300826C89F/projects/1F9E41337EA341219D9D1D023F1D8C24
successboolean

Indicates whether the request was successful (normally true if it's not an error response)

Default value: true
uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users
FavoritesItemResponse
{
  "response_code": 200,
  "results": {
    "base_table": "projects",
    "id_code": "1F9E41337EA341219D9D1D023F1D8C24",
    "id_user": "64BBA147B9AC41D9978062300826C89F",
    "tablename": "projects_favorites",
    "uri": "/api/v1/favorites/user/64BBA147B9AC41D9978062300826C89F/projects/1F9E41337EA341219D9D1D023F1D8C24"
  },
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users"
}