Affluenza REST API

<back to all web services

GetMaturityStructuredReportRequest

The following routes are available for this service:
POST, GET/reports/Maturity

To override the Content-type in your clients HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/GetMaturityStructuredReportRequest HTTP/1.1 
Host: www.plusrated.com 
Content-Type: text/jsv
Content-Length: length

{
	portfolios: 
	[
		String
	],
	portfolioId: 00000000000000000000000000000000,
	dtCalc: 0001-01-01,
	maturityStart: 0001-01-01,
	reportCurrencyTicker: String,
	includeTemporaryData: False,
	basePortfolioName: String,
	operationId: 00000000000000000000000000000000,
	simulation: False,
	appKey: 0,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: Success,
	response: 
	{
		portfolioId: 00000000000000000000000000000000,
		startDate: 0001-01-01,
		basePortfolioName: String,
		endDate: 0001-01-01,
		portfolios: 
		[
			{
				id: 00000000000000000000000000000000,
				parentId: 00000000000000000000000000000000,
				name: String,
				value: 0,
				notional: 0,
				bondsValue: 0,
				derivativesValue: 0,
				deep: 0
			}
		],
		bonds: 
		[
			{
				id: 00000000000000000000000000000000,
				portfolioId: 00000000000000000000000000000000,
				contractCategory: 
				{
					ticker: String,
					type: String,
					description: String
				},
				contractId: String,
				counterParty: String,
				notional: 0,
				instrument: 
				{
					ticker: String,
					description: String
				},
				underlying: 
				{
					ticker: String,
					description: String
				},
				cashFlowIndexPercentage: 0,
				cashFlowInterestRate: 0,
				startDate: 0001-01-01,
				maturityDate: 0001-01-01,
				numberOfPayments: 0,
				feeUpFront: 0,
				iof: 0,
				observation: String,
				warrantyType: String,
				warrantyInformation: String,
				externalKey: String,
				hedgeAccounting: 
				{
					ticker: String,
					description: String,
					active: False
				},
				termConvention: String,
				settlementCurrency: 
				{
					ticker: String,
					description: String
				},
				value: 0,
				payments: 
				[
					{
						number: 0,
						date: 0001-01-01,
						interestValue: 0,
						principal: 0,
						monetaryCorrection: 0,
						currencyExchangeCorrection: 0,
						currencyExchangeCorrectionAmortization: 0,
						currencyExchangeCorrectionInterest: 0,
						currencyExchangeCorrectionMonetaryCorrection: 0,
						currencyExchangeCorrectionFeeupfront: 0,
						currencyExchangeCorrectionNotional: 0,
						feeUpFront: 0,
						ioftvm: 0,
						ir: 0,
						value: 0,
						interestFineRate: 0,
						interestLateRate: 0,
						status: String,
						paymentDate: 0001-01-01,
						interestLateValue: 0,
						adjustment: 0,
						bonus: 0
					}
				],
				settlementQuotationInitialValue: 0,
				brokerageFee: 0,
				emolument: 0,
				premium: 0,
				contractWarrantyValue: 0,
				feeDeferredType: String,
				iofDeferredType: String
			}
		],
		derivatives: 
		[
			{
				id: 00000000000000000000000000000000,
				portfolioId: 00000000000000000000000000000000,
				contractCategory: 
				{
					ticker: String,
					type: String,
					description: String
				},
				contractId: String,
				counterParty: String,
				notional: 0,
				instrument: 
				{
					ticker: String,
					description: String
				},
				contractCurrency: 
				{
					ticker: String,
					description: String
				},
				underlying: 
				{
					ticker: String,
					description: String
				},
				settlementCurrency: 
				{
					ticker: String,
					description: String
				},
				forwardValue: 0,
				forwardMarketValue: 0,
				position: 
				{
					type: String,
					description: String
				},
				riskFreeRate: 0,
				settlementExchangeCurrency: 0,
				hedgeAccounting: 
				{
					ticker: String,
					description: String,
					active: False
				},
				startDate: 0001-01-01,
				maturityDate: 0001-01-01,
				value: 0,
				observation: String,
				warrantyType: String,
				warrantyInformation: String,
				externalKey: String,
				dataSource: String,
				contractFixing: 
				{
					ticker: String,
					description: String
				},
				brokerageFee: 0,
				emolument: 0,
				premium: 0,
				earlySettlements: 
				[
					{
						date: 0001-01-01,
						amortizationPercentage: 0,
						value: 0,
						quotationValue: 0,
						forwardMaturity: 0
					}
				]
			}
		]
	},
	errorMessage: 
	{
		message: String,
		statusCode: 0
	}
}