Get User Details (ivnGetUserDetails)

§

This web service is invoked to get the users' details in Intelliview NXT for a given company

§

User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API.

Web Service Request:

public string ivnGetUserDetails(string SessionToken, int CompanyID, string GroupName, string UserName)

Web Service Request Parameters:

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned to
the Intelliview NXT Session

 

Company ID

Integer

The unique Identification assigned to
the Company in Intelliview NXT.

 

GroupName

String

Group Name

If the GroupName is initialized to
Null, then the list of users
defined in the company is
returned

UserName

String

User Name

If the UserName is initialized to
Null, then the list of users in the
group is returned

Web Service Response (Success):

<ResponseMessage>

<UserDetails>

<User ID= “1” UserName='robert' UserFullName='Robert Williams' GroupNameList='Author,Engineering' Emailid='robert@abc.com' RoleName='User' CreatedOn= '2013-11-25 11:15:43.887' />

</UserDetails>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7523'/>

<Response Message= 'User name is not valid'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data Type

Description

Remarks

User ID

Integer

The unique Identification assigned to
the User in Intelliview NXT.

 

UserName

String

User Name

 

GroupNameList

String

String consisting of one or more group
names

 

Email

String

User Email ID

 

RoleName

String

Name of the Role to which User
belongs

 

CreatedOn

String

Date on which User was created

 

Message ID

String

The unique identification assigned to
the response message in Intelliview
NXT.

Returned on error;

ResponseMessage

String

The Response Message is received
from Intelliview NXT.

Returned on error; Only
English Language is
supported in the current
version.

Company ID

Integer

The unique Identification assigned to
the Company by Intelliview NXT.

 

Version No

String

The last digit after the third decimal

point indicates the web service version

 

Response Messages:

Srl.No.

Message ID

Message

1

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

2

SYN_REP_ERROR_7501

Intelliview NXT session is expired or not initialized or
not valid

3

SYN_REP_ERROR_7511

Company ID is not valid

4

SYN_REP_ERROR_7523

User name is not valid

5

SYN_REP_ERROR_7560

Group name is not valid

6

SYN_REP_INFO_7581

No User is available

 

 

top.jpg

 

<< Update User (ivnUpdateUser) | Create Group (ivnCreateGroup) >>