GetCoverpageGroups
Description
This method lists the groups associated with the given cover page ID. This feature is available for Primary Users ONLY.
Formal Definition
https://ws.interfax.net/admin.asmx?op=GetCoverpageGroups
Input
| Name | Type | Comments |
|---|---|---|
| PrimaryUserID | String | The name of the user authenticating to the API |
| Password | String | The password for the username |
| coverPageId | Integer | Cover page ID to list all associated groups for |
Output
| Name | Type | Comments | |||
|---|---|---|---|---|---|
| GetCoverpageGroupsResult | Structure | An object containing the results of the query. | |||
| Status | Integer | The result of the operation: 0 for success, otherwise an error code indicating what went wrong; see the Error Codes, below. For the full list of error codes see Appendix A. | |||
| data | Array of UserGroup | Contains a list of groups, each with the following properties: | |||
| Id | Integer | ID of the user group | |||
| Name | String | Name of the user group | |||
Error Codes
| Value | Description |
|---|---|
| -150 | Internal System Error. An exception occurs at any point in the execution of the web service method. |
| -310 | The logged in user in context is not a primary user. User is not authorized to operate actions on RequestedUserID. |
| -1003 | Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user. |