Service used for user management.

AddUser

Add user

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
UserData userData = new UserData
{
   UserName = "username",
   PartyReferenceCode = "1000",
   Password = "*********",
   Email = "useremail@mail.com"
};
GeneralResult result = client.AddUser(userData);

Sample soap request:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:AddUser>
         <urn:UserData>
            <urn:Email>p11123@mail.com</urn:Email>
            <urn:PartyReferenceCode>1000</urn:PartyReferenceCode>
            <urn:Password>q1w2e3r4111</urn:Password>
            <urn:UserName>TestUser1</urn:UserName>
         </urn:UserData>
      </urn:AddUser>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
AddUser

AddUser
- UserData
  
  User Data
  Object
  
  UserData
  
  User information
  
  AccessGroups
  
  List of access groups
  
  Array
  
  string
  
  CellularPhoneNumber
  
  Cellular phone number
  
  string
  
  City
  
  City
  
  string
  
  ClientRestriction
  
  List of client restrictions
  
  Array
  
  Object
  
  ClientRestrictionType
  
  Client restriction type
  
  IncludeSubParties
  
  Include sub parties
  
  bool
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  CountryCode
  
  Country code e.g. NL, NO SE etc.
  
  string
  
  CountryFormat
  
  Country format, e.g. SE, NO, NL, UK etc.
  
  string
  
  Department
  
  Department
  
  string
  
  Disabled
  
  Disable user true or false
  
  bool
  
  Email Mandatory
  
  Email
  
  string
  
  EmploymentNumber
  
  Employment number
  
  string
  
  HouseNo
  
  House number
  
  string
  
  HouseNoExtension
  
  House number extension
  
  string
  
  LanguageCode
  
  Language code, e.g. en, sv etc.
  
  string
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  Password Mandatory
  
  Password
  
  string
  
  PBXPhoneNumber
  
  PBX phone number
  
  string
  
  PhoneNumber
  
  Phone number
  
  string
  
  StateCode
  
  State code
  
  string
  
  Street
  
  Street
  
  string
  
  UserGuid
  
  User GUID
  
  string
  
  UserName Mandatory
  
  User name
  
  string
  
  UserRole
  
  User role
  
  Enum
  
  UserRoleType
  
  User role type
  
  CEO
  
  CEO
  
  Economy
  
  Economy
  
  InvoiceReceiver
  
  Invoice receiver
  
  Other
  
  Other
  
  PrimaryContact
  
  Primary contact
  
  ReportReceiver
  
  Report receiver
  
  TrustAccountingReceiver
  
  Trust account receiver
  
  ZipCode
  
  Zip code
  
  string

Output

Error codes:

1 : error message from ARC server.

Object

AddUserResult

Result of AddUser
Object
AddUserResult

Class for representing GetUsers method result
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- UserGuid
  
  UserGuid of just added user
  
  string

DeleteUser

Delete user

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
string userGuid = "74071F4C-7354-4669-AFFC-500585AA0185";
GeneralResult result = client.DeleteUser(userGuid);

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
  <urn:DeleteUser>
    <urn:UserGuid>86d4d885-2b01-4071-ba34-b22a4e3b28d2</urn:UserGuid>
  </urn:DeleteUser>
</soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
DeleteUser

DeleteUser
- UserGuid
  
  User guid
  
  string

Output

Error codes:

1 : error message from ARC server.

Object

DeleteUserResult

Result of DeleteUser
Object
GeneralResult

A general result containing a result with result code and result text.
- Result
  
  The result of the request.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetAccessGroups

Get all access groups

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
GetAccessGroupsResult result = client.GetAccessGroups();

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
   <urn:GetAccessGroups/>
</soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetAccessGroups

GetAccessGroups

Output

Error codes:

1 : error message from ARC server.

Object

GetAccessGroupsResult

Result of GetAccessGroups
Object
GetAccessGroupsResult

Class for representing GetAccessGroups method result
- AccessGroups
  
  List of access groups
  
  Array
  
  string
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

GetUsers

Get list of users

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
ClientRestrictionType[] request = {
        new ClientRestrictionType{
            IncludeSubParties = true,
            PartyReferenceCode = "1000"
        },
        new ClientRestrictionType{
            IncludeSubParties = true,
            PartyReferenceCode = "1000"
        }
     };
GetUsersResult result = client.GetUsers(request);

Sample soap request:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetUsers>
         <urn:ClientRestrictions>
            <urn:ClientRestrictionType>
               <urn:IncludeSubParties>false</urn:IncludeSubParties>
               <urn:PartyReferenceCode>1000</urn:PartyReferenceCode>
            </urn:ClientRestrictionType>
         </urn:ClientRestrictions>
      </urn:GetUsers>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
GetUsers

GetUsers
- ClientRestrictions
  
  Client restriction
  Array
  
  Object
  
  ClientRestrictionType
  
  Client restriction type
  
  IncludeSubParties
  
  Include sub parties
  
  bool
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string

Output

List of users filtered by parameters. If filter format is incorrect - error is returned
Error codes:

1 : error message from ARC server.

Object

GetUsersResult

Result of GetUsers
Object
GetUsersResult

Class for representing GetUsers method result
- Result
  
  The result of the request. Indicating success or error.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string
- Users
  
  List of users
  Array
  
  Object
  
  UserData
  
  User information
  
  AccessGroups
  
  List of access groups
  
  Array
  
  string
  
  CellularPhoneNumber
  
  Cellular phone number
  
  string
  
  City
  
  City
  
  string
  
  ClientRestriction
  
  List of client restrictions
  
  Array
  
  Object
  
  ClientRestrictionType
  
  Client restriction type
  
  IncludeSubParties
  
  Include sub parties
  
  bool
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  CountryCode
  
  Country code e.g. NL, NO SE etc.
  
  string
  
  CountryFormat
  
  Country format, e.g. SE, NO, NL, UK etc.
  
  string
  
  Department
  
  Department
  
  string
  
  Disabled
  
  Disable user true or false
  
  bool
  
  Email Mandatory
  
  Email
  
  string
  
  EmploymentNumber
  
  Employment number
  
  string
  
  HouseNo
  
  House number
  
  string
  
  HouseNoExtension
  
  House number extension
  
  string
  
  LanguageCode
  
  Language code, e.g. en, sv etc.
  
  string
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  Password Mandatory
  
  Password
  
  string
  
  PBXPhoneNumber
  
  PBX phone number
  
  string
  
  PhoneNumber
  
  Phone number
  
  string
  
  StateCode
  
  State code
  
  string
  
  Street
  
  Street
  
  string
  
  UserGuid
  
  User GUID
  
  string
  
  UserName Mandatory
  
  User name
  
  string
  
  UserRole
  
  User role
  
  Enum
  
  UserRoleType
  
  User role type
  
  CEO
  
  CEO
  
  Economy
  
  Economy
  
  InvoiceReceiver
  
  Invoice receiver
  
  Other
  
  Other
  
  PrimaryContact
  
  Primary contact
  
  ReportReceiver
  
  Report receiver
  
  TrustAccountingReceiver
  
  Trust account receiver
  
  ZipCode
  
  Zip code
  
  string

Ping

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return a result code 0 if everything went ok. If something went wrong it will return a result code other than 0 and the result text will contain information about error. However if service is unreachable, e.g. not started, the service will not respond at all.

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
try
{
    GeneralResult result = client.Ping();
    if (result.Result.ResultCode != 0)
    {
       throw new Exception(result.Result.ResultText ?? "Unknown error");
    }
}
catch (Exception e)
{
   throw new Exception("Failed to ping user service.", e);
}

Sample soap request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:Ping/>
   </soapenv:Body>
</soapenv:Envelope>

Input

request Mandatory

Request data
Object
Ping

Ping

Output

Returns with result code 0 if ping was successful, otherwise read result text for error information.

Object

GeneralResult

Result of GeneralResult
Object
GeneralResult

A general result containing a result with result code and result text.
- Result
  
  The result of the request.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string

UpdateUser

Update user

Examples

Sample usage in C# with generated client:

UserManagementClient client = new UserManagementClient();
UserData userData = new UserData
{
   UserName = "username",
   PartyReferenceCode = "1000",
   Email = "useremail@mail.com",
   PBXPhoneNumber = "+380688686868",
   Street = "street"
};
GeneralResult result = client.UpdateUser(userData);

Sample soap request:

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
 <soapenv:Header/>
 <soapenv:Body>
     <urn:UpdateUser>
       <urn:UserData>
			<urn:ClientRestriction>
			  <urn:ClientRestrictionType>
			    <urn:IncludeSubParties>false</urn:IncludeSubParties>
			    <urn:PartyReferenceCode>0183</urn:PartyReferenceCode>
			  </urn:ClientRestrictionType>
			</urn:ClientRestriction>
			<urn:Disabled>1</urn:Disabled>
			<urn:Email>p1@gggg.12345</urn:Email>
			<urn:PartyReferenceCode>1000</urn:PartyReferenceCode>
			<urn:Password>112</urn:Password>
			<urn:UserGuid>86d4d885-2b01-4071-ba34-b22a4e3b28d2</urn:UserGuid>
			<urn:UserName>q1w2e3r4t5</urn:UserName>
       </urn:UserData>
     /urn:UpdateUser>
 </soapenv:Body>
 </soapenv:Envelope>

Input

request Mandatory

Request data
Object
UpdateUser

UpdateUser
- UserData
  
  User data
  Object
  
  UserData
  
  User information
  
  AccessGroups
  
  List of access groups
  
  Array
  
  string
  
  CellularPhoneNumber
  
  Cellular phone number
  
  string
  
  City
  
  City
  
  string
  
  ClientRestriction
  
  List of client restrictions
  
  Array
  
  Object
  
  ClientRestrictionType
  
  Client restriction type
  
  IncludeSubParties
  
  Include sub parties
  
  bool
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  CountryCode
  
  Country code e.g. NL, NO SE etc.
  
  string
  
  CountryFormat
  
  Country format, e.g. SE, NO, NL, UK etc.
  
  string
  
  Department
  
  Department
  
  string
  
  Disabled
  
  Disable user true or false
  
  bool
  
  Email Mandatory
  
  Email
  
  string
  
  EmploymentNumber
  
  Employment number
  
  string
  
  HouseNo
  
  House number
  
  string
  
  HouseNoExtension
  
  House number extension
  
  string
  
  LanguageCode
  
  Language code, e.g. en, sv etc.
  
  string
  
  PartyReferenceCode Mandatory
  
  Party reference code
  
  string
  
  Password Mandatory
  
  Password
  
  string
  
  PBXPhoneNumber
  
  PBX phone number
  
  string
  
  PhoneNumber
  
  Phone number
  
  string
  
  StateCode
  
  State code
  
  string
  
  Street
  
  Street
  
  string
  
  UserGuid
  
  User GUID
  
  string
  
  UserName Mandatory
  
  User name
  
  string
  
  UserRole
  
  User role
  
  Enum
  
  UserRoleType
  
  User role type
  
  CEO
  
  CEO
  
  Economy
  
  Economy
  
  InvoiceReceiver
  
  Invoice receiver
  
  Other
  
  Other
  
  PrimaryContact
  
  Primary contact
  
  ReportReceiver
  
  Report receiver
  
  TrustAccountingReceiver
  
  Trust account receiver
  
  ZipCode
  
  Zip code
  
  string

Output

Error codes:

1 : error message from ARC server.

Object

UpdateUserResult

Result of UpdateUser
Object
GeneralResult

A general result containing a result with result code and result text.
- Result
  
  The result of the request.
  Object
  
  ResultType
  
  Common result type.
  
  ResultCode Mandatory
  
  The result code 0 means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.
  
  int
  
  ResultText Mandatory
  
  Text information of the result. Usually contains a warning or error message when result code is indicating other than success.
  
  string