Professional Documents
Culture Documents
XML Integration With AE 11 0 5 For Import and Export Schemas
XML Integration With AE 11 0 5 For Import and Export Schemas
XML Integration With AE 11 0 5 For Import and Export Schemas
7/26/2016
ARGUS Software – An Altus Group Company
XML Integration ARGUS Enterprise
XML Integration
7/26/2016
Published by:
ARGUS Software, Inc.
750 Town and Country Blvd
Suite 800
Houston, TX 77024
Telephone (713) 621-4343
Facsimile (713) 621-2787
www.argussoftware.com
Information in this document is subject to change without notice and represents no commitment on the part of
ARGUS Software, Inc.
This document is copyright 2016, ARGUS Software, Inc. All rights reserved. This document is a confidential and
proprietary trade secret of ARGUS Software, made available only under a license agreement and or other
agreements containing obligations of confidentiality.
"ARGUS" and “ARGUS Enterprise” are trademarks of ARGUS Software, Inc. All other trademarks and registered
trademarks are property of their respective companies.
Table of Contents
Purpose ..........................................................................................................................................................................7
Users ..............................................................................................................................................................................1
Overview ........................................................................................................................................................................2
AEIX Formatted Data .....................................................................................................................................................3
AEEX Formatted Data ....................................................................................................................................................4
General Import Rules ................................................................................................................................................4
Validation Actions Table .......................................................................................................................................6
AEIX XML Data Structure ...............................................................................................................................................9
Property Data ............................................................................................................................................................9
Classification Data ...................................................................................................................................................11
Budget Data.............................................................................................................................................................11
Actuals Data ............................................................................................................................................................12
Forecast Data ..........................................................................................................................................................12
Recovery Structure Data .........................................................................................................................................13
Recovery Method Data ...........................................................................................................................................13
Tenant Data .............................................................................................................................................................15
Lease Type ...............................................................................................................................................................16
Actual Type of Lease................................................................................................................................................17
Upon Expiration.......................................................................................................................................................17
Lease Break Data .....................................................................................................................................................18
Base Rent Data ........................................................................................................................................................18
Fixed Steps Data ......................................................................................................................................................19
Free Rent Data.........................................................................................................................................................19
Percentage Rent Data .............................................................................................................................................19
Tenant Improvements Data ....................................................................................................................................20
Leasing Commissions Data ......................................................................................................................................21
Miscellaneous Rent Data .........................................................................................................................................21
Incentive Data .........................................................................................................................................................22
Recovery Data .........................................................................................................................................................22
OptionTenant Data ..................................................................................................................................................23
Operating Expense Data ..........................................................................................................................................24
Non-Operating Expense Data ..................................................................................................................................24
Capital Expense Data ...............................................................................................................................................24
Other Debt Data ......................................................................................................................................................25
ValidationRuleOverride .......................................................................................................................................80
ChartOfAccounts .................................................................................................................................................81
Account ...............................................................................................................................................................82
ImportAccountResult ..........................................................................................................................................83
ImportChartOptions ............................................................................................................................................84
ExportChartOptions ............................................................................................................................................84
Accessing the Data Service Interface ......................................................................................................................84
Using the Data Integration Service..........................................................................................................................89
Line Item Types for Chart of Accounts Import ........................................................................................................92
Purpose
The purpose of this document is to communicate the data elements of XML Integration within ARGUS Enterprise
11.0.5 for the purposes for importing and exporting data. See ARGUS Enterprise 11.0.5 Help Documentation for
additional information regarding the importing and exporting process.
XML Integration ARGUS Enterprise
Users
Users who import data should have a basic understanding of how the model will be updated by the data imported,
the basic validation messages which may occur during an import, and how to handle these validation warning
messages.
Overview
The import and export of data is achieved either through the application user interface or programmatically via a
web service interface.
Supported formats are:
• ARGUS Enterprise Import XML format (AEIX). This data format is used to import property data from third party
systems and other AE systems. ARGUS Enterprise 11.0.5 can also export existing property data into an AEIX
format for importing into other systems.
• ARGUS Enterprise Export XML format (AEEX). This data format is used to export data from ARGUS Enterprise
11.0.5 for the purposes of providing reporting information to external sources.
Note: This option is mutually exclusive to forecast data imports, as they provide similar functions that
could conflict if loaded to the same model.
• Capital Expense Data – input data that represents a simplified version of the capital expense modeling data. This
data permanently overwrites revenue and expense modeled entries and thus should be treated with care.
Note: This option is mutually exclusive to forecast data imports, as they provide similar functions that
could conflict if loaded at the same time.
• Tenant Data – input data that represents a simplified version of the tenant modeling data. This data permanently
overwrites lease modeled entries and thus should be treated with care.
• Classification Data – property classifications can be used to filter and categorize properties.
2. If the property data references a chart of accounts other than the chart of accounts assigned to the
scenario into which you are importing, the property data is converted to the scenario chart if a conversion
mapping exists.
3. If a matching lease ID is found in the tenant data and the lease data of the model, the tenant data is used
to update the lease; otherwise, a new unit/lease combination is created.
4. If a matching account number is found in the operating expense data and the operating expenses in the
model, then the model operating expense is updated; otherwise, a new operating expense is created.
5. If a matching account number is found in the capital expense data and the operating expenses in the
model, then the model capital expense is updated; otherwise, a new capital expense is created.
6. If the capital expense group code matches an existing expense group, and the capital expense in not a
member of the expense group, then the capital expense is added to the expense group. Otherwise, an
expense group is created, and the capital expense is added to the group.
7. If an account number matches an existing actual data item in the model, the actuals data will update the
existing model record; otherwise, a new record will be created. The status of the record will be changed
to imported if it was previously set to manual entry and further manual entry will be prohibited for this
record.
8. If an account number matches an existing budget data item in the model, the budget data will update the
existing model record; otherwise, a new record will be created. The status of the record will be changed
to imported if it was previously set to manual entry, and further manual entry will be prohibited for this
record.
9. If a forecast data records account number matches an account definition in the property asset chart of
accounts, and the account line item type is an operating expense, capital expense, or other revenue, then
the forecast record will be processed as one of these types. Otherwise, if no match is found, and the
GLAccountType is set in the Forecast Data Record, this type will be used to process the record as a specific
operating expense, capital expense, or other revenue.
10. Revenue and Expense data should be imported with a positive sign for the resulting entries to be
calculated correctly by the system. The exceptions to this rule are items which are generally treated as
contra accounts. The following revenue contra accounts should be imported with a negative sign:
TotalLostAbsorptionAndTurnover 5012
RentAbatement 2003
StraightLineRentAdjustment 2021
FreeCPI 2063
FreePercentageRent 2064
FreeRecovery 2065
FreeMiscellaneousRent 3041
PercentageRentOffset 2124
CollectionLoss 7001
GeneralVacancy 6001
MultiFamilyRevenueLossToLease 3201
MultiFamilyVacancyAllowance 3205
MultiFamilyRevenueFreeRent 3203
MultiFamilyCreditLossAmt 3213
MultiFamilyAdditionalConcessionsAmt 3210
SecurityDeposits 2163
DistributedDepositInvestments 2167
MultiFamilySecurityDeposits 3218
MultiFamilyDistributedDepositInvestments 3222
Property Data
The following information is for importing a single property and associated sections of data.
PropertyName String The human readable name for the property asset.
PortfolioName String Optional name for the portfolio to which this property
belongs.
NetRentableArea DateAmountPair list Net rentable area over time. See DateAmountPair
structure.
Budgets BudgetData list A list of monthly budget amounts for specific accounts.
See BudgetData structure.
Actuals ActualsData list A list of monthly actuals amounts for specific accounts.
See ActualsData structure.
Tenants TenantData list A list of basic tenant lease data input assumptions. See
TenantData structure.
CapitalExpenses CapitalExpenseData list A list of basic capital expense data input assumptions.
See CapitalExpenseData structure.
OtherDebt OtherDebtData list A list of basic other debt data input assumptions. See
OtherDebtData structure.
ExpenseGroups ExpenseGroupData list A list of basic expense group data input assumptions.
See ExpenseGroupData structure.
TenantGroups TenantGroupData list A list of basic tenant group data input assumptions.
See TenantGroupData structure.
PropertyAssetTemplateId String Used for importing data into a template when using
the ARGUS Data Service. This field is not used when
importing by a user within the AE application, as a
template is selected at the time of import.
Classification Data
This data represents a property classification.
Name String The name (value) of the classification for this particular
property. Chosen from a list of system classifications
that are available and user configurable within AE.
Budget Data
This data represents budget data for a single expense or revenue account for a contiguous period of months
beginning on a specified date. This is also referred to as Prior Budget Data.
AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
Actuals Data
This data represents the historical data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.
AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
Forecast Data
This data represents forecast data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.
AccountType String/GLAccountType enum Optional. Fixed set of values identifying the type of
revenue/expense.
• MiscellaneousRevenue
• ReimbursableExpense
• NonreimbursableExpense
• CapitalExpense
• NonOperatingExpense
• OtherDebt
ExpenseType String/ExpenseType enum Fixed set of values identifying the included expense
item or group:
• ExpenseGroup
• OperatingExpense
• CapitalExpense
RecoveryType String/RecoveryType enum Optional. Fixed set of values identifying the recovery
calculation type:
• Net
• BaseYearStop
• BaseYearStopMinus1
• BaseYearStopPlus1
• StopAmount
• StopAmountPerArea
• FixedAmount
• FixedAmountPerArea
• None
MinimumAmountUnit String/LimitsBasis enum Optional. Minimum increase unit of measure. Fixed set
of values:
• AmountPerArea
• Amount
• None
MaximumAmountUnit String/LimitsBasis enum Optional. Maximum amount unit of measure. Fixed set
of values:
• AmountPerArea
• Amount
• None
MaximumIncreaseUnit String/CapBasis enum Optional. Maximum Increase Unit of Measure. Fixed set
of values:
• AmountPerArea
• Amount
• Pct
• None
MaximumIncreaseAmount DateAmountPair list Optional. Cap amounts over time. See DateAmountPair
structure.
Tenant Data
This data represents the tenant lease data.
LeaseID String The external lease ID used to match imported data to the
existing record for the purposes of importing updated
information.
RentScheduleData RentScheduleData Optional. A structure that defines the lease rent schedule.
See RentScheduleData structure.
Size DateAmountPair Optional. The area of the lease. A list that can change over
time. See DateAmountPair structure.
LeaseBreaks LeaseBreakData Optional. A structure that defines the Lease Breaks. See
LeaseBreakData structure.
OptionTenant OptionTenantData Optional. A structure that defines the child lease. See
OptionTenantData structure.
FreeRent FreeRentData Optional. A structure that defines free rent months. See
FreeRentData structure.
Lease Type
This data represents the lease status enumeration.
Upon Expiration
This data represents the lease Upon Expiration basis enumeration.
Options String/LeaseBreakOption enum Fixed set of values identifying which party or parties
have the right to exercise the break:
• Landlord
• Tenant
• LandlordAndTenant
• None
ActionedBy String/LeaseBreakActionedBy enum Fixed set of values identifying which party is assumed
to actually exercise the break:
• Landlord
• Tenant
• None
LandlordPenalty Double Optional. The amount paid to the tenant if the landlord
breaks the lease.
TenantPenalty Double Optional. The amount paid to the tenant if the landlord
breaks the lease.
BaseRentValues DateAmountPair list Optional. Base Rent over time. See DateAmountPair
structure.
FixedStepsValues DateAmountPair list Optional. Base Rent over time. See DateAmountPair
structure.
Note: Detailed/Multiple input is supported as a valid selection for SalesPercentBasis field but Tenant Sales
Categories input/structure is not supported.
ImprovementsTimings DateAmountPair list Optional. Tenant Improvement timing over time. See
DateAmountPair structure.
CommissionsTimings DateAmountPair list Optional. Leasing Commissions timing over time. See
DateAmountPair structure.
Incentive Data
This data represents incentive data.
IncentiveUnit String/IncentiveUnit enum Fixed set of values identifying the unit of measure of
the current item
• Amt1
• AmtPerArea
Recovery Data
This data represents the recovery data.
OptionTenant Data
This data represents the option tenant data.
Size DateAmountPair Optional. The area of the lease. A list that can change
over time. See DateAmountPair structure.
LeaseBreaks LeaseBreakData Optional. A structure that defines the Lease Breaks. See
LeaseBreakData structure.
FreeRent FreeRentData Optional. A structure that defines free rent months. See
FreeRentData structure.
Improvements Improvements Optional. A structure that defines free rent months. See
Improvements structure.
Commissions Commissions Optional. A structure that defines free rent months. See
Commissions structure.
OptionTenant OptionTenantData Optional. A structure that defines the child lease. See
OptionTenantData structure.
ExpenseType String/ExpenseType enum Fixed set of values identifying the expense type of the
included item:
• OperatingExpense
• CapitalExpense
RentScheduleUnit RentScheduleEntryUnitBasis enum Fixed set of values identifying the basis type used for
the Rent Schedule Unit. See
RentScheduleEntryUnitBasis structure.
RentScheduleAmount Double The amount for the initial rent schedule entry.
RentScheduleAmount Double The amount for the initial rent schedule entry.
ReviewMinimumUpliftType RentReviewUpliftBasis enum Fixed set of values identifying the basis type used for
the minimum uplift of the rent schedule entry. See
RentReviewUpliftBasis structure.
ReviewMaximumUpliftType RentReviewUpliftBasis enum Fixed set of values identifying the basis type used for
the maximum uplift of the rent schedule entry. See
RentReviewUpliftBasis structure.
Property Data
The following information represents exporting a single property and associated sections of data.
PropertyName String The human readable name for the property asset.
PortfolioName String Optional name for the portfolio to which this property
belongs.
NetRentableArea DateAmountPair list Net rentable area over time. See DateAmountPair
structure.
Budgets BudgetExport list A list of monthly budget amounts for specific accounts.
See BudgetExport structure.
Actuals ActualsExport list A list of monthly actuals amounts for specific accounts.
See ActualsExport structure.
CapitalExpenses CapitalExpenseExport list A list of basic capital expense data input assumptions.
See CapitalExpenseExport structure.
ActualsEnd DateTime The Actuals End Date for the property, if applicable.
BudgetEnd DateTime The Budget End Date for the property, if applicable.
Actuals Export
This data represents the historical data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.
Budget Export
This data represents budget data for a single expense or revenue account for a contiguous period of months
beginning on a specified date.
AccountNumber String Account for which the monthly amounts are summarized.
Results Export
This data represents calculated result data for a single expense or revenue account for a contiguous period of
months beginning on a specified date.
AccountNumber String Account for which the monthly amounts are summarized.
Classifications Export
This data represents a property classification.
Name String The name (value) of the classification for this particular
property. Chosen from a list of system classifications for a
particular type. System classifications are available and
user configurable within AE.
Expense Basis
This represents a list of values for How Input.
Amounts Double list A list of consecutive monthly amounts from the start
date.
Custom Data
This represents custom data.
Call Get<Operation>
e.g. GetPortfolios
Comments e.g. Does not take any parameters. Retrieves an array of Portfolio objects that represent the portfolios in the
system.
Call GetPortfolios
Comments Does not take any parameters. Retrieves an array of Portfolio objects that represent the portfolios in the
system.
Call GetPortfolioScenarios
Comments Takes a portfolio ID and retrieves an array of Scenario objects that represent the scenarios within that
portfolio.
Call GetScenariosWithPropertyAsset
Comments Takes the external ID of a property asset and returns an array of Scenario objects that represent the
scenarios that contain that property.
Call GetScenarioProperties
Comments Takes a scenario ID and retrieves an array of PropertyAsset objects that represent the property assets within
that scenario.
Call GetPropertyAssets
Comments Takes an array of property asset IDs and retrieves an array of PropertyAsset objects.
Call CopyScenario
Comments Takes the ID of the scenario to copy and the name of the new scenario to create, and queues a job to copy all
of the property assets from the given scenario into a new scenario with the given name. Returns the ID of the
newly created scenario, and the Id of the queued job that will process this request.
Call GetQueuedJobsSummariesForIntegration
Comments Returns an array of QueuedJobsSummary objects that represent the set of queued jobs that meet the criteria
specified by the request parameters: the user who submitted the job, the status of the job, and a date range
within which the job was submitted.
Call GetQueuedJobsSummaryForIntegration
Comments Takes the ID of a queued job and returns the corresponding QueuedJobsSummary object that represents that
job.
Call GetQueuedJobTasksForIntegration
Comments Takes the ID of a queued job and returns an array of QueuedJobTask objects that represent the queued tasks
within that job.
Call GetFailedQueuedJobTasksForIntegration
Comments Takes the ID of a queued job and returns an array of QueuedJobTask objects that represent the queued tasks
within that job that are in a failed state.
Call SaveCustomData
Comments Imports custom data structure information into ARGUS Enterprise 11.0.5
Call ImportAVUXAssumptions
Comments Imports a property asset input assumptions model and, optionally, the calculated results.
Call ExportAVUXAssumptions
Comments Exports a property asset input assumptions model and, optionally, the calculated results.
Call ExportAeexPropertyData
Comments Exports data for specified property assets in the AEEX format. The AEEX format data structures described in a
previous section of this document provide a description of the property asset data that is exportable using
this data structure.
Call ExportAeixPropertyData
Comments Exports data for specified property assets in the AEIX format. The AEEX format data structures described in a
previous section of this document provide a description of the property asset data that is exportable using
this data structure.
Call ImportAeixPropertyData
Comments Imports data for specified property assets in the AEIX format. The AEIX format data structures described in a
previous section of this document provide a description of the property asset data that is importable using
this data structure.
Call ImportCustomData
Comments Imports a simple custom data structure used by Argus Professional Services for storing asset related custom
data.
Call ValidateImportAeixPropertyData
Comments Provides validation about a specific AEIX format ted structure to determine if there will be any problems
found when importing the data.
Call GetValidationRules
Comments Does not take any parameters. Retrieves an array of ValidationResultDefinition objects that represent the
validation rules for import in the system.
Call GetChartsOfAccounts
Comments Does not take any parameters. Retrieves an array of ChartOfAccounts objects that represents all the chart of
accounts in the system.
Call ValidateImportChartOfAccounts
Comments Provides validation about a specific chart of account structure to determine if there will be any problems
found when importing the data.
Call ImportChartOfAccounts
Call ExportChartOfAccounts
Call ApplySensitivityChanges
Comments Takes an array of PropertyAssetChangeset objects that represent changes to be applied for sensitivity
analysis. Returns a collection of PropertyAssetChangesetResult objects that represent the result of each
property asset change request.
Call GetMarketLeasingForSenstivity
Comments Takes an array of property asset IDs and retrieves an array of MarketLeasing objects that represent the
market leasing profiles.
Call GetLeasingForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of Leasing objects that represent the tenant leases.
Call GetVacancyForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of Vacancy objects that represent the vacancy
allowances.
Call GetCreditLossForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of CreditLoss objects that represent the credit
losses.
Call GetInflationForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of Inflation objects that represent the inflation
rates.
Call GetValuationForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of Valuation objects that represent the valuation
data.
Call GetExpenseForSensitivity
Comments Takes an array of property asset IDs and retrieves an array of Expense objects that represent the capital
expenses.
RequestBase
The following base information is provided in all Request message structures.
Build string Expected Build number of currently executing web service. This should only be filled out
if the build number of ARGUS Enterprise 11.0.5 is known when the client interface
was built and deployed. It is a troubleshooting piece of information.
RequestId string A unique identifier (ideally a Guid) issued by the client representing the instance of the
request. Avoids rapid-fire processing of the same request over and over in denial-of-
service type attacks. Also used to troubleshoot by identifying specific messages in the
service log files.
Version string Minimum version number that client request is required to run under. This facilitates a
certain level of backward compatibility for when the web service API evolves.
ResponseBase
The following base information is provided in all Response message structures.
Build String Build number of currently executing web service. Used as an indicator to client
whether certain code fixes are included or not.
Version String Version number (in major.minor format) of currently executing web service. Used to
offer a level of understanding (related to compatibility issues) between the client and
the web service as the web services evolve over time. Ebay.com uses this in their API.
GetPortfoliosResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetPortfolioScenariosRequest
In addition to the RequestBase properties, this message structure contains the following:
GetPortfolioScenariosResponse
In addition to the ResponseBase properties, this message structure contains the following:
Scenarios Scenario The list of Scenario structures for the selected portfolio
GetScenariosWithPropertyAssetRequest
In addition to the RequestBase properties, this message structure contains the following:
GetScenariosWithPropertyAssetResponse
In addition to the ResponseBase properties, this message structure contains the following:
Scenarios Scenario The list of Scenario structures that contain the PropertyAsset with the
requested External ID
GetScenarioPropertiesRequest
In addition to the RequestBase properties, this message structure contains the following:
GetScenarioPropertiesResponse
In addition to the ResponseBase properties, this message structure contains the following:
PropertyAssets PropertyAsset The list of PropertyAsset structures contained by the selected Scenario Id.
GetPropertyAssetsRequest
In addition to the RequestBase properties, this message structure contains the following:
GetPropertyAssetsResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetPropertyAssetsRequest
In addition to the RequestBase properties, this message structure contains the following:
GetPropertyAssetsResponse
In addition to the ResponseBase properties, this message structure contains the following:
ImportAVUXAssumptionsDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ImportAVUXAssumptionsDataResponse
In addition to the RequestBase properties, this message structure contains the following:
QueuedJobId Int Id of the Queued Job that will apply the changes to the property asset
and re-calculate it.
QueuedTaskId Int Id of the Queued Task that will apply the changes to the property
asset and re-calculate it.
ResultMessage String The overall result message of the request to import property data.
ExportAVUXAssumptionsDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ExportResults Bool The flag indicating whether calculated results are included in the export.
ScenarioID Long The ID of the scenario that the property asset is related to.
ExportAVUXAssumptionsDataResponse
In addition to the RequestBase properties, this message structure contains the following:
ResultMessage String The overall result message of the request to import property data.
ExportAeexPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
ExportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ExportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
ImportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ImportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
ValidateImportAeixPropertyDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ValidateImportAeixPropertyDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
ImportCustomDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ImportCustomDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetValidationRulesRequest
In addition to the RequestBase properties, this message structure contains the following:
GetValidationRulesResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetChartsOfAccountsRequest
In addition to the RequestBase properties, this message structure contains the following:
GetChartsOfAccountsResponse
In addition to the ResponseBase properties, this message structure contains the following:
Charts ChartOfAccounts The list of all the charts of accounts in the system.
ValidateImportChartOfAccountsRequest
In addition to the RequestBase properties, this message structure contains the following:
ValidateImportChartOfAccountsResponse
In addition to the ResponseBase properties, this message structure contains the following:
Action String Action that was taken for the overall chart of
accounts:
- Skip: nothing was imported. Check ActionText for
reason.
- Create: New chart of account was created
- Overwrite: Existing chart of account was
overwritten.
ActionText String If action was Skip this will provide the reason why.
ImportChartDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ImportChartDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
Action String Action that was taken for the overall chart of
accounts:
- Skip: nothing was imported. Check ActionText for
reason.
- Create: New chart of account was created
- Overwrite: Existing chart of account was
overwritten.
ActionText String If action was Skip this will provide the reason why.
ExportChartDataRequest
In addition to the RequestBase properties, this message structure contains the following:
ExportChartDataResponse
In addition to the ResponseBase properties, this message structure contains the following:
PropertyAssetIds Long The list of PropertyAssetId’s to retrieve credit loss data for.
GetCreditLossForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
CreditLossData CreditLoss The list of credit loss structures for the selected property
asset IDs.
GetExpenseForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetExpenseForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
ExpenseData Expense The list of expense structures for the selected property
asset IDs.
GetInflationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetInflationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
InflationData Inflation The list of Inflation structures for the selected property
asset IDs.
GetLeaseForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetLeaseForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
Lease Data Lease The list of Lease structures for the selected property asset
IDs.
GetMarketLeasingForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetMarketLeasingForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
MarketLeasing Data MarketLeasing The list of Market Leasing structures for the selected
property asset IDs.
GetVacancyForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetVacancyForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
Vacancy Data Vacancy The list of Vacancy structures for the selected property
asset IDs.
GetValuationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetValuationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
ValuationData Valuation The list of Valuation structures for the selected property
asset IDs.
GetQueuedJobsSummariesForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:
UserName String The name of the user who submitted the job. Used to
filter the queued jobs to return only the jobs submitted
by this user.
Statuses StatusTypes An array that contains the statuses of the jobs. Used to
filter the queued jobs to return only the jobs that are in
one of these statuses.
SubmittedStart DateTime The start date used to filter the queued jobs.
SubmittedEnd DateTime The end date used to filter the queued jobs.
GetQueuedJobsSummariesForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetQueuedJobSummaryForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:
GetQueuedJobSummaryForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetQueuedJobTasksForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:
JobId Int The ID of the specific queued job to retrieve the task
details for.
GetQueuedJobTasksForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetFailedQueuedJobTasksForIntegrationRequest
In addition to the RequestBase properties, this message structure contains the following:
JobId Int The ID of the specific queued job to retrieve the failed task
details for.
GetFailedQueuedJobTasksForIntegrationResponse
In addition to the ResponseBase properties, this message structure contains the following:
GetTraditionalValuationForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetTradtionalValuationForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
TraditionalValuation TraditionalValuation The list of Traditional Valuation structures for the selected
property asset IDs.
GetHotelRoomsForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetHotelRoomsForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
HotelRooms HotelRoom The list of Hotel Room structures for the selected property
asset IDs.
GetHotelRevenuesForSensitivityRequest
In addition to the RequestBase properties, this message structure contains the following:
GetHotelRevenuesForSensitivityResponse
In addition to the ResponseBase properties, this message structure contains the following:
Revenues HotelRevenue The list of Hotel Revenue structures for the selected
property asset IDs.
Data Structures
These are the data structures and sub structures used to construct the details of the request and response
messages described above.
NOTE: See the sections on AEIX Xml Data Structures and AEEX Xml Data Structure in the previous section of this
document for a description of the data being exchanged via these calls.
Portfolio
This Data structure represents the basic information associated with a Portfolio.
LockedByUser String No The name of the user who currently has a lock on
this portfolio. Null if the portfolio is not locked.
QueuedJobId Int No The ID of the queued job that has this portfolio
locked. Null if this portfolio is not locked for a job.
QueuedTaskId Int No The ID of the queued task that has this portfolio
locked. Null if this portfolio is not locked for a
task.
QueuedTaskType Enum No The type of the queued task that has this
(QueuedTaskTypes) portfolio locked. Null if this portfolio is not locked
for a task.
QueuedTaskDescription String No The description of the queued task that has this
portfolio locked. Null if this portfolio is not locked
for a task.
Scenario
This Data structure represents the basic information associated with a Scenario.
DefaultAreaMeasure Enum (AreaMeasureBasis) No The default area measure for the scenario.
LockedByUser String No The name of the user who currently has a lock
on this scenario. Null if the scenario is not
locked.
QueuedTaskType Enum (QueuedTaskTypes) No The type of the queued task that has this
scenario locked. Null if this scenario is not
locked for a task.
PropertyAsset
This Data structure represents the basic information associated with a Property Asset.
AnalysisBegin DateTime No The analysis begin date for this property asset.
CurrencyCode String No The currency code used for this property asset.
AddressLine1 String No The first line of the address for this property
asset.
AddressLine2 String No The second line of the address for this property
asset.
City String No The city of the address for this property asset.
ZipOrPostalCode String No The zip or postal code of the address for this
property asset.
AreaMeasure Enum (AreaMeasureBasis) No The area measure type for this property asset.
ScenarioAreaMeasure Enum (AreaMeasureBasis) No The default area measure set on this property’s
scenario.
LockType Enum (LockTypes) No The type of lock placed on this property asset.
LockedByUser String No The name of the user who currently has a lock on
this property asset. Null if the property asset is
not locked.
QueuedJobId Int No The ID of the queued job that has this property
asset locked. Null if this property asset is not
locked for a job.
QueuedTaskId Int No The ID of the queued task that has this property
asset locked. Null if this property asset is not
locked for a task.
QueuedTaskType Enum (QueuedTaskTypes) No The type of the queued task that has this
property asset locked. Null if this property asset is
not locked for a task.
QueuedTaskDescription String No The description of the queued task that has this
property asset locked. Null if this property asset is
not locked for a task.
PropertyAssetChangeset
This data structure represents a collection of changes to a single property asset
LeasingChanges Array (LeasingChangeItem) The collection of changes to make to the leases for
this property asset.
CreditLossChanges Array (CreditLossChangeItem) The collection of changes to make to the credit loss
for this property asset.
HotelRoomsChanges Array (HotelRoomChangeItem) The collection of changes to make to the hotel rooms
for the property asset.
MarketLeasingChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (MarketLeasingChangeItemProperty) The type of the property that was changed.
LeasingChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (LeasingChangeItemProperty) The type of the property that was changed.
VacancyChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (VacancyChangeItemProperty) The type of the property that was changed.
CreditLossChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (CreditLossChangeItemProperty) The type of the property that was changed.
InflationChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (InflationChangeItemProperty) The type of the property that was changed.
ValuationChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (ValuationChangeItemProperty) The type of the property that was changed.
ExpenseChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (ExpenseChangeItemProperty) The type of the property that was changed.
HotelRevenueChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (HotelRevenuesChangeItemProperty) The type of the property that was changed.
HotelRoomChangeItem
Key Object The unique identifier that represents the item that
was changed.
Property Enum (HotelRoomChangeItemProperty) The type of the property that was changed.
TraditionalValuationChangeItem
Key Object The unique identifier that represents the item that
was changed.
PropertyAssetChangesetResult
Result Enum (OperationResult) The type of the result of this change request.
MarketLeasing
Represents a single market leasing profile for a single property asset.
MarketRate Double Yes The value of the new market rate at the time
of the property’s analysis begin date.
RentSteps Double Yes The first non-zero rent step defined in this
market lease profile.
FreeRentNew Double Yes The number of free rent months for new
tenants at the time of the property’s analysis
begin date.
FreeRentRenew Double Yes The number of free rent months for renewing
tenants at the time of the property’s analysis
begin date.
Vacancy
Represents the vacancy allowance for a single property asset.
CreditLoss
Represents the credit loss for a single property asset.
Input Array (DateAmountPair) Yes The annual credit loss amounts. See
DateAmountPair structure.
Inflation
Represents a single inflation rate for a single property asset.
Rates Array (DateAmountPair) Yes The annual inflation rate amounts. See
DateAmountPair structure.
Leasing
Represents a single tenant lease for a single property asset.
Valuation
Represents the valuation for a single property asset.
Expense
Represents a single capital expense for a single property asset.
HotelRevenue
Represents the hotel revenue for a single property asset.
HotelRoom
Represents the hotel room for a single property asset.
TraditionalValuation
Represents the traditional valuation for a single property asset.
DateAmountPair
Represents an amount as of a date.
QueuedJobsSummary
Represents a summary view of a queued job.
QueuedJobTasks
Represents a single task within a queued job.
ExportAeexProcessingOptions
Represents the processing options selected when exporting AEEX formatted data.
ProcessUsingScenarioSettings bool Use the scenario or property currency and area measures.
UsePropertyDates bool Use the property dates when exporting data ranges or use
the provided begin date and number of months.
DataBeginDate bool The begin date if data is to be exported using common dates.
ExportAeixProcessingOptions
Represents the processing options selected when exporting AEIX formatted data.
ProcessUsingScenarioSettings bool Use the scenario or property currency and area measures.
UsePropertyDates bool Use the property dates when exporting data ranges or use
the provided begin date and number of months.
BaseRentDataExportBasis Enum Process rent schedule entries using the legacy export or not.
(BaseRentDataExportBasis)
ImportAeixProcessingOptions
Represents the processing options selected when importing AEIX formatted data.
MissingReferenceError Enum Determines how the system will handle missing reference
(MissingReferenceError) errors.
ImportAeixPropertyDataValidationResult
Provides the validation results for a single property data import request.
PropertyDataIndex int The index into the original XmlImportData message to match
the response with the request.
PropertyId string The external ID to match the response with the request.
PropertyName string The property name to match the response with the request.
QueuedJobId long The ID of the Queued Job that will apply the changes to the
property asset and re-calculate it.
QueuedTaskId long The ID of the Queued Task that will apply the changes to the
property asset and re-calculate it.
ResultMessage string The overall result message of the request to import property
data.
ValidationResults ValidationResultItem The validation results for this property data item.
ValidationResultDefinition
Represents a validation definition for an AEIX formatted import data item.
ValidationResultItem
Action ImportValidationResultAction The import action that will be taken as a result of the
validation
• NoAction
• AbortProcess
• SkipProperty
• AddProperty
• UpdateProperty
• SkipRecord
• AddRecord
• UpdateRecord
• NetAccountEntries
• UseLastAccountEntry
• UpdatePropertyName
• IgnoreChange
PropertyName string The human readable name for the property asset.
RecordName String The name of the record validated e.g. Tenant Name,
Property Name, etc.
ValidationRuleOverride
Represents a validation rule override for an AEIX formatted import data item.
ChartOfAccounts
Represents a chart of accounts for import/export.
Account
Represents an account on a chart of accounts.
LineItemType String See the end of this document for the list.
ImportAccountResult
Represents an import account result on a chart of accounts.
ImportChartOptions
Represents import chart options
ExportChartOptions
Represents export chart options
As with the Argus Enterprise Application Service, the Data Integration Service is installed as a Windows Service by
default. It can be configured using the Argus Enterprise Configuration Utility in the same way as the Application
Service.
Data Integration Service Versions
As Argus Enterprise evolves there will be times where changes will be made that breaks the existing data service
contracts. When this happens a new version of the data service will be exposed at a new endpoint. The existing
endpoints of the older deprecated contracts will continue to work for at least one additional release of AE, but it is
encouraged that you upgrade your application that is consuming these services to the latest version to take
advantage of the latest features. You will have to update any service references (if using a dot net client) pointing
to the new endpoint. Also, be careful of any entity changes and especially enumeration changes.
The naming convention for the endpoints are as follows:
http://yourservername:port/dataservice.svc
http://yourservername:port/dataserviceV2.svc
etc.
http://yourservername:port/dataserviceVX.svc (where X = future versions)
Examples:
For Argus Enterprise 10.5.x: http://localhost:8203/dataservice.svc
For Argus Enterprise 10.6.x and up: http://localhost:8203/dataserviceV2.svc
We also expose mex endpoints. As a best practice you should remove these endpoints from your production
environment:
For Argus Enterprise 10.5.x: http://localhost:8203/dataservice.svc/mex
For Argus Enterprise 10.6.x and up: http://localhost:8203/dataserviceV2.svc/mex
For WSDL please make sure you first manually change the httpGetEnabled=”true” in the configuration file in your
development environment.
<behaviors>
<serviceBehaviors>
<behavior name="behaviorAction">
<!-- for HTTP, set this to true in dev environment -->
<serviceMetadata httpGetEnabled="true" />
You can then navigate to the web service using a browser. The URL will be
http://yourservername:port/dataservice.svc. For example, http://localhost:8203/dataservice.svc. You should see a
screen similar to:
To access the WSDL, add ?wsdl to the end of the URL, for example http://localhost:8203/dataservice.svc?wsdl.
Within the resulting WSDL file, there is a section labeled wsdl:types. This section contains the links to the
associated XSDs.
You can follow each of the links defined in the schemaLocation to retrieve the XSD file. For example,
http://localhost:8203/dataservice.svc?xsd=xsd0.
In the Address bar, type in the URL of the installed Data Integration Service, for example
http://localhost:8203/dataservice.svc. Click the Go button. The service will appear in the Services list. Set the
Namespace to something appropriate for your project, and then click OK.
Note: If unable to find the service, make sure the HttpGetEnabled property under the Data Integration Service
configuration file is set to true. See Discovering the Data Integration Service section above for more information.
This will automatically discover the web service and generate the necessary files. In the References folder, you will
now see a Service References subfolder that contains the reference to the Data Integration Service.
The Data Integration Service is now ready to be accessed in the application code. For example:
if (allPortfolios.Length > 0)
{
long portfolioId = allPortfolios.Where(x => x.Name == portfolioName).First().Id;
Some suggested configuration changes to improve performance and ability to handle larger data transfers:
<behaviors>
<endpointBehaviors>
<behavior name="ServiceViewEventBehavior">
<dataContractSerializer maxItemsInObjectGraph="2147483647"/>
</behavior>
</endpointBehaviors>
</behaviors>
• Loss Absorption
• Loss To Lease
• Lost Absorption / Turnover Rent
• Lost Absorption / Turnover Rent (Negated)
• Market Comparison Incentive
• Market Comparison LC
• Market Comparison TI
• Market Inflation In Period
• Market Miscellaneous Rent
• Market Percentage Rent
• Market Recoveries
• Market Rent
• Market Rent
• Miscellaneous Rent
• Miscellaneous Rent
• Months Vacant
• Multi-Family Additional Concessions
• Multi-Family Credit Loss
• Multi-Family Deposit Refund
• Multi-Family Distributed Deposit Investments
• Multi-Family Earned Deposit Interest Capital Receipt
• Multi-Family Earned Deposit Interest Operating Revenue
• Multi-Family Free Rent
• Multi-Family Improvements
• Multi-Family Improvements Operating Expenses
• Multi-Family Initial Rent
• Multi-Family Invested Security Deposits
• Multi-Family Leasing Costs
• Multi-Family Leasing Costs Operating Expenses
• Multi-Family Non-Refundable Deposits
• Multi-Family Occupied Area
• Multi-Family Revenue Potential Per Unit
• Multi-Family Revenue Total Costs
• Multi-Family Security Deposits
• Multi-Family Total Revenue
• Multi-Family Total Unit Area
• Multi-Family Units Absorbed
• Multi-Family Units At Market
• Multi-Family Units Expiring
• Multi-Family Units Rolled To Market
• Multi-Family Vacancy
• Net Operating Income
• Net Recoverable Amount
• Net Rent Over Initial Value
• Net Rent Value
• Net Sale Price Change Amount
• Net Sale Price Change Percentage
• New Deposit Refund
• New Distributed Deposit Investments
• New Earned Deposit Interest Capita Receipt
• New Earned Deposit Interest Operating Revenue
• New Invested Security Deposits
• New Leasing Commission
• New Leasing Commissions
• New Market Rent
• New Market Rent
• New Non Refundable Deposits
• New Security Deposits
• New Tenant Improvement
• Non Recoverable Amount
• Non-Operating Expense
• Non-Operating Expense Not Summed
• Non-Refundable Deposits
• Not Defined
• Not Recovered During Free Rent
• Occupied Area
• Occupied Area
• Operating Expense
• Operating Expense Percent Of Line Item
• Other Debt
• Other Period Unleveraged IRR
• Other Revenue
• Parking Revenue
• Passing CPI
• Passing Miscellaneous Rent
• Passing Percentage Rent
• Passing Recoveries
• Passing Rent
• Percentage Rent
• Percentage Rent
• Percentage Rent Offset
• Potential Base Rent
• Potential Multi-Family Mkt. Rent
• Potential Rent After Loss to Lease
• Property Recoveries
• Purchase Price
• PV of Leveraged Cash Flow
• PV of Leveraged Cash Flow As Of Date
• PV of Leveraged Cash Flow Fixed Hold
• PV of Leveraged Sale Proceeds
• PV of Unleveraged Cash Flow
• PV of Unleveraged Cash Flow As Of Date
• PV of Unleveraged Cash Flow Fixed Hold
• PV of Unleveraged Sale Proceeds
• Recoverable Amount
• Recoverable Fixed
• Recovered Amount Before Free Rent
• Recovered Amount Before Limits
• Recovered By Method
• Recovery Allocation Percentage
• Recovery Gross Up
• Recovery Increase Amount
• Recovery Inflated Input Amount
• Recovery Max Per Increase Limit
• Recovery Maximum Limit
• Recovery Method Area
• Recovery Method Base Lease Line
• Recovery Method Lease Line
• Recovery Method Total
• Recovery Method Unit Line
• Recovery Minimum Limit
• Recovery Stop Amount
• Recovery Stop Free Rent
• Renew Deposit Refund
• Renew Distributed Deposit Investments
• Renew Earned Deposit Interest Capital Receipt
• Renew Earned Deposit Interest Operating Revenue
• Renew Invested Security Deposits
• Renew Leasing Commission
• Renew Leasing Commissions
• Renew Market Rent
• Renew Non Refundable Deposits
• Renew Security Deposits
• Renew Tenant Improvement
• Renewal Percentage
• Rentable Area
• Rental Income Before CPI
• Rental Income Before CPI Average
• Rental Value
• Revenue
• Revenue Per Available Room
• Revenue Per Available Room Uninflated
• Reversion
• Reversionary Yield
• RevEx Before Fixed Percent
• RevEx Fixed Part
• RevEx Fixed Part for CapVal
• RevEx for CapVal
• RevEx Variable Part
• Sales Amount
• Scheduled Base Rent
• Scheduled Multi-Family Rent
• Scheduled Rent
• Security Deposits
• Selling Cost
• Selling Costs + VendorCosts
• Speculative Absorption And Turnover
• Speculative CapEx Total
• Speculative CPI
• Speculative Deposit Refund
• Speculative Distributed Deposit Investments
• Speculative Earned Deposit Interest Capital Receipt
• Speculative Earned Deposit Interest Operating Revenue
• Speculative Expense Recovery
• Speculative Free CPI
• Speculative Free Miscellaneous Rent
• Speculative Free Percentage Rent
• Speculative Free Recovery
• Speculative Invested Security Deposits
• Speculative Lease Break
• Speculative Leasing And Capital Costs
• Speculative Leasing Commissions
• Speculative Miscellaneous Rent
• Speculative Non-Refundable Deposits
• Speculative Percentage Rent
• Speculative Percentage Rent Intermediate
• Speculative Percentage Rent Offset
• Speculative Potential Base Rent
• Speculative Rent Abatement
• Speculative Scheduled Base Rent
• Speculative Security Deposits
• Speculative Straight Line Rent Adjustment
• Speculative Tenant Improvements
• Speculative Tenant Incentive
• Speculative Tenant Incentive Amortization
• Speculative Tenant Incentive Recovery
• Speculative Tenant Incentive Straight Line Adjustment
• Speculative Tenant Income
• Speculative Tenant Other Income
• Speculative Total Leasing Cost
• Speculative Total Leasing Cost IncIncentives
• Speculative Total Rental Income
• Step Rent
• Storage Revenue
• Straight Line Incentive Adjustment
• Straight Line Rent