API Group

Read.

Reads the user Groups. If no Group Code GrpCode parameter is supplied then all Groups will be returned. If a Group Code GrpCode is supplied then only that Group will be returned.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.Security.Group_API.Read

Parameters:

Name	Type	Default	Description
`GrpCode`	String		Code to identify the Group

Return: Array [ Object ]

Name	Type	Description
`GrpCode`	String	Group Code to identify the Group
`GrpName`	String	Name of the Group
`GrpContactName`	String	First and last name of the Group Contact
`GrpContactPhone`	String	Group Contact Phone number
`GrpContactEmail`	String	Group Contact email address
`CcnCount`	Int	Number of users in the Group
`MtrCount`	Int	Number of Tables assigned to the Group

ReadAccess.

Reads the user Groups to which a user has access. If no CcnUsername is supplied then it is assumed that the request is for the current user. If the user is a Power User or Admin, all groups are returned. Otherwise only the groups to which the user has been assigned are returned.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.Security.Group_API.ReadAccess

Parameters:

Name	Type	Default	Description
`CcnUsername`	String		AD username

Return: Array [ Object ]

Name	Type	Description
`GrpCode`	String	Group Code to identify the Group
`GrpName`	String	Name of the Group
`GrpContactName`	String	First and last name of the Group Contact
`GrpContactPhone`	String	Group Contact Phone number
`GrpContactEmail`	String	Group Contact email address

Create.

Creates a new Group.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.Security.Group_API.Create

Parameters:

Name	Type	Description
`GrpCode`	String	Unique Code for the Group
`GrpName`	String	Group Name
`GrpContactName`	String	Contact name for the Group
`GrpContactPhone`	String	Phone number of Group Contact
`GrpContactEmail`	String	Email address of Group Contact

Return: Return: String with value of success

Update.

Updates an existing Group entry. To allow for changes to the GrpCode, two parameters are passed in, i.e. the old GrpCode and the new GrpCode. If the GrpCode is to be unchanged, then both of these parameters should hold the same value.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.Security.Group_API.Update

Parameters:

Name	Type	Description
`GrpCodeOld`	String	Existing code for the Group
`GrpCodeNew`	String	New code for the Group
`GrpName`	String	Group Name
`GrpContactName`	String	Contact name for the Group
`GrpContactPhone`	String	Phone number of Group Contact
`GrpContactEmail`	String	Email address of Group Contact