GetUserSettings
Description
The GetUserSettings() method returns all user's settings. These settings are also controlled from the Control Panel website.
Formal Definition
https://api.postalmethods.com/2009-09-09/AdminTools.asmx?op=GetUserSettings
Input
| Property | Type | Comments |
|---|---|---|
| APIKey | String | The API key of the administrator user |
| Username | String | The username who's settings are to be returned |
Output: GetUserSettingsResponse
Structure: GetDetailsResult
| Element | Type | Comments |
|---|---|---|
| ResultCode | int | Result code for this Web Service request. Possible result codes appear in the Web Service Result Codes list. |
| Settings | Structure | Provided settings are returned in the following structures: |
Structure: General
| Element | Type | Comments |
|---|---|---|
| Username | string | User's username |
| Description | string | User's name / description. |
| Timezone | string | User's time zone is needed in order to display any date/time value in the user's time. Time zone is returned in a Zone Info format. |
| WorkMode | enumeration | User's Work Mode. either Production or Development. |
Structure: Security
| Element | Type | Comments |
|---|---|---|
| AdministrativeEmail | string | User's Administrative email is used for password retrieval and general error messages. |
| KeepContentOnServer | Boolean |
Determines whether message contents sent via PostalMethods are retained in the system for your reference, or deleted immediately to comply with enhanced privacy requirements. |
Structure: Letters
| Element | Type | Comments |
|---|---|---|
| PrintColor | enumeration | BlackAndWhite or FullColor. Default color of the ink used when printing a letter. |
| PrintSides | enumeration | Simplex or Duplex. For multi-page mail items: Simplex: each page is printed on a single sheet of paper. Duplex: two consecutive pages are printed on a single sheet of paper. |
| PageOrientation | enumeration | Portrait or Landscape. Default printing orientation for documents which do not have an orientation property, such as HTML. Documents such as PDF and MS-Word use their document properties and are not affected by this setting. |
| EnvelopeType | string | Default envelope used to send your letter. Currently, we offer a professional business envelope: Number 10, white, double window, 24lb envelope. |
| PaperSize | string | Default size of paper used for printing letters. Currently, the only supported size is Letter (8.5in by 11in). |
| PaperQuality | string | Default quality/thickness of a paper used for printing mail items. Currently, the only supported paper is 24lb. Bond (equals 60lb. Offset and 80gr.) which is most commonly used for business mail. |
| PaperColor | string | Default color of paper used for printing letters. Currently, the only supported color is white. |
| NationalMailing | string | Default mailing priority for mail items sent within the USA. Currently only First-Class Mail is supported. |
| InternationalMailing | string | Default mailing priority for mail items sent to destinations outside the USA. Currently only First-Class International Mail is supported. |
Structure: Postcards
| Element | Type | Comments |
|---|---|---|
| ScaleImage | string | Default scaling options when using images for postcards: No Scaling: Specified image is used as-is and is not re-sized in case it is too small or too large. Scale To Size: Specified image is re-sized in case it is too small or too large. |
| PrintColor | enumeration | BlackAndWhite or FullColor. Default color of the ink used when printing a postcard. Currently postcards are printed in Full Color only. |
| PostcardSize | string | Determines default postcard size. Currently, postcard trim size is 4" x 6". Postcards are printed with a 0.125" bleed so bleed size is 4.25" x 6.25". |
| NationalMailing | string | Default mailing priority for mail items sent within the USA. Currently only First-Class Mail is supported. |
| InternationalMailing | string | Currently postcards are only sent nationally. Default mailing priority for mail items sent to destinations outside the USA. Currently only First-Class International Mail is supported. |
Structure: Feedback
| Element | Type | Comments |
|---|---|---|
| FeedbackType | Enumeration | None or Email or Soap or Post. A feedback message may be sent upon specified events of the mail item's life-cycle. Read more about Push Feedback. |
| Feedback | Structure | According to the active feedback type, one of the following structures is returned:
Nothing is returned when feedback type is set to None. |
Structure: EmailSettings
| Element | Type | Comments |
|---|---|---|
| WhenToSend_EmailReceived | Boolean | An email message is sent to report that the user's email was received and is being processed. |
| WhenToSend_Completed | Boolean | An email message is sent to report that the mail item is now in the postal stream. |
| WhenToSend_Error | Boolean | An email message is sent to report that there has been a problem with the mail item. |
| WhenToSend_BatchErrors | Boolean | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique email message is sent on error to each individual document (not recommended). |
| DefaultFeedbackEmail | string | Feedback email messages are normally sent to the email address which originated the mail item. If a mail item is originated via Web Service, or if you would like to always get feedback to a specific email address, set it as the Default Feedback Email. |
| Authentication | string | PostalMethods will provide the authentication (AUTH) string in the feedback email header. You may validate this string to make sure it is coming from PostalMethods. If not populated, this X-header will not appear in the message header. |
Structure: SoapSettings
| Element | Type | Comments |
|---|---|---|
| WhenToSend_Completed | Boolean | A request is sent to report that the mail item is now in the postal stream. |
| WhenToSend_Error | Boolean | A request is sent to report that there has been a problem with the mail item. |
| WhenToSend_BatchErrors | Boolean | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique email message is sent on error to each individual document (not recommended). |
| FeedbackURL | string | The URL to where feedback requests are sent. |
| Authentication | string | The authentication (AUTH) string is sent by PostalMethods when feedback type is SOAP XML. You may validate this string to make sure it is coming from PostalMethods. |
Structure: PostSettings
| Element | Type | Comments |
|---|---|---|
| WhenToSend_Completed | Boolean | A request is sent to report that the mail item is now in the postal stream. |
| WhenToSend_Error | Boolean | A request is sent to report that there has been a problem with the mail item. |
| WhenToSend_BatchErrors | Boolean | When using the PostalMethods Web Service or the PostalMethods Word 2007 Mail Merge Add-in , a unique request is sent on error to each individual document (not recommended). |
| FeedbackURL | string | The URL to where feedback requests are sent. |
| Authentication | string | The authentication (AUTH) string is sent by PostalMethods when feedback type is HTTP POST. You may validate this string to make sure it is coming from PostalMethods. |
Change Log
- Rename "GetLetterDetailsV2" to "GetDetails"
- Change "ID" type to string to allow getting details for multiple and range of items.
- Results are provided as an array.