Documentation

RecordsList extends BaseAction
in package

RecordsList class.

Table of Contents

$allowedHeaders  : mixed
{@inheritdoc}
$allowedMethod  : mixed
{@inheritdoc}
$controller  : Controller
$responseType  : string
$userData  : array<string|int, mixed>
checkAction()  : void
Check called action.
get()  : array<string|int, mixed>
Gets consents.
getCheckStockLevels()  : bool
Get information, whether to check inventory levels.
getLanguage()  : string
Get current language.
getParentCrmId()  : int
Get parent record.
getPermissionType()  : int
Get permission type.
getQuery()  : QueryGenerator
Get query record list.
getUserCrmId()  : int
Get crmid for portal user.
getUserData()  : mixed
Get user data.
getUserStorageId()  : int
Get user storage ID.
preProcess()  : mixed
Pre process function.
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

{@inheritdoc}

public mixed $allowedHeaders = ['x-raw-data', 'x-row-offset', 'x-row-limit', 'x-condition']

$allowedMethod

{@inheritdoc}

public mixed $allowedMethod = ['GET']

$responseType

public string $responseType = 'data'

Response data type.

$userData

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

User data

Methods

checkAction()

Check called action.

public checkAction() : void
Tags
throws
Exception
Return values
void

get()

Gets consents.

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

( path="/webservice/ManageConsents/Approvals/RecordsList", summary="Gets the list of consents", tags={"Approvals"}, security={{"basicAuth" : }, "ApiKeyAuth" : }, "token" : }}}, @OA\Parameter(name="x-row-limit", in="header", @OA\Schema(type="integer"), description="Get rows limit, default: 1000", 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-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1), @OA\Parameter(name="x-condition", in="header", description="Conditions [Json format]", required=false, @OA\JsonContent(ref="#/components/schemas/Approvals_Get_RecordsList_Request"), ), @OA\Response(response=200, description="List of consents", @OA\JsonContent(ref="#/components/schemas/Approvals_Get_RecordsList_Response"), @OA\XmlContent(ref="#/components/schemas/Approvals_Get_RecordsList_Response"), ), @OA\Response(response=401, description="No sent token OR Invalid token", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=403, description="No permissions for module", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), @OA\Response(response=405, description="Method Not Allowed", @OA\JsonContent(ref="#/components/schemas/Exception"), @OA\XmlContent(ref="#/components/schemas/Exception"), ), ),

OA\Schema

( schema="Approvals_Get_RecordsList_Request", title="Conditions", description="The list is based on fields in the Consent register module. fieldName - Field name, value - Value, operator - Specific operator, group - true/false. ", type="object", example={"fieldName" : "approvals_status", "value" : "PLL_ACTIVE", "operator" : "e"} ),

OA\Schema

( schema="Approvals_Get_RecordsList_Response", title="List of consents", description="List of obtained consents", type="object", @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", description="Specific response", type="object", @OA\Property( property="records", type="object", @OA\Property( property="24862", type="object", @OA\Property(property="id", description="Consent ID", type="integer", example=24862), @OA\Property(property="name", description="Text", type="string", example="Consent for email"), @OA\Property(property="approvals_status", description="Status", type="string", example="Active"), @OA\Property(property="number", description="Text", type="string", example="N12"), @OA\Property(property="assigned_user_id", description="Assigned user name", type="string", example="Kowalski Adam"), @OA\Property(property="createdtime", type="string", example="2019-10-07 08:32:38"), @OA\Property(property="modifiedtime", type="string", example="2019-10-07 08:32:38"), @OA\Property(property="created_user_id", description="Assigned user name", type="string", example="Kowalski Adam"), @OA\Property(property="shownerid", description="Assigned user name", type="string", example="Kowalski Adam"), @OA\Property(property="description", description="Description", type="string", example="I confirm to have read.."), ), ), @OA\Property( property="rawData", type="object", @OA\Property( property="24862", type="object", @OA\Property(property="id", description="Consent ID", type="integer", example=24862), @OA\Property(property="name", description="Text", type="string", example="Consent for email"), @OA\Property(property="approvals_status", description="Status", type="string", example="PLL_ACTIVE"), @OA\Property(property="number", description="Text", type="string", example="N12"), @OA\Property(property="assigned_user_id", description="Assigned user ID", type="integer", example=245), @OA\Property(property="createdtime", type="string", example="2019-10-07 08:32:38"), @OA\Property(property="modifiedtime", type="string", example="2019-10-07 08:32:38"), @OA\Property(property="created_user_id", description="Assigned user ID", type="integer", example=245), @OA\Property(property="shownerid", description="Assigned user name", type="string", example="Kowalski Adam"), @OA\Property(property="description", description="Description", type="string", example="I confirm to have read.."), ), ), @OA\Property(property="isMorePages", description="There are more entries", type="boolean", example=true), ), ),

OA\Schema

( schema="Exception", title="General - Error exception", type="object", @OA\Property( property="status", description="0 - error", enum={0}, type="integer", example=0 ), @OA\Property( property="error", description="Error details", type="object", @OA\Property(property="message", type="string", example="Invalid method", description="To show more details turn on: config\Debug.php apiShowExceptionMessages = true"), @OA\Property(property="code", type="integer", example=405), @OA\Property(property="file", type="string", example="api\webservice\Portal\BaseAction\Files.php", description="default disabled to enable set: config\Debug.php apiShowExceptionBacktrace = true"), @OA\Property(property="line", type="integer", example=101, description="default disabled to enable set: config\Debug.php apiShowExceptionBacktrace = true"), @OA\Property(property="backtrace", type="string", example="#0 api\webservice\Portal\BaseAction\Files.php (101) ....", description="default disabled to enable set: config\Debug.php apiShowExceptionBacktrace = true"), ), ),

OA\SecurityScheme

( type="http", securityScheme="basicAuth", scheme="basic", description="Basic Authentication header" ),

OA\SecurityScheme

( name="X-API-KEY", type="apiKey", in="header", securityScheme="ApiKeyAuth", description="Webservice api key header" ),

OA\SecurityScheme

( name="X-TOKEN", type="apiKey", in="header", securityScheme="token", description="Webservice api token by user header" ),

Return values
array<string|int, mixed>

getCheckStockLevels()

Get information, whether to check inventory levels.

public getCheckStockLevels() : bool
Return values
bool

getLanguage()

Get current language.

public getLanguage() : string
Return values
string

getParentCrmId()

Get parent record.

public getParentCrmId() : int
Tags
throws
Exception
Return values
int

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.

public getUserData(string $key) : mixed
Parameters
$key : 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

setUserData()

Set user data.

public setUserData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, 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