UpdateCoverpage
Description
This method updates a cover page and returns it. This feature is available for Primary users ONLY.
Formal Definition
https://ws.interfax.net/admin.asmx?op=UpdateCoverpage
Input
| Name | Type | Comments | |
|---|---|---|---|
| PrimaryUserID | String | The name of the user authenticating to the API | |
| Password | String | The password for the username | |
| coverPage | Structure | An object containing the cover page properties | |
| AccountId | Integer | Account ID of the logged in user | |
| Name | String | Name of the cover page | |
| HtmlBody | String | The body of the cover page as HTML | |
| BinaryBody | List<byte> | The body of the cover page as binary content | |
| Header | String | The header of the cover page | |
| Footer | String | The footer of the cover page | |
| Type | Integer | The cover page type. Possible values: 0 = message only, 1 = Html, 2 = PDF | |
| CoverpageBodyType | Integer | The type of the cover page body. Possible values: 0 = None, 1 = Text, 2 = Html | |
| IsPublic | Boolean | Whether the cover page is public or private | |
Output
| Name | Type | Comments | ||
|---|---|---|---|---|
| UpdateCoverpageResult | Structure | An object containing the results of the operation. | ||
| ResultCode | 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. | ||
| Coverpage | Structure | Contains a list of properties of the updated cover page | ||
| AccountId | Integer | Account ID of the logged in user | ||
| Name | String | Name of the cover page | ||
| HtmlBody | String | The body of the cover page as HTML | ||
| BinaryBody | List<byte> | The body of the cover page as binary content | ||
| Header | String | The header of the cover page | ||
| Footer | String | The footer of the cover page | ||
| Type | Integer | The cover page type. Possible values: 0 = message only, 1 = Html, 2 = PDF | ||
| CoverpageBodyType | Integer | The type of the cover page body. Possible values: 0 = None, 1 = Text, 2 = Html | ||
| IsPublic | Boolean | Whether the cover page is public or private | ||
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. |
| -40404 | The requested cover page does not exist. |