Get User - SuperOffice

Get User

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/User/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/User/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "AssociateId": 123,
  "Name": "<string>",
  "Rank": 123,
  "Tooltip": "<string>",
  "LicenseOwners": [
    {
      "Name": "<string>",
      "Description": "<string>",
      "RestrictedModuleLicenses": [
        {
          "Unrestricted": true,
          "Total": 123,
          "Tooltip": "<string>",
          "CanAssign": true,
          "Free": 123,
          "InUse": 123,
          "IsHidden": true,
          "Assigned": true,
          "ModuleLicenseId": 123,
          "Name": "<string>",
          "Description": "<string>",
          "PrerequisiteModuleName": "<string>",
          "SortOrder": 123,
          "ExtraFlags": 123,
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "UnrestrictedModuleLicenses": [
        {
          "Unrestricted": true,
          "Total": 123,
          "Tooltip": "<string>",
          "CanAssign": true,
          "Free": 123,
          "InUse": 123,
          "IsHidden": true,
          "Assigned": true,
          "ModuleLicenseId": 123,
          "Name": "<string>",
          "Description": "<string>",
          "PrerequisiteModuleName": "<string>",
          "SortOrder": 123,
          "ExtraFlags": 123,
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Role": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UserGroup": {
    "Value": "<string>",
    "Tooltip": "<string>",
    "Id": 123,
    "Rank": 123,
    "Deleted": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OtherGroups": [
    {
      "Value": "<string>",
      "Tooltip": "<string>",
      "Id": 123,
      "Rank": 123,
      "Deleted": true,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Deleted": true,
  "Lastlogin": "2023-11-07T05:31:56Z",
  "Lastlogout": "2023-11-07T05:31:56Z",
  "EjUserId": 123,
  "RequestSignature": "<string>",
  "Type": "Unknown",
  "IsPersonRetired": true,
  "IsOnTravel": true,
  "Credentials": [
    {
      "Type": {
        "DisplayType": "<string>",
        "Type": "<string>",
        "Description": "<string>",
        "ValueControl": "Static",
        "CanCreatePerson": true,
        "IsUserNameSupported": true,
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      },
      "Value": "<string>",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "UserName": "<string>",
  "TicketCategories": [
    {
      "Id": 123,
      "Name": "<string>",
      "ToolTip": "<string>",
      "Deleted": true,
      "Rank": 123,
      "Type": "<string>",
      "ChildItems": "<array>",
      "IconHint": "<string>",
      "ColorBlock": 123,
      "ExtraInfo": "<string>",
      "StyleHint": "<string>",
      "FullName": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "NickName": "<string>",
  "WaitingForApproval": true,
  "ExtraFields": {},
  "CustomFields": {},
  "PostSaveCommands": [
    {
      "Name": "<string>",
      "DisplayName": "<string>",
      "Description": "<string>",
      "ToolTip": "<string>",
      "Actions": "Implicit",
      "ActionData": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Get User

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/User/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/User/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "AssociateId": 123,
  "Name": "<string>",
  "Rank": 123,
  "Tooltip": "<string>",
  "LicenseOwners": [
    {
      "Name": "<string>",
      "Description": "<string>",
      "RestrictedModuleLicenses": [
        {
          "Unrestricted": true,
          "Total": 123,
          "Tooltip": "<string>",
          "CanAssign": true,
          "Free": 123,
          "InUse": 123,
          "IsHidden": true,
          "Assigned": true,
          "ModuleLicenseId": 123,
          "Name": "<string>",
          "Description": "<string>",
          "PrerequisiteModuleName": "<string>",
          "SortOrder": 123,
          "ExtraFlags": 123,
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "UnrestrictedModuleLicenses": [
        {
          "Unrestricted": true,
          "Total": 123,
          "Tooltip": "<string>",
          "CanAssign": true,
          "Free": 123,
          "InUse": 123,
          "IsHidden": true,
          "Assigned": true,
          "ModuleLicenseId": 123,
          "Name": "<string>",
          "Description": "<string>",
          "PrerequisiteModuleName": "<string>",
          "SortOrder": 123,
          "ExtraFlags": 123,
          "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
          },
          "FieldProperties": {}
        }
      ],
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Role": {
    "Id": 123,
    "Value": "<string>",
    "Tooltip": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "UserGroup": {
    "Value": "<string>",
    "Tooltip": "<string>",
    "Id": 123,
    "Rank": 123,
    "Deleted": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "OtherGroups": [
    {
      "Value": "<string>",
      "Tooltip": "<string>",
      "Id": 123,
      "Rank": 123,
      "Deleted": true,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Deleted": true,
  "Lastlogin": "2023-11-07T05:31:56Z",
  "Lastlogout": "2023-11-07T05:31:56Z",
  "EjUserId": 123,
  "RequestSignature": "<string>",
  "Type": "Unknown",
  "IsPersonRetired": true,
  "IsOnTravel": true,
  "Credentials": [
    {
      "Type": {
        "DisplayType": "<string>",
        "Type": "<string>",
        "Description": "<string>",
        "ValueControl": "Static",
        "CanCreatePerson": true,
        "IsUserNameSupported": true,
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      },
      "Value": "<string>",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "UserName": "<string>",
  "TicketCategories": [
    {
      "Id": 123,
      "Name": "<string>",
      "ToolTip": "<string>",
      "Deleted": true,
      "Rank": 123,
      "Type": "<string>",
      "ChildItems": "<array>",
      "IconHint": "<string>",
      "ColorBlock": 123,
      "ExtraInfo": "<string>",
      "StyleHint": "<string>",
      "FullName": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "NickName": "<string>",
  "WaitingForApproval": true,
  "ExtraFields": {},
  "CustomFields": {},
  "PostSaveCommands": [
    {
      "Name": "<string>",
      "DisplayName": "<string>",
      "Description": "<string>",
      "ToolTip": "<string>",
      "Actions": "Implicit",
      "ActionData": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

integer<int32>

required

The id of the User to return.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

boolean

Load foreign keys on this entity into the ExtraFields property as 'app.device.keyname'='123' pairs.

Response

User found.

SuperOffice User, with login credentials and an associated person. User entity with API _Links added.

AssociateId

integer<int32>

Primary key

Name

string

Initials, UserId - also used as login name for on-site installations. Identifies user in archives.

Rank

integer<int32>

Rank order

Tooltip or other description

LicenseOwners

object[]

The restricted and unrestricted module licenses grouped by license owner. These module licenses are either assigned or unassigned to this user

Show child attributes

Role

object

Users role for role-based security Carrier object for Role. Services for the Role Carrier is available from the User Agent.

Show child attributes

UserGroup

object

The main user group that this user belongs to Carrier object for UserGroup. Services for the UserGroup Carrier is available from the User Agent.

Show child attributes

OtherGroups

object[]

The other groups this user is a member of, apart from the main user group. Use MDO List name "usergroup" to get list items.

Show child attributes

Person

object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Show child attributes

Deleted

boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

Lastlogin

string<date-time>

Last login date

Lastlogout

string<date-time>

Last logout date

EjUserId

integer<int32>

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

RequestSignature

string

ej users request signature

Type

enum<string>

User type: 1=InternalAssociate, 2=ResourceAssociate, 3=ExternalAssociate, 4=AnonymousAssociate, 5=SystemAssociate

Available options:

Unknown,

InternalAssociate,

ResourceAssociate,

ExternalAssociate,

AnonymousAssociate,

SystemAssociate

IsPersonRetired

boolean

True if the user is retired and should have no rights, not appear in lists, etc.

IsOnTravel

boolean

True if the user is on travel.

Credentials

object[]

List of credentials registered for this user. i.e. valid authentication methods.

Show child attributes

UserName

string

User name, a.k.a. Login name. This might be an e-mail address.

TicketCategories

object[]

Request Ticket Categories assigned to the user.
Use MDO List name "ejCategory" to get list items.

Show child attributes

NickName

string

The unique nick name for this user. Used in Service as an alias, similar to Name/Initials.

WaitingForApproval

boolean

The user is waiting for an administrator to approve/grant her/him access.

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.User.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.User.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

PostSaveCommands

object[]

Post custom commands the client should execute after save has completed.

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

_Links

object

Show child attributes