User Management API

The TECS User Management API enables users to:

  • Register new users within their organization on TECS Platform
  • Assign roles to users within their organization

API Endpoints

Register a User

Register a new user within your organization

Example Request

curl -X POST \
"https://test.tecs.at/usermanagement-backofficews/registerUser" \
-H "accept: */*" \
-u User1:Password1 \
-H "Content-Type: application/json" \
-d "{ \"city\": \"Berlin\",
    \"country\": \"Germany\", 
    \"dateOfBirth\": \"01.01.2000\", 
    \"driverLicenceNumber\": \"DC357158\", 
    \"email\": \"[email protected]\", 
    \"firstName\": \"UserName\", 
    \"identificationNumber\": \"19574328625\", 
    \"lastName\": \"UserSurname\", 
    \"login\": \"userlogin\", 
    \"passportNumber\": \"VH488314\", 
    \"phone\": \"+4991199009926\", 
    \"salutation\": \"Mr.\", 
    \"state\": \"Berlin\", 
    \"street1\": \"Potsdamer\", 
    \"street2\": \"13\", 
    \"zip\": \"10783\"}"

Request Parameters

ParameterTypeRequiredDescription
citystringoptionalUser city
countrystringoptionalUser country
dateOfBirthstringoptionalUser date of birth
driverLicenceNumberstringoptionalUser driver license number
emailstringrequiredUser email
firstNamestringoptionalUser first name
identificationNumberstringoptionalUser ID number
lastNamestringoptionalUser last name
loginstringoptionalUser login
passportNumberstringoptionalUser passport number
phonestringoptionalUser phone number
salutationstringoptionalUser salutation
statestringoptionalUser state
street1stringoptionalUser address (first line)
street2stringoptionalUser address (second line)
zipstringoptionalUser postal code

Example Response

{   
    "responseCode":0,
    "responseMessage":"OK",
    "consumerId":"userlogin"
}

Response Parameters

ParameterTypeDescription
responseCodeintResponse code (0 = OK, otherwise an error code)
responseMessagestringHuman readable response code representation
consumerIdstringUser login or unique ID

Error Codes and Messages

Error CodeError Message
24000You don't have permissions (state User_HasNotRole)
24001You don't have permissions (state Mandator_IsNotTheSame)
24012Mandatory fields are not filled %1$s (state MandatoryFields_AreNotFilled)
24014with arbitrary message (state Unexpected_Exception)
24029terminalid (must be present, in correct format)
24030reason_deactivation (must be present, in correct format)
25000INTERNAL_SERVER_ERROR
25001OAUTH_INTERACTION_FAILED
25002OAUTH_INVALID_TOKEN
25003UNAUTHORIZED
25004BAD_REQUEST
25005USER_INACTIVE
25007TECS_TERM_NOT_FOUND
25008MANDATOR_NOT_FOUND
25012DATA_INTEGRITY_ERROR
25013DATA_ACCESS_ERROR

Assign User Roles

Assign roles to an existing user.

Example Request

curl -X POST "https://dev.tecs.at/usermanagement-backofficews/assignRoles" \
-H "accept: */*" \
-u User1:Password1 \
-H "Content-Type: application/json" \
-d "{ \"consumerUUID\": \"userlogin\", 
\"roles\": [ { \"corporateUUID\": \"4dbbab90-74f5-4d8d-92e1-d02e6a4a0dee\", \"userRoleName\": \"MP_CORPORATE\" } ]}"

Request Parameters


ParameterTypeMandatoryDescription
consumerUUIDstringmandatoryUser login
corporateUUIDstringoptionalUnique ID of the corporate
userRoleNamestringoptionalName of the role

Example Response

{   
    "responseCode":0,
    "responseMessage":"OK"
}

Response Parameters

ParameterTypeDescription
responseCodeintResponse code (0 = OK, otherwise an error code)
responseMessagestringHuman readable response code representation

Error Codes and Messages

Error CodeError Message
24000You don't have permissions (state User_HasNotRole)
24001You don't have permissions (state Mandator_IsNotTheSame)
24012Mandatory fields are not filled %1$s (state MandatoryFields_AreNotFilled)
24014with arbitrary message (state Unexpected_Exception)
24029terminalid (must be present, in correct format)
24030reason_deactivation (must be present, in correct format)
25000INTERNAL_SERVER_ERROR
25001OAUTH_INTERACTION_FAILED
25002OAUTH_INVALID_TOKEN
25003UNAUTHORIZED
25004BAD_REQUEST
25005USER_INACTIVE
25007TECS_TERM_NOT_FOUND
25008MANDATOR_NOT_FOUND
25012DATA_INTEGRITY_ERROR
25013DATA_ACCESS_ERROR