Tangoe Telecom SOAP API

22.1.x
(0 reviews)

> User

addUser()

The method adds a new user into the database using the provided fields from UserDetails object. The result of the operation is an object represented by a code and a message that provides details about the success of the operation. Also the UserID of the new user is returned as part of the response object. The user is not created if another one with the same UserID already exists. The structure of the used objects may be observed in the appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:AddUserRequest>
         <inv:user>
            <!--You may enter the following 10 items in any order-->
            <!--Optional:-->
            <inv:userID>?</inv:userID>
            <!--Optional:-->
            <inv:userName>?</inv:userName>
            <!--Optional:-->
            <inv:firstName>?</inv:firstName>
            <!--Optional:-->
            <inv:lastName>?</inv:lastName>
            <!--Optional:-->
            <inv:supportUser>?</inv:supportUser>
            <!--Optional:-->
            <inv:phoneNumber>?</inv:phoneNumber>
            <!--Optional:-->
            <inv:email>?</inv:email>
            <!--Optional:-->
            <inv:password>?</inv:password>
            <!--Optional:-->
            <inv:profileID>?</inv:profileID>
            <!--Optional:-->
            <inv:profileName>?</inv:profileName>
         </inv:user>
      </inv:AddUserRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:AddUserResponse>
         <!--Optional:-->
         <inv:userID>?</inv:userID>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:AddUserResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • Inside the provided user object, userName, firstName, lastName, email, password, profileName fields must always be provided.
  • The following elements accept only particular values:
    • userName – a non existing UserName;
    • email – a string representing an email address.

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Data validation error – situations:
    • userName is not provided (as it is considered compulsory).
    • there is already an user with the provided userName;
    • firstName is not provided (as it is considered compulsory).
    • lastName is not provided (as it is considered compulsory).
    • email is not provided (as it is considered compulsory).
    • password is not provided (as it is considered compulsory).
    • profileName is not provided (as it is considered compulsory).
  • Operation error, if a database error occurs.

editUser()

The method edits an existing user using the provided fields from UserDetails object. The result of the operation is an object represented by a code and a message that provides details about the success of the operation. The structure of the used objects may be observed in the appendix section of this document. If a listed field is not provided (excluding username) the existing value from the database will be used insead. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:EditUserRequest>
         <inv:user>
            <!--You may enter the following 10 items in any order-->
            <!--Optional:-->
            <inv:userID>?</inv:userID>
            <!--Optional:-->
            <inv:userName>?</inv:userName>
            <!--Optional:-->
            <inv:firstName>?</inv:firstName>
            <!--Optional:-->
            <inv:lastName>?</inv:lastName>
            <!--Optional:-->
            <inv:supportUser>?</inv:supportUser>
            <!--Optional:-->
            <inv:phoneNumber>?</inv:phoneNumber>
            <!--Optional:-->
            <inv:email>?</inv:email>
            <!--Optional:-->
            <inv:password>?</inv:password>
            <!--Optional:-->
            <inv:profileID>?</inv:profileID>
            <!--Optional:-->
            <inv:profileName>?</inv:profileName>
         </inv:user>
      </inv:EditUserRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:EditUserResponse>
         <!--Optional:-->
         <inv:userID>?</inv:userID>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:EditUserResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • Inside the provided user object, userName fields must always be provided.
  • The following elements accept only particular values:
    • userName – an existing UserName;
    • email – a string representing an email address.

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Data validation error – situations:
    • there is no user with the provided userName;
  • Operation error, if a database error occurs.

deleteUser()

The method removes the user that is identified by username from the system and returns the userID of the userName that was deleted if operation is successful, -1 otherwise.

The structure of the used objects may be observed in appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:DeleteUserRequest>
         <inv:userName>?</inv:userName>
      </inv:DeleteUserRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:DeleteUserResponse>
         <!--Optional:-->
         <inv:userID>?</inv:userID>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:DeleteUserResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • The userName parameter is mandatory. Only an exact match will be returned.

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Operation error, if a database error occurs.

getUserID()

The method returns the userID associated with the provided userName. The structure of the used objects may be observed in appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetUserIDRequest>
         <inv:userName>?</inv:userName>
      </inv:GetUserIDRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:GetUserIDResponse>
         <!--Optional:-->
         <inv:userID>?</inv:userID>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:GetUserIDResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • The userName parameter is mandatory. Only an exact match will be returned.

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details);
  • Operation error, if a database error occurs.

findProfile()

The method returns the profile ID, profile name and profile description associated with the provided searchProfileName. If left empty, all records are returned. Otherwise all records starting with the searchProfileName value will be returned. The structure of the used objects may be observed in appendix section of this document. The format of the request and response messages is the following:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:FindProfileRequest>
         <inv:searchProfileName>?</inv:searchProfileName>
      </inv:FindProfileRequest>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:inv="http://www.asentinel.com/asentinelws/schemas/invord">
   <soapenv:Header/>
   <soapenv:Body>
      <inv:FindProfileResponse>
         <!--Zero or more repetitions:-->
         <inv:profile>
            <!--You may enter the following 4 items in any order-->
            <inv:profileID>?</inv:profileID>
            <inv:profileName>?</inv:profileName>
            <inv:profileDescription>?</inv:profileDescription>
            <inv:builtIn>?</inv:builtIn>
         </inv:profile>
         <inv:result>
            <!--You may enter the following 2 items in any order-->
            <inv:code>?</inv:code>
            <!--Optional:-->
            <inv:message>?</inv:message>
         </inv:result>
      </inv:FindProfileResponse>
   </soapenv:Body>
</soapenv:Envelope>

Notes:

  • The searchProfileName parameter is not mandatory. The following fields will be returned: ProfileID, ProfileName, ProfileDescription, BuiltIn where ProfileName starts with searchProfileName as prefix. If the searchProfileName is empty, all profiles are returned.

Errors:

  • Message validation error - SOAP fault message (see dedicated section for more details); Operation error, if a database error occurs.

Reviews