api/webservice/WebservicePremium/Users/Record.php
Possibly zero references to use statement for classlike/namespace OA
(\OpenApi\Annotations)
Open
Open
use OpenApi\Annotations as OA;
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Gets data for the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="rawData", description="Raw user data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="rawData", description="Raw user data", type="object"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"Users"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Gets data for the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(type="integer"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="Users_Get_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
}
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="userId",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="name", description="User label", type="string", example="System Admin"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/Users/Record/{userId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Data for the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* in="path",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Access denied, access for administrators only",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User doesn't exist",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="id", description="User Id", type="integer", example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* path="/webservice/WebservicePremium/Users/Record/{userId}",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="id", description="User Id", type="integer", example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
return parent::get();
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Users_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Parameters determining checking of editing rights and moving to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Get(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Gets details about the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required=true
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Access denied, access for administrators only",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Parameters determining checking of editing rights and moving to the trash",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
/**
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* Get user detail.
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* summary="Data for the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* schema="Users_Get_Record_Response",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @author Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="Gets details about the user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* in="path",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Users_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Users_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
public function get(): array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* security={{"basicAuth" : {}, "ApiKeyAuth" : {}, "token" : {}}},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User id",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User doesn't exist",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Users module - Response body for user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\AdditionalProperties(type="string", description="Field label"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="privileges",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @license YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* example=116,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=404,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="name", description="User label", type="string", example="System Admin"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="privileges",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
*/
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* example=116,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=403,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* description="User data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Schema(type="integer"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* response=200,
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @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"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
{
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* title="Users module - Response body for user",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Property(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="result",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\AdditionalProperties(type="string", description="Field label"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @return array
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* tags={"Users"},
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* name="userId",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* required=true
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\Response(
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\XmlContent(ref="#/components/schemas/Users_Get_Record_Response"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* @OA\JsonContent(ref="#/components/schemas/Exception"),
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* type="object",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* property="data",
- Exclude checks
Spaces must be used for alignment; tabs are not allowed Open
Open
* ),
- Exclude checks
Line exceeds 120 characters; contains 155 characters Open
Open
* @OA\Parameter(name="x-raw-data", in="header", @OA\Schema(type="integer", enum={0, 1}), description="Gets raw data", required=false, example=1),
- Exclude checks
Line exceeds 120 characters; contains 185 characters Open
Open
* @OA\Property(property="fields", type="object", title="System field names and field labels", example={"field_name_1" : "Field label 1", "field_name_2" : "Field label 2"},
- Exclude checks
Line exceeds 120 characters; contains 131 characters Open
Open
* @OA\Parameter(name="X-ENCRYPTED", in="header", @OA\Schema(ref="#/components/schemas/Header-Encrypted"), required=true),
- Exclude checks
Line exceeds 120 characters; contains 124 characters Open
Open
* @OA\Property(property="moveToTrash", description="Permission to delete", type="boolean", example=false),
- Exclude checks
Line exceeds 120 characters; contains 189 characters Open
Open
* @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"),
- Exclude checks
Line exceeds 120 characters; contains 127 characters Open
Open
* @OA\Property(property="isEditable", description="Check if user is editable", type="boolean", example=true),
- Exclude checks