Get Group Details (ivnGetGroupDetails)

§

This web service is invoked to get the details of the groups defined 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 ivnGetGroupDetails(string SessionToken, int CompanyID, string GroupName)

Web Service Request Parameters:

Parameters

Data Type

Description

Remarks

SessionToken

String

The unique Identification assigned to
the Intelliview NXT Session

 

CompanyID

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 Groups defined in
the company is returned

Web Service Response (Success):

<ResponseMessage>

<GroupDetails>

<Group ID= “1” GroupName='Sales ' GroupDescription='Sales Department' GroupType='User' UserNameList='robert, william'/>

</GroupDetails>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7560'/>

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

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data Type

Description

Remar
ks

Group ID

Integer

The unique Identification assigned to the
Group in Intelliview NXT.

 

GroupName

String

Group Name

 

GroupDescription

String

Group Description

 

GroupType

String

Group Type

 

Message ID

String

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

 


Response
Message

String

The Response Message is received from
Intelliview NXT.

Company ID

Integer

The unique Identification assigned to the
Company in Intelliview NXT

Version

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_7501

Intelliview NXT session is expired or not initialized or
not valid

2

SYN_REP_ERROR_7511

Company ID is not valid

3

SYN_REP_ERROR_7560

Group name is not valid

4

SYN_REP_INFO_7569

No Group is available

5

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

 

 

top.jpg

 

<< Update Group Details (ivnUpdateGroup)