Portals (Lära and Via HTML)

Created by Miro Lagueux, Modified on Mon, 31 Aug at 10:55 AM by Miro Lagueux

TABLE OF CONTENTS

Portals: portal/get
Portals: portal/getlist
Portals: portal/create
Portals: portal/edit
Portal error code descriptions

PORTALS

"Portals" are the entry points to your environment: they determine the branding, the language, the catalogue and the account creation settings presented to users. A portal in the API is named "portal".

Portals: portal/get

https://www.domaine.com/lmsapi/portal/get

Returns all the information relating to a portal in your environment.
API call address : https://.../lmsapi/portal/get

Request

Example of request call content for information on a portal:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the portal. (String type)

Response

Example of response call content for information on a portal:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "title": {
    "texts": [{
        "text": "MonPortail",
        "languageId": 1
      }
    ]
  },
  "subTitle": {
    "texts": [{
        "text": "Mon sous-titre",
        "languageId": 1
      }
    ]
  },

  "description": {
    "texts": [{
        "text": "Ma description",
        "languageId": 1
      }
    ]
  },


  "newAccountButtonLabel": {
    "texts": [{
        "text": "Inscrivez-vous!",
        "languageId": 1
      }
    ]
  },


  "newAccountDescription": {
    "texts": [{
        "text": "Inscrivez-vous dès maintenant en remplissant le formulaire suivant : ",
        "languageId": 1
      }
    ]
  },


  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "coverID": 3,
  "allowNewAccount": false,
  "creationDate": "2018-01-01",
  "url": "siteUrl/monUrl",
  "name": "nom de portail",
  "dns": "mondns",
  "language": 1,
  "newUserLanguage": 1,
  "hasCustomLogo": false,
  "lastModificationDate": "2018-01-02",
  "defaultBranchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "isDefaultPortal": false,
  "displayType": 1,
  "createdByUserID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "keywords": "mot1,mot2,mot3",
  "seoDescription": "une description",
  "googleAnalyticsKey": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "providerFilter": false, 
  "languageFilter": false, 
  "isUsingCustomSupportInfo": true,
  "newAccountUrl": "",
  "isEmailValidatedByCode": true
}

Field descriptions

Name	Comments/description
id	Unique identifier of the portal (String type) This parameter must be empty when the method is used in creation mode, but is required to call it in edit mode.
title text languageId	text: Title of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
subTitle text languageId	text: Subtitle of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
description text languageId	text: Description of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newAccountButtonLabel text languageId	text: Label on the account creation button. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newAccountDescription text languageId	text: Label displayed before the account creation form. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
name	Name of the portal as seen by administration. (String type) This parameter is required in creation mode.
coverID	Identifier for the cover image of the portal. (Number type)
allowNewAccount	Authorization for new users to create an account (Boolean type)
defaultBranchID	Default branch for newly created accounts. (String type) allowNewAccount must be set to true for this field to apply.
branchID	Branch of the portal. (String type) This parameter is required in creation mode.
creationDate	Creation date of the portal Cannot be modified. Available in get and getlist.
url	URL of the portal. (String type) The client site URL will be concatenated when saving. This parameter is required in creation mode.
dns	DNS of the portal. (String type) Pass empty to remove.
language	Display language of the portal 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newUserLanguage	Default language for new users 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
hasCustomLogo	Indicates whether a custom logo has been assigned to the portal.
lastModificationDate	Date of the last modification of the portal Cannot be modified. Available in get and getlist.
isDefaultPortal	Indicates whether the portal is the default one. (Boolean type) Cannot be modified. Available in get and getlist.
displayType	Display type in the catalogues. 1 = Tile 2 = Calendar 3 = List (Number type)
createdByUserID	Identifier of the user who created the portal (String type) Cannot be modified. Available in get and getlist. -1 indicates creation by the API.
keywords	Keywords for search engine optimization (String type) The words must be separated by commas. Pass empty to remove.
seoDescription	Description for search engine optimization (String type) Pass empty to remove.
googleAnalyticsKey	Key for Google Analytics (String type) Pass empty to remove.
providerFilter	Indicates whether the provider tabs are used for sorting in the catalogues. (Boolean type)
languageFilter	Indicates whether the language filter is used for sorting in the catalogues. (Boolean type)
isUsingCustomSupportInfo	Indicates whether the portal uses custom contact information for technical support (Boolean type)
newAccountUrl	URL of the account creation button for the portal. (String type)
isEmailValidatedByCode	Indicates whether the portal requires email validation by a code sent to the email address (Boolean type)

Portals: portal/getlist

https://www.domaine.com/lmsapi/portal/getlist

Returns the list of all the portals in your environment.
API call address : https://.../lmsapi/portal/getlist

Request

Example of request call content for the list of portals:

{
}

Field descriptions

Name	Required	Comments/description
		The method does not require any parameter.

Response

Example of response call content for information on the list of portals:

[
{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "title": {
    "texts": [{
        "text": "MonPortail",
        "languageId": 1
      }
    ]
  },
  "subTitle": {
    "texts": [{
        "text": "Mon sous-titre",
        "languageId": 1
      }
    ]
  },

  "description": {
    "texts": [{
        "text": "Ma description",
        "languageId": 1
      }
    ]
  },


  "newAccountButtonLabel": {
    "texts": [{
        "text": "Inscrivez-vous!",
        "languageId": 1
      }
    ]
  },


  "newAccountDescription": {
    "texts": [{
        "text": "Inscrivez-vous dès maintenant en remplissant le formulaire suivant : ",
        "languageId": 1
      }
    ]
  },


  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "coverID": 3,
  "allowNewAccount": false,
  "creationDate": "2018-01-01",
  "url": "siteUrl/monUrl",
  "name": "nom de portail",
  "dns": "mondns",
  "language": 1,
  "newUserLanguage": 1,
  "hasCustomLogo": false,
  "lastModificationDate": "2018-01-02",
  "defaultBranchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "isDefaultPortal": false,
  "displayType": 1,
  "createdByUserID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "keywords": "mot1,mot2,mot3",
  "seoDescription": "une description",
  "googleAnalyticsKey": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "providerFilter": false, 
  "languageFilter": false, 
  "isUsingCustomSupportInfo": true,
  "newAccountUrl": "",
  "isEmailValidatedByCode": true
},
{...}
]

Field descriptions

Name	Comments/description
id	Unique identifier of the portal (String type) This parameter must be empty when the method is used in creation mode, but is required to call it in edit mode.
title text languageId	text: Title of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
subTitle text languageId	text: Subtitle of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
description text languageId	text: Description of the portal as seen by users in the system. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newAccountButtonLabel text languageId	text: Label on the account creation button. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newAccountDescription text languageId	text: Label displayed before the account creation form. (String type) languageId: display language: 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
name	Name of the portal as seen by administration. (String type) This parameter is required in creation mode.
coverID	Identifier for the cover image of the portal. (Number type)
allowNewAccount	Authorization for new users to create an account (Boolean type)
defaultBranchID	Default branch for newly created accounts. (String type) allowNewAccount must be set to true for this field to apply.
branchID	Branch of the portal. (String type) This parameter is required in creation mode.
creationDate	Creation date of the portal Cannot be modified. Available in get and getlist.
url	URL of the portal. (String type) The client site URL will be concatenated when saving. This parameter is required in creation mode.
dns	DNS of the portal. (String type) Pass empty to remove.
language	Display language of the portal 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
newUserLanguage	Default language for new users 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
hasCustomLogo	Indicates whether a custom logo has been assigned to the portal.
lastModificationDate	Date of the last modification of the portal Cannot be modified. Available in get and getlist.
isDefaultPortal	Indicates whether the portal is the default one. (Boolean type) Cannot be modified. Available in get and getlist.
displayType	Display type in the catalogues. 1 = Tile 2 = Calendar 3 = List (Number type)
createdByUserID	Identifier of the user who created the portal (String type) Cannot be modified. Available in get and getlist. -1 indicates creation by the API.
keywords	Keywords for search engine optimization (String type) The words must be separated by commas. Pass empty to remove.
seoDescription	Description for search engine optimization (String type) Pass empty to remove.
googleAnalyticsKey	Key for Google Analytics (String type) Pass empty to remove.
providerFilter	Indicates whether the provider tabs are used for sorting in the catalogues. (Boolean type)
languageFilter	Indicates whether the language filter is used for sorting in the catalogues. (Boolean type)
isUsingCustomSupportInfo	Indicates whether the portal uses custom contact information for technical support (Boolean type)
newAccountUrl	URL of the account creation button for the portal. (String type)
isEmailValidatedByCode	Indicates whether the portal requires email validation by a code sent to the email address (Boolean type)

Portals: portal/create

https://www.domaine.com/lmsapi/portal/create

Creates a portal in your environment.
API call address : https://.../lmsapi/portal/create

Request

Example of request call content to create a portal:

{
  "title": {
    "texts": [{
        "text": "MonPortail",
        "languageId": 1
      }
    ]
  },
  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "name": "mon nom de portail",
  "url": "monurldeportail"
}

Field descriptions

Name	Required	Comments/description
title	X	Title of the portal as seen by users, as multilingual texts (texts). (String type)
name	X	Name of the portal as seen by administration. (String type)
url	X	URL of the portal. The client site URL will be concatenated when saving. (String type)
branchID	X	Branch of the portal. (String type)
subTitle		Subtitle of the portal, as multilingual texts (texts). (String type)
description		Description of the portal, as multilingual texts (texts). (String type)
coverID		Identifier for the cover image of the portal. (Number type)
allowNewAccount		Authorization for new users to create an account. (Boolean type)
defaultBranchID		Default branch for newly created accounts. (String type)
language		Display language of the portal. (Number type)
newUserLanguage		Default language for new users. (Number type)
displayType		Display type in the catalogues. (Number type)
dns		DNS of the portal. (String type)
keywords		Keywords for search engine optimization. (String type)
seoDescription		Description for search engine optimization. (String type)
googleAnalyticsKey		Key for Google Analytics. (String type)

Response

Example of response call content when creating a portal:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Field descriptions

Name	Comments/description
id	Unique identifier of the created portal. (String type)

Portals: portal/edit

https://www.domaine.com/lmsapi/portal/edit

Modifies an existing portal.
API call address : https://.../lmsapi/portal/edit

Request

Example of request call content to edit a portal:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "title": {
    "texts": [{
        "text": "MonPortail",
        "languageId": 1
      }
    ]
  },
  "branchID": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Field descriptions

IMPORTANT: When modifying, the method requires only the "id" value. The fields that are passed are updated; the fields that are not provided are simply not updated.

Name	Required	Comments/description
id	X	Unique identifier of the portal to modify. (String type)
title		Title of the portal as seen by users, as multilingual texts (texts). (String type)
name		Name of the portal as seen by administration. (String type)
url		URL of the portal. The client site URL will be concatenated when saving. (String type)
branchID		Branch of the portal. (String type)
subTitle		Subtitle of the portal, as multilingual texts (texts). (String type)
description		Description of the portal, as multilingual texts (texts). (String type)
coverID		Identifier for the cover image of the portal. (Number type)
allowNewAccount		Authorization for new users to create an account. (Boolean type)
defaultBranchID		Default branch for newly created accounts. (String type)
language		Display language of the portal. (Number type)
newUserLanguage		Default language for new users. (Number type)
displayType		Display type in the catalogues. (Number type)
dns		DNS of the portal. (String type)
keywords		Keywords for search engine optimization. (String type)
seoDescription		Description for search engine optimization. (String type)
googleAnalyticsKey		Key for Google Analytics. (String type)

Response

Example of response call content when editing a portal:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

Field descriptions

Name	Comments/description
id	Unique identifier of the modified portal. (String type)

Portal error code descriptions

Number	Message	Comments/description
1100	Required id	You must provide an identifier for the portal.
1101	Invalid id	The identifier provided for the portal is invalid.
1102	Required branch id	You must provide an identifier for the branch.
1103	Invalid branch id	The identifier provided for the branch is invalid.
1104	Required url	You must provide a URL.
1105	Invalid url	The URL provided is invalid.
1106	Invalid cover id	The identifier provided for the cover image is invalid.
1107	Required name	You must provide a name for the portal.
1108	Invalid name length	The length of the name provided for the portal is invalid.
1109	Required title	You must provide a title for the portal.
1110	Invalid title length	The length of the title provided for the portal is invalid.
1111	Invalid subTitle length	The length of the subtitle provided for the portal is invalid.
1112	Invalid description length	The length of the description provided for the portal is invalid.
1113	Invalid default branch id	The identifier provided for the default branch is invalid.
1114	Error linking external auth	An error occurred while creating the link between the portal and the authentication method.
1115	Invalid newAccountUrl length	The URL for the account creation button is invalid.
1116	Invalid newAccountButtonLabel length	The length of the account creation button label is invalid.

Recent Searches

Portals (Lära and Via HTML)

PORTALS

Portals: portal/get

Request

Field descriptions

Response

Field descriptions

Portals: portal/getlist

Request

Field descriptions

Response

Field descriptions

Portals: portal/create

Request

Field descriptions

Response

Field descriptions

Portals: portal/edit

Request

Field descriptions

Response

Field descriptions

Portal error code descriptions

Was this article helpful?

Name	Host	Duration	Description
_fw_crm_v	sviesolutions.freshdesk.com	1 year	Freshchat/Freshworks cookie (Used to track Visitor/User identity and chat sessions performed by the User).
_x_w	sviesolutions.freshdesk.com	Session	Contains the shard ID at which the account runs on.
_x_m	sviesolutions.freshdesk.com	Session	Contains the state of the shard.
_helpkit_session	sviesolutions.freshdesk.com	Session	Your secret key for verifying cookie session data integrity. If you change this key, all old sessions will become invalid!
helpdesk_node_session	sviesolutions.freshdesk.com	Session	An encrypted hash that stores the secret key and id of the login attempt.
user_credentials	sviesolutions.freshdesk.com	2 months	Used for user authentication.
wf_order	sviesolutions.freshdesk.com	Session	Used to check in which the order the tickets are filtered for custom ticket filters eg: due_by, agent_responded_at, requester_responded_at, etc.
wf_order_type	sviesolutions.freshdesk.com	Session	Used to check if the order is ascending or descending for custom ticket filters.
wf_filter	sviesolutions.freshdesk.com	Session	Denotes which filter is applied for the tickets list.

Recent Searches

Popular Articles

Articles

Topics

Tickets

Portals (Lära and Via HTML)

PORTALS

Portals: portal/get

Request

Field descriptions

Response

Field descriptions

Portals: portal/getlist

Request

Field descriptions

Response

Field descriptions

Portals: portal/create

Request

Field descriptions

Response

Field descriptions

Portals: portal/edit

Request

Field descriptions

Response

Field descriptions

Portal error code descriptions

Was this article helpful?