 | Cloud Fax and Notifications Account API 2.4 Documentation CustomerCreate | Cloud Fax and Notifications API Forums Home |
7.2 CustomerCreateRequest | CustomerCreate Overview CustomerCreateResult |
| Tag Name & type | # | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| CustomerCreateRequest | Namespace of this element is http://premconn.premiereconnect.com/CustomerCreate/2008/10 | |||||||||||
| SubmitId xs:string | 0-1 | Optional string identifying request, which will be echoed in result. | ||||||||||
| CustomerName EncodableStringType | 1 | Name of the customer. See EncodableStringType. | ||||||||||
| OEMAccountNo xs:string | 0-1 | An optional, external account identifier provided by the creator of the account. (Ignored for "retail" account.) | ||||||||||
| ModelCustomer xs:long | 1 | CAN of the model customer. Many profile and account settings are copied from the model customer. The values that can be used by any given requester for this need to be set up by prior arrangement with EasyLink. | ||||||||||
| SalesRep EncodableStringType | 0-1 | Sales representative of the customer. See EncodableStringType, although this value should be a numeric code. Only applies to regular account. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and need to be determined with EasyLink. | ||||||||||
| DealerId EncodableStringType | 0-1 | Dealer id of the customer. See EncodableStringType, although this value should be a numeric code. Only applies to regular account. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and possibly the SalesRep value, and need to be determined with EasyLink. | ||||||||||
| SupportRep EncodableStringType | 0-1 | Support representative of the customer. See EncodableStringType, although this value should be a numeric code. Only applies to regular account. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and need to be determined with EasyLink. | ||||||||||
| CustomerAddress AcctAddressType | 1 | Address of the customer. See AcctAddressType. For retail accounts, the CustomerBillingAddress will override this value. | ||||||||||
| CustomerContact AcctContactType | 1 | Contact details of the customer. See AcctContactType. For retail accounts, the CustomerBillingContact will override this value. | ||||||||||
| AdminContact AcctContactType | 0-1 | Admin contact details of the customer. See AcctContactType. Only applies to, and is required for, regular account. | ||||||||||
| AdminFax xs:string | 0-1 | Admin fax number of the customer. Only applies to regular account. | ||||||||||
| CustomerBillingAddress AcctAddressType | 0-1 | Billing address of the customer. See AcctAddressType. Defaults to CustomerAddress. For retail accounts, credit card validation will use this information, if provided - if it is not, the CustomerAddress information will be used. | ||||||||||
| CustomerBillingContact AcctContactType | 0-1 | Billing contact details of the customer. See AcctContactType. Defaults to CustomerContact. For retail accounts, credit card validation will use this information, if provided - if it is not, the CustomerContact information will be used. | ||||||||||
| CustomerAccountStatus AcctServiceStatusType | 0-1 | Account status of the customer. The legal values are:
| ||||||||||
| XDDSDomain xs:string | 0-1 | Primary EasyLink switch domain. For a regular account, this will default to the effective requester's primary XDDS domain. For a retail account, an attempt will be made to determine an appropriate domain based on the AddressCountry value of the CustomerBillingAddress (or CustomerAddress). This is only possible for selected country names, and if a domain cannot be determined, request processing will not proceed. | ||||||||||
| AltXDDSDomain xs:string | 0-1 | Alternate EasyLink switch domain. | ||||||||||
| MRDomain xs:string | 0-1 | Primary EasyLink messageREACH domain. Only applies to regular accounts, with default taken from ModelCustomer. | ||||||||||
| AltMRDomain xs:string | 0-1 | Alternate EasyLink messageREACH domain. Only applies to regular accounts, with default taken from ModelCustomer. | ||||||||||
| AccessGroup xs:string | 0-1 | Access group of the customer. Controls the domains in which the user is considered valid. For retail accounts, this will default to "F2MUSER". | ||||||||||
| Application xs:int | 0-1 | Code for the application associated with the account. Only applies to regular account. The default is "0". Contact EasyLink for acceptable and appropriate values. | ||||||||||
| Business xs:int | 0-1 | Code for the customer business type. Only applies to regular account. The default is "99". Contact EasyLink for acceptable and approparite values. | ||||||||||
| Currency xs:int | 0-1 | Code for currency type. For retail account, the default is "1" for USD. For regular account, the default is taken from the ModelCustomer. | ||||||||||
| PromoCode xs:string | 0-1 | Promotion code for the account. For regular accounts, the default is taken from the ModelCustomer. | ||||||||||
| QuotaInfo QuotaInfoType | 0-1 | Quota information of the customer. See QuotaInfoType. Note that a "list" type for QuotaNotifyAddress is not allowed at account creation. For retail accounts, only the UseQuota child element is used, and defaults to "true". | ||||||||||
| F2MRetailCustomerInfo | 0-1 | Retail customer information for F2M account. The Cloud Fax and Notifications API no longer accepts credit card information, so this element can not be used, effectively removing the ability to create a retail F2M account. | ||||||||||
| ProfileInfo | 0-1 | A provision for future setting of customer-level profile elements at account creation time. Currently not available. The ProfileUpdate function may be used for this purpose once the account has been created. | ||||||||||
| ProfileItem ProfileItemType | 1- | See ProfileItemType. | ||||||||||
| CustomerExtensions ExtensionType | 0-1 | Customer extensions. This element may be used to permit access to customer options not otherwise accessible through the Cloud Fax and Notifications API schema. See ExtensionType. The properties recognized in CustomerExtensions include:
| ||||||||||
| InitialUserInfo | 1 | Contains information for the initial user set up for this customer account. An initial user is always created for a new customer account. For retail F2M accounts, this is normally the only user, and has administrator privileges. | ||||||||||
| UserId xs:string | 0-1 | The externally known user id. A UserId may contain up to 15 ASCII alphanumeric characters, '.', '/, '#, and '_'. (Note especially that a UserId may not contain spaces.) A UserId is required when creating a regular account. UserId is ignored when creating a retail F2M account (users of such accounts may not need to know their UserId), and one will be fabricated in this case. | ||||||||||
| Password xs:string | 0-1 | Password for the initial user. Required for retail F2M account creation, but a Password will be fabricated for a regular account. | ||||||||||
| SecurityInfo SecurityInfoType | 0-1 | See SecurityInfoType. | ||||||||||
| UserName EncodableStringType | 1 | Name of the user. | ||||||||||
| UserAccountStatus AcctServiceStatusType | 0-1 | Specifies the initial status of the user account. For retail F2M accounts, this defaults to "active", but may also be set to "pending". No other values will be accepted. For regular accounts, this defaults to "active", but may also be set to "cancelled", "suspended", "inactive", "deleted", "pending", or "hold". | ||||||||||
| UserAddress AcctAddressType | 1 | Address for the user account. See AcctAddressType. | ||||||||||
| UserContact AcctContactType | 1 | Contact information for user. See AcctContactType. The Phone field is required in UserContact. | ||||||||||
| TechnicalAddress AcctAddressType | 0-1 | An address to be used for technical issues. For regular accounts, this defaults to the UserAddress. This element is ignored for retail F2M accounts. See AcctAddressType. | ||||||||||
| TechnicalContact AcctContactType | 0-1 | A contact to be used for technical issues. For regular accounts, this defaults to the UserContact. If TechnicalContact is present, then the Phone child element is required. This element is ignored for retail F2M accounts. See AcctContactType. | ||||||||||
| ShippingAddress AcctAddressType | 0-1 | User's shipping address. For regular accounts, this defaults to the UserAddress. This element is ignored for retail F2M accounts. See AcctAddressType. | ||||||||||
| Mbox xs:boolean | 0-1 | Indicates whether or not the user will have an XDDS "mailbox". This element is ignored for retail F2M accounts. | ||||||||||
| ReportAddress DestinationType | 0-1 | The address to be used for EasyLink delivery reports. See DestinationType. Note that a "list" type for ReportAddress is not allowed at account creation. Required for a regular account. Ignored for a retail account. | ||||||||||
| Fax2MailData | 0-1 | Required for retail account, ignored for regular account. | ||||||||||
| Service F2MServiceType | 1-2 | Specifies the services for this user. Legal values are:
| ||||||||||
| M2FAlias xs:string | 0-1 | Email address used as the alias for the initial user. If this is not provided UserContact/ContactEmail will be used. | ||||||||||
| DNIS xs:string | 1 | If Fax2Mail service is included, this can specify the particular fax number to be assigned to this user. The number must already be in the pool of available fax numbers. If Fax2Mail service is requested, either DNIS or DNISSelection must be present. | ||||||||||
| DNISSelection | 1 | As an alternative to specifying the fax number, this element can specify some characteristics of the desired fax number, and a match will be sought. If Fax2Mail service is requested, either DNIS or DNISSelection must be present. | ||||||||||
| CountryCode xs:string | 1 | Country code to be matched | ||||||||||
| AreaCode xs:string | 0-1 | Area code to be matched | ||||||||||
| ExchangeCode xs:string | 0-1 | Exchange code to be matched | ||||||||||
| DNISGroup xs:long | 0-1 | The entity number associated with a pool of available numbers. For normal retail F2M account creation, this should be omitted. | ||||||||||
| DefaultProfile xs:int | 0-1 | A numeric code for a set of profile values that will be used by default for the new user. Contact EasyLink for value(s) appropriate to an application. For retail F2M account creation, a default profile may be specified via the VirtualDomain. The ProfileDefault element will override a VirtualDomain setting. If no default profile value is found, the request will fail. The VirtualDomain is determined by looking for a CustomerExtension setting (see ExtensionType) or if that is not specified, looking for a setting in the effective requester.s profile. This element is ignored for a regular account. | ||||||||||
| ProfileInfo | 0-1 | Profile fields may be set for the initial user at account creation time. See ProfileItemType. Note that some profile fields may be set based on other information in the request, and an attempt to set them again using this element may result in request failure. The fields that should be avoided include:
| ||||||||||
| ProfileItem ProfileItemType | 1- | See ProfileItemType. | ||||||||||
| UserExtensions ExtensionType | 0-1 | See ExtensionType. No extension fields are currently defined. | ||||||||||
| © Copyright 2020 OpenText Corp. All Rights Reserved. Privacy Policy | Cookie Policy |
This information is subject to change. Please check frequently for updates. Modified October 06, 2020 |