Plus - Overview and Common API terms

Company structure

Company (comId)
Each client (customer) inside the Papirfly solution is identified by a Client ID and Company ID. It is numeric and every client has their own unique number. The Company ID, often reffered to as comId or companyId, is used to separate our clients, and this parameter is required when logging in (authenticating) to the backend processes. 

The client id can be found besides the clients name in Site admin. Like this:


Portal (ptlId)
Every instance of an application in the Papirfly solution is organized under a portal. The Portal ID, often refered to as ptlId or portalId, is the identifier for the portal. The portal level is organized directly under the client in the site admin tree. When accessing a specific application, the ptlId must be specified.

Product (Otyld)
Together with comID & ptlld, the application ID, often referred to as otyld or productld, identifies one specific instance of an application. If we expand the portal named "Brand1 in the example screenshot we have something like this.

You can't determine what type of application it is, just be looking at the tree, but for example, the Place archive (DAM archive) Images has a otyId = 1. That means that the Demo clients Place archive for images has these values if we take an example company with comId = 23 with one example portal with ptlId = 54:

comId : 23
ptlId: 54
otyId: 1

Together with user credentials, this determines what you see and what you are allowed to do inside our solution.

Common Terminology

There are a few parameters and terms that are repeated throughout this documentation. It is important that you know what the different parameters means before using the APIs towards Papirfly backend APIs.

laeld:
Since the Papirfly solution is a multi-lingual solution, you need to set the language scope already at login. Meaning that your established instance is set to a specific language. When setting up a client, you specify what language to use. Instantiating a API session towards a non-existing language for a client will result in error messages. The languages available can be fetched from our APIs. There are company level languages and also application enabled languages which are fetched through specific application's API.

apnld:
Each application (Place archive, Web-to-print, Site admin, Point etc) has its own unique identifier.

qclld:
This field describes the status of the asset/web page/record. The status is an integer value that can be customized for each client in the Site administration interface. qclId is used to separate the assets/records based on their status.

The following values are reserved for internal use: 
1: Approved
3: Submitted for approval/Under construction
4: Deleted

All other values can be used for own purposes like querying or storing. Note that the Place archive will expect that Place assets has the qclId = 1 if the asset shall be available in Place web interface (Approved section).

oavld:

This field is used to identify the availability of assets inside our Place solution:
null: normal availability
1: normal availability
2: attachments or subobjects
-4: special availability

obtId:
This field is used as a unique identifier for assets inside our Place solution. It can be often reffered to as assetId or obtId.