Config

Retrieve a Entry Point

Get Entry Point.Retrieves the Entry Point with the given ID.

get/admin/config/entry-points/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/entry-points/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Entry Point.

Response

idnumber

ID of the Entry Point

modulestring required

Module name of the Entry Point

place''portal'' | 'portal' | 'admin' | 'mobile' required

Where the Entry Point placed

type'menu_link' | 'code' | 'action_link' | 'tab' required

Type of the Entry Point

size'extra_small' | 'small' | 'medium' | 'large' | 'extra_large' required

Modal window size. Used only for Entry Points with type action_link.

titlestring

Title of the Entry Point

rootstring

Root path to controller. Required only if type is not action_link. For mobile Entry Points use one of the dashboard section roots: mobile_dashboard_banners, mobile_dashboard_referral.

modelstring

Model for attaching given Entry Point. Required only for type action_link.

iconstring

Icon which shows in actions list or menu

backgroundstring

Background of menu link

urlstring

Url that will be opened by click of the Entry Point. Required only if type is not code.

codestring

Code of the Entry Point. Required only if type is code.

partnersstring[]

Partners IDs who have access to this Entry Point

namestring required

Name of the Entry Point

location'before_content' | 'after_content' required

Location where the Entry Point code placed.

orderinteger

Sort order of the Entry Point within its root. Used for mobile Entry Points, where it starts from 1 and, when omitted on save, is auto-filled with the next value after the highest existing order in the root (max + 1).

enabledboolean

The Entry Point is enabled?

location_geostring[]

Splynx locations for which this Entry Point is allowed.

payment_typestring[]

Payment methods for which this Entry Point is allowed.

payment_account_idstring

Payment account ID for which this Entry Point is allowed.

Example response

{
  "id": 1,
  "module": "splynx_paypal_addon",
  "place": "'portal'",
  "type": "action_link",
  "size": "large",
  "title": "Pay by Paypal",
  "root": "controllers\\portal\\DashboardController",
  "model": "Invoices",
  "icon": "fa-university",
  "background": "#d88386",
  "url": "/paypal/pay-invoice",
  "code": "",
  "partners": [],
  "name": "paypal_rb_invoice",
  "location": "after_content",
  "order": 0,
  "enabled": true,
  "location_geo": [],
  "payment_type": [],
  "payment_account_id": ""
}

Changes

No recorded changes to this operation across all 1 revision of this API.