Documentation

RecordRelatedList extends BaseAction
in package

Webservice standard container - Get record related list class.

Table of Contents

$allowedHeaders  : array<string|int, mixed>
$allowedMethod  : array<string|int, string>
$controller  : Controller
$responseType  : string
$recordModel  : Vtiger_Record_Model
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
get()  : array<string|int, mixed>
Get related record list method.
getLanguage()  : string
Get current language.
getParentCrmId()  : int|null
Get parent record.
getPermissionType()  : int
Get permission type.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data and session data.
getUserStorageId()  : int
Get user storage ID.
preProcess()  : mixed
Pre process function.
setAllUserData()  : void
Set user data.
setUserData()  : void
Set user data.
updateSession()  : void
Update user session.
updateUser()  : void
Update user data.
checkLifetimeSession()  : void
Check lifetime user session.
checkPermission()  : void
Check permission to method.
checkPermissionToModule()  : void
Check permission to module.
isRawData()  : bool
Check if you send raw data.
loadSession()  : void
Load user session data .

Properties

$allowedHeaders

public array<string|int, mixed> $allowedHeaders = ['x-raw-data', 'x-row-offset', 'x-row-limit', 'x-fields', 'x-parent-id', 'x-condition', 'x-order-by', 'x-row-count']

Allowed headers

$allowedMethod

public array<string|int, string> $allowedMethod = ['GET']

Allowed methods

$responseType

public string $responseType = 'data'

Response data type.

$userData

private array<string|int, mixed> $userData = []

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Return values
void —

get()

Get related record list method.

public get() : array<string|int, mixed>
Tags
throws
Exception
OA\Get

( path="/webservice/WebserviceStandard/{moduleName}/RecordRelatedList/{recordId}/{relatedModuleName}", description="Gets a list of related records", summary="Related list of records", tags={"BaseModule"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="moduleName", in="path", @OA\Schema(type="string"), description="Module name", required=true, example="Contacts"), @OA\Parameter(name="recordId", in="path", @OA\Schema(type="integer"), description="Record id", required=true, example=116), @OA\Parameter(name="relatedModuleName", in="path", @OA\Schema(type="string"), description="Related module name", required=true, example="Contacts"), @OA\Parameter(name="relationId", in="query", @OA\Schema(type="integer"), style="form", description="Relation id", required=false), @OA\Parameter(name="cvId", in="query", @OA\Schema(type="integer"), style="form", description="Custom view id", required=false), @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1), @OA\Parameter(name="x-row-limit", in="header", @OA\Schema(type="integer"), description="Get rows limit, default: 100", required=false, example=1000), @OA\Parameter(name="x-row-offset", in="header", @OA\Schema(type="integer"), description="Offset, default: 0", required=false, example=0), @OA\Parameter(name="x-fields", in="header", description="JSON array in the list of fields to be returned in response", required=false, @OA\JsonContent(type="array", example={"field_name_1", "field_name_2"}, @OA\Items(type="string")), ), @OA\Parameter(name="x-condition", in="header", description="Conditions [Json format]", required=false, @OA\JsonContent(ref="#/components/schemas/Conditions-Mix-For-Query-Generator"), ), @OA\Parameter(name="x-only-column", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Return only column names", required=false, example=1), @OA\Parameter(name="x-order-by", in="header", description="Set the sorted results by columns [Json format]", required=false, @OA\JsonContent(type="object", title="Sort conditions", description="Multiple or one condition for a query generator", example={"field_name_1" : "ASC", "field_name_2" : "DESC"}, @OA\AdditionalProperties(type="string", description="Sort Direction", enum={"ASC", "DESC"}), ), ), @OA\Response(response=200, description="List of entries", @OA\JsonContent(ref="#/components/schemas/BaseModule_RecordRelatedList_ResponseBody"), @OA\XmlContent(ref="#/components/schemas/BaseModule_RecordRelatedList_ResponseBody"), ), @OA\Response(response=400, description="Relationship does not exist", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=403, description="No permissions to view record", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=404, description="Record doesn't exist", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=405, description="No relation module name", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="BaseModule_RecordRelatedList_ResponseBody", title="Base module - Response action related record list", description="Module action related record list response body", type="object", required={"status", "result"}, @OA\Property(property="status", type="integer", enum={0, 1}, description="A numeric value of 0 or 1 that indicates whether the communication is valid. 1 - success , 0 - error"), @OA\Property(property="result", type="object", title="List of related records", required={"headers", "records", "permissions", "numberOfRecords", "isMorePages"}, @OA\Property(property="headers", type="object", title="Fields names", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2", "assigned_user_id" : "Assigned user", "createdtime" : "Created time"}, @OA\AdditionalProperties(type="string", description="Field name"), ), @OA\Property(property="records", type="object", title="Records display details", @OA\AdditionalProperties(type="object", ref="#/components/schemas/Record_Display_Details"), ), @OA\Property(property="permissions", type="object", title="Records action permissions", @OA\AdditionalProperties(type="object", title="Record action permissions", required={"isEditable", "moveToTrash"}, @OA\Property(property="isEditable", type="boolean", description="Check if record is editable", example=true), @OA\Property(property="moveToTrash", type="boolean", description="Permission to delete", example=true), ), ), @OA\Property(property="rawData", type="object", title="Records raw details, dependent on the header x-raw-data", @OA\AdditionalProperties(type="object", ref="#/components/schemas/Record_Raw_Details"), ), @OA\Property(property="numberOfRecords", type="integer", description="Number of records on the page", example=20), @OA\Property(property="isMorePages", type="boolean", description="There are more pages", example=true), @OA\Property(property="numberOfAllRecords", type="integer", description="Number of all records, dependent on the header x-row-count", example=54), ), ),

Return values
array<string|int, mixed> —

getLanguage()

Get current language.

public getLanguage() : string
Return values
string —

getParentCrmId()

Get parent record.

public getParentCrmId() : int|null
Tags
throws
Exception
Return values
int|null —

getPermissionType()

Get permission type.

public getPermissionType() : int
Return values
int —

getUserCrmId()

Get crmid for portal user.

public getUserCrmId() : int
Return values
int —

getUserData()

Get user data and session data.

public getUserData(string $key[, string $param = '' ]) : mixed
Parameters
$key : string
$param : string = ''
Return values
mixed —

getUserStorageId()

Get user storage ID.

public getUserStorageId() : int
Return values
int —

preProcess()

Pre process function.

public preProcess() : mixed
Return values
mixed —

setAllUserData()

Set user data.

public setAllUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

setUserData()

Set user data.

public setUserData(string $key, mixed $value) : void
Parameters
$key : string
$value : mixed
Return values
void —

updateSession()

Update user session.

public updateSession([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

updateUser()

Update user data.

public updateUser([array<string|int, mixed> $data = [] ]) : void
Parameters
$data : array<string|int, mixed> = []
Return values
void —

checkLifetimeSession()

Check lifetime user session.

protected checkLifetimeSession() : void
Tags
throws
Exception
Return values
void —

checkPermission()

Check permission to method.

protected checkPermission() : void
Tags
throws
Exception
Return values
void —

checkPermissionToModule()

Check permission to module.

protected checkPermissionToModule() : void
Tags
throws
Exception
Return values
void —

isRawData()

Check if you send raw data.

protected isRawData() : bool
Return values
bool —

loadSession()

Load user session data .

protected loadSession() : void
Tags
throws
Exception
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results