SoftLayer Account (type)

From SoftLayer Development Network Wiki

Jump to: navigation, search

This page refers to the SoftLayer_Account data type. For information on the SoftLayer_Account service please see SoftLayer_Account.

Contents

Overview

The SoftLayer_Account data type contains general information relating to a single SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account. The SoftLayer_Account data type contains a number of relational properties that are used by the SoftLayer customer portal to quickly present a variety of account related services to it's users.

SoftLayer customers are unable to change their company account information in the portal or the API. If you need to change this information please open a sales ticket in our customer portal and our account management staff will assist you.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

accountStatusId

A number reflecting the state of an account.

  • type: int
  • length: 10 digits
  • permission: Edit Company Profile



address1

The first line of the mailing address belonging to an account.

  • type: string
  • length: 100 characters
  • permission: Edit Company Profile



address2

The second line of the mailing address belonging to an account.

  • type: string
  • length: 100 characters
  • permission: Edit Company Profile



allowedPptpVpnQuantity

The number of PPTP VPN users allowed on an account.

  • type: int
  • length: 3 digits
  • permission: Edit Company Profile



alternatePhone

A secondary phone number assigned to an account.

  • type: string
  • length: 20 characters
  • permission: Edit Company Profile



city

The city of the mailing address belonging to an account.

  • type: string
  • length: 100 characters
  • permission: Edit Company Profile



claimedTaxExemptTxFlag

Whether an account is exempt from taxes on their invoices.

  • type: boolean
  • permission: Edit Company Profile



companyName

The company name associated with an account.

  • type: string
  • length: 100 characters
  • permission: Edit Company Profile



country

A two-letter abbreviation of the country in the mailing address belonging to an account.

  • type: string
  • length: 2 characters
  • permission: Edit Company Profile



createDate

The date an account was created.

  • type: dateTime
  • permission: Edit Company Profile



email

A general email address assigned to an account.

  • type: string
  • length: 100 characters
  • permission: Edit Company Profile



faxPhone

A fax phone number assigned to an account.

  • type: string
  • length: 20 characters
  • permission: Edit Company Profile



firstName

Each customer account is listed under a single individual. This is that individual's first name.

  • type: string
  • length: 30 characters
  • permission: Edit Company Profile



id

A customer account's internal identifier. Account numbers are typically preceded by the string "SL" in the customer portal. Every SoftLayer account has at least one portal user whose username follows the "SL" + account number naming scheme.

  • type: int
  • permission: Edit Company Profile



lastName

Each customer account is listed under a single individual. This is that individual's last name.

  • type: string
  • length: 30 characters
  • permission: Edit Company Profile



lateFeeProtectionFlag

Whether an account has late fee protection.

  • type: boolean
  • permission: Edit Company Profile



modifyDate

The date an account was last modified.

  • type: dateTime
  • permission: Edit Company Profile



officePhone

An office phone number assigned to an account.

  • type: string
  • length: 20 characters
  • permission: Edit Company Profile



postalCode

The postal code of the mailing address belonging to an account.

  • type: string
  • length: 50 characters
  • permission: Edit Company Profile



state

A two-letter abbreviation of the state in the mailing address belonging to an account. If an account does not reside in a province then this is typically blank.

  • type: string
  • length: 2 characters
  • permission: Edit Company Profile



statusDate

The date of an account's last status change.

  • type: dateTime
  • permission: Edit Company Profile


Relational Properties

abuseEmail

An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.
SoftLayer_Account can have only one abuseEmail.
abuseEmail is queried by object mask.

  • type: string



activeVirtualLicenses

The virtual software licenses controlled by an account
activeVirtualLicenses is queried by object mask.



bandwidthAllotments

The bandwidth allotments for an account.
bandwidthAllotments is queried by object mask.



billingInfo

An account's billing information.
SoftLayer_Account can have only one billingInfo.
billingInfo is queried by object mask.



closedTickets

All closed tickets associated with an account.
closedTickets is queried by object mask.



domains

The DNS domains associated with an account.
domains is queried by object mask.



evaultMasterUsers

An account's master EVault user. This is only used when an account has EVault service.
evaultMasterUsers is queried by object mask.



evaultNetworkStorage

An account's associated EVault storage volumes.
evaultNetworkStorage is queried by object mask.



hardware

An account's associated hardware objects.
hardware is queried by object mask.



hardwareWithCpanel

All hardware associated with an account that has the cPanel web hosting control panel installed.
hardwareWithCpanel is queried by object mask.



hardwareWithHelm

All hardware associated with an account that has the Helm web hosting control panel installed.
hardwareWithHelm is queried by object mask.



hardwareWithPlesk

All hardware associated with an account that has the Plesk web hosting control panel installed.
hardwareWithPlesk is queried by object mask.



hardwareWithUrchin

All hardware associated with an account that has the Urchin web traffic analytics package installed.
hardwareWithUrchin is queried by object mask.



hardwareWithWindows

All hardware associated with an account that is running a version of the Microsoft Windows operating system.
hardwareWithWindows is queried by object mask.



invoices

An account's associated billing invoices.
invoices is queried by object mask.



iscsiNetworkStorage

An account's associated iSCSI storage volumes.
iscsiNetworkStorage is queried by object mask.



lastFiveClosedAbuseTickets

The five most recently closed abuse tickets associated with an account.
lastFiveClosedAbuseTickets is queried by object mask.



lastFiveClosedAccountingTickets

The five most recently closed accounting tickets associated with an account.
lastFiveClosedAccountingTickets is queried by object mask.



lastFiveClosedOtherTickets

The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
lastFiveClosedOtherTickets is queried by object mask.



lastFiveClosedSalesTickets

The five most recently closed sales tickets associated with an account.
lastFiveClosedSalesTickets is queried by object mask.



lastFiveClosedSupportTickets

The five most recently closed support tickets associated with an account.
lastFiveClosedSupportTickets is queried by object mask.



lastFiveClosedTickets

The five most recently closed tickets associated with an account.
lastFiveClosedTickets is queried by object mask.



loadBalancers

An account's associated load balancers.
loadBalancers is queried by object mask.



lockboxNetworkStorage

An account's associated Lockbox storage volumes.
lockboxNetworkStorage is queried by object mask.



nasNetworkStorage

An account's associated NAS storage volumes.
nasNetworkStorage is queried by object mask.



networkMonitorDownHardware

Hardware which is currently experiencing a service failure.
networkMonitorDownHardware is queried by object mask.



networkMonitorRecoveringHardware

Hardware which is currently recovering from a service failure.
networkMonitorRecoveringHardware is queried by object mask.



networkMonitorUpHardware

Hardware which is currently online.
networkMonitorUpHardware is queried by object mask.



networkStorage

An account's associated StorageLayer storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
networkStorage is queried by object mask.



networkVlanSpan

Whether or not an account has automatic private VLAN spanning enabled.
SoftLayer_Account can have only one networkVlanSpan.
networkVlanSpan is queried by object mask.



networkVlans

All network VLANs assigned to an account.
networkVlans is queried by object mask.



nextBillingPublicAllotmentHardwareBandwidthDetails

The allotments for this account and their servers for the next billing cycle. The public inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


nextBillingPublicAllotmentHardwareBandwidthDetails is queried by object mask.



nextInvoiceTopLevelBillingItems

The billing items that will be on an account's next invoice.
nextInvoiceTopLevelBillingItems is queried by object mask.



nextInvoiceTotalAmount

The total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
SoftLayer_Account can have only one nextInvoiceTotalAmount.
nextInvoiceTotalAmount is queried by object mask.

  • type: decimal



nextInvoiceTotalOneTimeAmount

The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
SoftLayer_Account can have only one nextInvoiceTotalOneTimeAmount.
nextInvoiceTotalOneTimeAmount is queried by object mask.

  • type: decimal



nextInvoiceTotalOneTimeTaxAmount

The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
SoftLayer_Account can have only one nextInvoiceTotalOneTimeTaxAmount.
nextInvoiceTotalOneTimeTaxAmount is queried by object mask.

  • type: decimal



nextInvoiceTotalRecurringAmount

The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
SoftLayer_Account can have only one nextInvoiceTotalRecurringAmount.
nextInvoiceTotalRecurringAmount is queried by object mask.

  • type: decimal



nextInvoiceTotalRecurringTaxAmount

The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
SoftLayer_Account can have only one nextInvoiceTotalRecurringTaxAmount.
nextInvoiceTotalRecurringTaxAmount is queried by object mask.

  • type: decimal



openTickets

All open tickets associated with an account.
openTickets is queried by object mask.



pendingInvoice

An account's latest open (pending) invoice.
SoftLayer_Account can have only one pendingInvoice.
pendingInvoice is queried by object mask.



pendingInvoiceTopLevelItems

A list of top-level invoice items that are on an account's currently pending invoice.
SoftLayer_Account can have only one pendingInvoiceTopLevelItems.
pendingInvoiceTopLevelItems is queried by object mask.

  • type: [[]]



pendingInvoiceTotalAmount

The total amount of an account's pending invoice, if one exists.
SoftLayer_Account can have only one pendingInvoiceTotalAmount.
pendingInvoiceTotalAmount is queried by object mask.

  • type: [[]]



pendingInvoiceTotalOneTimeAmount

The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes.
SoftLayer_Account can have only one pendingInvoiceTotalOneTimeAmount.
pendingInvoiceTotalOneTimeAmount is queried by object mask.

  • type: [[]]



pendingInvoiceTotalOneTimeTaxAmount

The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.
SoftLayer_Account can have only one pendingInvoiceTotalOneTimeTaxAmount.
pendingInvoiceTotalOneTimeTaxAmount is queried by object mask.

  • type: [[]]



pendingInvoiceTotalRecurringAmount

The total recurring amount of an account's pending invoice, if one exists.
SoftLayer_Account can have only one pendingInvoiceTotalRecurringAmount.
pendingInvoiceTotalRecurringAmount is queried by object mask.

  • type: [[]]



pendingInvoiceTotalRecurringTaxAmount

The total amount of the recurring taxes on an account's pending invoice, if one exists.
SoftLayer_Account can have only one pendingInvoiceTotalRecurringTaxAmount.
pendingInvoiceTotalRecurringTaxAmount is queried by object mask.

  • type: [[]]



pptpVpnUsers

An account's associated portal users with PPTP VPN access.
pptpVpnUsers is queried by object mask.



privateAllotmentHardwareBandwidthDetails

The allotments for this account and their servers. The private inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


privateAllotmentHardwareBandwidthDetails is queried by object mask.



privateNetworkVlans

The private network VLANs assigned to an account.
privateNetworkVlans is queried by object mask.



privateSubnets

All private subnets associated with an account.
privateSubnets is queried by object mask.



publicAllotmentHardwareBandwidthDetails

The allotments for this account and their servers. The public inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


publicAllotmentHardwareBandwidthDetails is queried by object mask.



publicNetworkVlans

The public network VLANs assigned to an account.
publicNetworkVlans is queried by object mask.



publicSubnets

All public network subnets associated with an account.
publicSubnets is queried by object mask.



rwhoisData

An account's reverse WHOIS data. This data is used when making SWIP requests.
SoftLayer_Account can have only one rwhoisData.
rwhoisData is queried by object mask.



sslVpnUsers

An account's associated portal users with SSL VPN access.
sslVpnUsers is queried by object mask.



tickets

An account's associated tickets.
tickets is queried by object mask.



users

An account's portal users.
users is queried by object mask.



virtualPrivateRack

The virtual private rack for this account.
SoftLayer_Account can have only one virtualPrivateRack.
virtualPrivateRack is queried by object mask.


Count Properties

hardwareCount

A count of an account's associated hardware objects.
hardwareCount is queried by object mask.

  • type: int



invoiceCount

A count of an account's associated billing invoices.
invoiceCount is queried by object mask.

  • type: int



domainCount

A count of the DNS domains associated with an account.
domainCount is queried by object mask.

  • type: int



userCount

A count of an account's portal users.
userCount is queried by object mask.

  • type: int



networkVlanCount

A count of all network VLANs assigned to an account.
networkVlanCount is queried by object mask.

  • type: int



publicNetworkVlanCount

A count of the public network VLANs assigned to an account.
publicNetworkVlanCount is queried by object mask.

  • type: int



privateNetworkVlanCount

A count of the private network VLANs assigned to an account.
privateNetworkVlanCount is queried by object mask.

  • type: int



lockboxNetworkStorageCount

A count of an account's associated Lockbox storage volumes.
lockboxNetworkStorageCount is queried by object mask.

  • type: int



networkStorageCount

A count of an account's associated StorageLayer storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.
networkStorageCount is queried by object mask.

  • type: int



nasNetworkStorageCount

A count of an account's associated NAS storage volumes.
nasNetworkStorageCount is queried by object mask.

  • type: int



iscsiNetworkStorageCount

A count of an account's associated iSCSI storage volumes.
iscsiNetworkStorageCount is queried by object mask.

  • type: int



evaultNetworkStorageCount

A count of an account's associated EVault storage volumes.
evaultNetworkStorageCount is queried by object mask.

  • type: int



evaultMasterUserCount

A count of an account's master EVault user. This is only used when an account has EVault service.
evaultMasterUserCount is queried by object mask.

  • type: int



loadBalancerCount

A count of an account's associated load balancers.
loadBalancerCount is queried by object mask.

  • type: int



pptpVpnUserCount

A count of an account's associated portal users with PPTP VPN access.
pptpVpnUserCount is queried by object mask.

  • type: int



sslVpnUserCount

A count of an account's associated portal users with SSL VPN access.
sslVpnUserCount is queried by object mask.

  • type: int



publicSubnetCount

A count of all public network subnets associated with an account.
publicSubnetCount is queried by object mask.

  • type: int



privateSubnetCount

A count of all private subnets associated with an account.
privateSubnetCount is queried by object mask.

  • type: int



hardwareWithWindowCount

A count of all hardware associated with an account that is running a version of the Microsoft Windows operating system.
hardwareWithWindowCount is queried by object mask.

  • type: int



hardwareWithCpanelCount

A count of all hardware associated with an account that has the cPanel web hosting control panel installed.
hardwareWithCpanelCount is queried by object mask.

  • type: int



hardwareWithPleskCount

A count of all hardware associated with an account that has the Plesk web hosting control panel installed.
hardwareWithPleskCount is queried by object mask.

  • type: int



hardwareWithHelmCount

A count of all hardware associated with an account that has the Helm web hosting control panel installed.
hardwareWithHelmCount is queried by object mask.

  • type: int



hardwareWithUrchinCount

A count of all hardware associated with an account that has the Urchin web traffic analytics package installed.
hardwareWithUrchinCount is queried by object mask.

  • type: int



activeVirtualLicenseCount

A count of the virtual software licenses controlled by an account
activeVirtualLicenseCount is queried by object mask.

  • type: int



ticketCount

A count of an account's associated tickets.
ticketCount is queried by object mask.

  • type: int



openTicketCount

A count of all open tickets associated with an account.
openTicketCount is queried by object mask.

  • type: int



closedTicketCount

A count of all closed tickets associated with an account.
closedTicketCount is queried by object mask.

  • type: int



lastFiveClosedTicketCount

A count of the five most recently closed tickets associated with an account.
lastFiveClosedTicketCount is queried by object mask.

  • type: int



lastFiveClosedAbuseTicketCount

A count of the five most recently closed abuse tickets associated with an account.
lastFiveClosedAbuseTicketCount is queried by object mask.

  • type: int



lastFiveClosedAccountingTicketCount

A count of the five most recently closed accounting tickets associated with an account.
lastFiveClosedAccountingTicketCount is queried by object mask.

  • type: int



lastFiveClosedSalesTicketCount

A count of the five most recently closed sales tickets associated with an account.
lastFiveClosedSalesTicketCount is queried by object mask.

  • type: int



lastFiveClosedSupportTicketCount

A count of the five most recently closed support tickets associated with an account.
lastFiveClosedSupportTicketCount is queried by object mask.

  • type: int



lastFiveClosedOtherTicketCount

A count of the five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.
lastFiveClosedOtherTicketCount is queried by object mask.

  • type: int



nextInvoiceTopLevelBillingItemCount

A count of the billing items that will be on an account's next invoice.
nextInvoiceTopLevelBillingItemCount is queried by object mask.

  • type: int



bandwidthAllotmentCount

A count of the bandwidth allotments for an account.
bandwidthAllotmentCount is queried by object mask.

  • type: int



publicAllotmentHardwareBandwidthDetailCount

A count of the allotments for this account and their servers. The public inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


publicAllotmentHardwareBandwidthDetailCount is queried by object mask.

  • type: int



nextBillingPublicAllotmentHardwareBandwidthDetailCount

A count of the allotments for this account and their servers for the next billing cycle. The public inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


nextBillingPublicAllotmentHardwareBandwidthDetailCount is queried by object mask.

  • type: int



privateAllotmentHardwareBandwidthDetailCount

A count of the allotments for this account and their servers. The private inbound and outbound

                                   bandwidth is calculated for each server in addition to the daily average network traffic
                                   since the last billing date.


privateAllotmentHardwareBandwidthDetailCount is queried by object mask.

  • type: int



networkMonitorRecoveringHardwareCount

A count of hardware which is currently recovering from a service failure.
networkMonitorRecoveringHardwareCount is queried by object mask.

  • type: int



networkMonitorUpHardwareCount

A count of hardware which is currently online.
networkMonitorUpHardwareCount is queried by object mask.

  • type: int



networkMonitorDownHardwareCount

A count of hardware which is currently experiencing a service failure.
networkMonitorDownHardwareCount is queried by object mask.

  • type: int

Associated Methods

Personal tools