| POST | /member/validate |
|---|
namespace CalcEngineApi.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type IVirtualDirectory =
interface end
[<AllowNullLiteral>]
type IVirtualPathProvider =
abstract RootDirectory:IVirtualDirectory with get,set
abstract VirtualPathSeparator:String with get,set
abstract RealPathSeparator:String with get,set
[<AllowNullLiteral>]
type IVirtualFile =
abstract VirtualPathProvider:IVirtualPathProvider with get,set
abstract Extension:String with get,set
abstract Length:Int64 with get,set
[<Flags>]
type CacheControl =
| None = 0
| Public = 1
| Private = 2
| MustRevalidate = 4
| NoCache = 8
| NoStore = 16
| NoTransform = 32
| ProxyRevalidate = 64
[<AllowNullLiteral>]
type IContentTypeWriter =
interface end
[<AllowNullLiteral>]
type IResponse =
abstract OriginalResponse:Object with get,set
abstract Request:IRequest with get,set
abstract StatusCode:Int32 with get,set
abstract StatusDescription:String with get,set
abstract ContentType:String with get,set
abstract OutputStream:Stream with get,set
abstract Dto:Object with get,set
abstract UseBufferedStream:Boolean with get,set
abstract IsClosed:Boolean with get,set
abstract KeepAlive:Boolean with get,set
abstract HasStarted:Boolean with get,set
abstract Items:Dictionary<String, Object> with get,set
[<Flags>]
type RequestAttributes =
| None = 0
| Localhost = 1
| LocalSubnet = 2
| External = 4
| Secure = 8
| InSecure = 16
| AnySecurityMode = 24
| HttpHead = 32
| HttpGet = 64
| HttpPost = 128
| HttpPut = 256
| HttpDelete = 512
| HttpPatch = 1024
| HttpOptions = 2048
| HttpOther = 4096
| AnyHttpMethod = 8160
| OneWay = 8192
| Reply = 16384
| AnyCallStyle = 24576
| Soap11 = 32768
| Soap12 = 65536
| Xml = 131072
| Json = 262144
| Jsv = 524288
| ProtoBuf = 1048576
| Csv = 2097152
| Html = 4194304
| Wire = 8388608
| MsgPack = 16777216
| FormatOther = 33554432
| AnyFormat = 67076096
| Http = 67108864
| MessageQueue = 134217728
| Tcp = 268435456
| Grpc = 536870912
| EndpointOther = 1073741824
| AnyEndpoint = 2080374784
| InProcess = -2147483648
| InternalNetworkAccess = -2147483645
| AnyNetworkAccessType = -2147483641
| Any = -1
[<AllowNullLiteral>]
type IRequestPreferences =
abstract AcceptsBrotli:Boolean with get,set
abstract AcceptsDeflate:Boolean with get,set
abstract AcceptsGzip:Boolean with get,set
[<AllowNullLiteral>]
type IRequest =
abstract OriginalRequest:Object with get,set
abstract Response:IResponse with get,set
abstract OperationName:String with get,set
abstract Verb:String with get,set
abstract RequestAttributes:RequestAttributes with get,set
abstract RequestPreferences:IRequestPreferences with get,set
abstract Dto:Object with get,set
abstract ContentType:String with get,set
abstract IsLocal:Boolean with get,set
abstract UserAgent:String with get,set
abstract Cookies:IDictionary<String, Cookie> with get,set
abstract ResponseContentType:String with get,set
abstract HasExplicitResponseContentType:Boolean with get,set
abstract Items:Dictionary<String, Object> with get,set
abstract Headers:NameValueCollection with get,set
abstract QueryString:NameValueCollection with get,set
abstract FormData:NameValueCollection with get,set
abstract UseBufferedStream:Boolean with get,set
abstract RawUrl:String with get,set
abstract AbsoluteUri:String with get,set
abstract UserHostAddress:String with get,set
abstract RemoteIp:String with get,set
abstract Authorization:String with get,set
abstract IsSecureConnection:Boolean with get,set
abstract AcceptTypes:String[] with get,set
abstract PathInfo:String with get,set
abstract OriginalPathInfo:String with get,set
abstract InputStream:Stream with get,set
abstract ContentLength:Int64 with get,set
abstract Files:IHttpFile[] with get,set
abstract UrlReferrer:Uri with get,set
[<AllowNullLiteral>]
type HttpResult() =
member val ResponseText:String = null with get,set
member val ResponseStream:Stream = null with get,set
member val FileInfo:FileInfo = null with get,set
member val VirtualFile:IVirtualFile = null with get,set
member val ContentType:String = null with get,set
member val Headers:Dictionary<String, String> = new Dictionary<String, String>() with get,set
member val Cookies:ResizeArray<Cookie> = new ResizeArray<Cookie>() with get,set
member val ETag:String = null with get,set
member val Age:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val MaxAge:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
member val Expires:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LastModified:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CacheControl:CacheControl = new CacheControl() with get,set
member val ResultScope:Func<IDisposable> = null with get,set
member val AllowsPartialResponse:Boolean = new Boolean() with get,set
member val Options:IDictionary<String, String> = null with get,set
member val Status:Int32 = new Int32() with get,set
member val StatusCode:HttpStatusCode = new HttpStatusCode() with get,set
member val StatusDescription:String = null with get,set
member val Response:Object = null with get,set
member val ResponseFilter:IContentTypeWriter = null with get,set
member val RequestContext:IRequest = null with get,set
member val View:String = null with get,set
member val Template:String = null with get,set
member val PaddingLength:Int32 = new Int32() with get,set
member val IsPartialRequest:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type Member() =
inherit Member()
member val Id:String = null with get,set
member val Email:String = null with get,set
member val EmployeeGuidString:String = null with get,set
member val IgnoreGender:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type MemberValidateReq() =
member val Member:Member = null with get,set
[<AllowNullLiteral>]
type IHttpFile =
abstract Name:String with get,set
abstract FileName:String with get,set
abstract ContentLength:Int64 with get,set
abstract ContentType:String with get,set
abstract InputStream:Stream with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /member/validate HTTP/1.1
Host: hcbtas-q-albamfs-api.azurewebsites.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"member":{"userId":"String","systemId":"String","schemeCode":"String","sessionId":"String","clientId":"String","clientCode":"String","isDefault":false,"groupId":"String","groupNameUpper":"String","appName":"String","appNameUpper":"String","key":"String","keyUpper":"String","country":"String","locale":"String","ccy":"String","cdy":"String","status":"String","statusCode":"String","category":"String","scheme":"String","primarySalary":"String","email":"String","employer":{"id":"String","code":"String","name":"String","logo":"String","config":{}},"roles":0,"asAt":"0001-01-01T00:00:00.0000000","calcDate":"0001-01-01T00:00:00.0000000","nextEOFY":"0001-06-30T00:00:00.0000000","periodToNextEOFY":0.5,"year":0,"hasPartner":false,"includePartner":false,"includePartnerInCalc":false,"homeOwner":false,"targetAge":0,"targetTime":0,"targetIncomeR":0,"targetIncomeRFreq":0,"targetIncomeRAnnual":0,"targetP":0,"includeSS":false,"firstName":"String","lastName":"String","gender":"Female","dob":"0001-01-01T00:00:00.0000000","salary":0,"people":[{"type":"Primary","index":0,"firstName":"String","lastName":"String","gender":"Female","isAgeInput":false,"dob":"0001-01-01T00:00:00.0000000","age":0,"exactAge":0,"ageAtLast30June":0,"privateHealthInsurance":false,"serviceDate":"0001-01-01T00:00:00.0000000","service":0,"intService":0,"ageR":0,"ageRMonths":0,"email":"String","salaries":{"String":{"type":"String","ccy":"String","amount":0,"freq":0,"annualAmount":0,"indexType":"String","salaryChanges":[{"fromAge":0,"amount":0}]}},"salary":0,"salaryFreq":0,"salaryChangeSeries":[0],"hasOtherIncome":false,"otherIncome":[{"name":"String","type":"Pension","amount":0,"fromAge":0,"toAge":0,"isTaxable":false,"isVector":false,"vector":[0],"custom":{"String":"String"},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"socialSecurity":{"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"},"taxableDeductions":0,"nonTaxableDeductions":0,"careerChanges":{"willTake":false,"breaks":[{"fromAge":0,"toAge":0,"workingRate":0}],"careerBreakSeries":[0],"totalYears":0},"custom":{"String":"String"},"salaryKey":"String","annualProjectibleSalary":0,"projectionBreakdownCode":"Salary You","lookup":"Salary You:Primary","ssBreakdownCode":"SocialSecurityYou","ssLookup":"SocialSecurityYou:Primary","asAt":"0001-01-01T00:00:00.0000000","intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"assets":[{"type":"FinAsset","owner":"Primary","code":"String","assetIndex":0,"lookup":"String:Primary:0","name":"String","ccy":"String","value":0,"change":0,"transferTo":0,"transferAge":0,"willSpend":false,"minRule":"NoMinimum","maxRule":"NoMaximum","ssTreatment":"Exempt","spendOnAnnuity":false,"contTaxRate":0,"totalConts":0,"usePreCalculatedContributions":false,"totalContributions":[[0]],"futureAllocations":[[{"String":0}]],"assetType":"FinAsset","totalContsFreq":1,"totalLumpSumConts":0,"contributions":[{"code":"String","index":0,"name":"String","ccy":"String","contTable":"String","isEmployeeCont":false,"employerFlag":false,"type":"Fixed","linkedContIndex":0,"sourceRate":"String","isTaxable":false,"amount":0,"coreAmount":0,"freq":0,"rate":0,"coreRate":0,"fromAge":0,"toAge":0,"salary":0,"annualAmount":0,"annualCoreAmount":0,"isAlwaysOneOff":false,"isOneOff":true,"constraintType":"LumpSum","custom":{"String":"String"},"memberRateLookup":{"0":0},"isFromSalary":false,"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"fees":[{"name":"String","ccy":"String","amount":0,"freq":0,"annualAmount":0,"rate":0,"isTaxable":false,"fromAge":0,"toAge":0,"custom":{"String":"String"},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"feeCapArrangements":[{"name":"String","amount":0,"indexationRateSeries":0,"rate":0,"feesIncluded":[0],"fromTime":0,"toTime":0,"custom":{"String":"String"},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"custom":{"String":"String"},"rebalance":false,"retLumpSum":false,"allocSeries":[{"current":{"String":0},"future":{"String":0}}],"currentAssetClassAllocSeries":{"0":{"String":0}},"futureAssetClassAllocSeries":{"0":{"String":0}},"ratesSource":"DB","alloc":[{"name":"String","fromAge":0,"optAlloc":{"current":{"String":0},"future":{"String":0}},"currentAssetClassAlloc":{"String":0},"futureAssetClassAlloc":{"String":0},"totalCurrentAlloc":0,"totalFutureAlloc":0}],"allocKeys":["String"],"returns":{"String":[{"name":"String","fromAge":0,"earningRate":0,"taxRate":0,"returnRate":0}]},"returnRates":{"String":{"earningRates":[0],"taxRates":[0]}},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"includeAnnuities":false,"annuities":[{"priceType":"Calc","price":0,"owner":"Primary","gender":"Female","ownerAge":0,"spouseAge":0,"type":"Deferred","purchaseType":"Perc","purchaseAmount":0,"percBalanceSpent":0,"amountSpent":0,"incomePurchased":0,"purchaseAge":0,"deferralPeriod":0,"indexationName":"String","drStochastic":"String","impliedInflationStochasticSeries":"String","reversion":0,"guarantee":0,"timing":0,"scaleQx":0,"scaleQxPartner":0,"scaleImpr":0,"scaleImprPartner":0,"ageRating":0,"spouseAgeRating":0,"custom":{"String":"String"},"tableName":"String","tableNamePartner":"String","imprFactorTableName":"String","imprFactorTableNamePartner":"String","hasPartnerTables":true,"spouseAgeAtPurchase":0,"expense":0,"cacheKey":"LifeTables-String-String","partnerCacheKey":"LifeTables-String-String","targetTpx":0,"paymentTerm":0,"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"spending":{"selected":"String","willChangeLate":false,"ageRLate":0,"selectedLate":"String","goals":[{"name":"String","amount":0,"freq":0,"effectiveFreq":1,"excludeFromProjection":false,"fromAge":0,"toAge":0,"selectedPersonalised":"String","tag":"String","custom":{"String":"String"},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"lumpSumType":"Perc","lumpSumRate":0,"lumpSumAmount":0,"count":1,"custom":{"String":"String"},"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"},"investmentProperties":[{"owner":"Primary","value":0,"rentYield":0,"expense":0,"downsize":0,"downsizeAge":0,"downsizeToAsset":0,"rates":0,"lookup":"Prop:Primary","asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"}],"incomeVectors":{"String":[0]},"config":{"country":"String","clientCode":"String","isStochastic":false,"stochasticLoopType":"Parallel","stochProjServiceLoc":"WebServer","stochProjSvcCallType":"Sync","dataSet":"String","solveTarget":"NA","solveTolerance":0,"indexationRatesSource":"DB","discRatesSource":"DB","returnRatesSource":"DB","deterministicSim":0,"stochasticSim":0,"simCount":0,"simsToIncludeDetails":[0],"includeBalArray":false,"includeProjectionInStochasticResult":false,"includeFirstProjectionInStochasticResult":false,"usesStochasticData":true,"includeAllSpendingResult":false,"includeAllContributionProjectionResult":false,"includeAllAssetsProjectionResults":false,"includeAllSummaryProjectionResult":false,"includePreCalculatedContributionsInResponse":false,"includedProjections":["String"]},"indexation":[{"name":"String","fromAge":0,"rate":0}],"annuityDisc":[{"name":"String","fromAge":0,"rate":0}],"indexationRates":{"String":[0]},"annuityDiscRates":{"String":[0]},"balance":0,"planSomeValue":"String","flag1":false,"flag2":true,"isFriendly":true,"financingOption":"String","totalYears":7,"totalLoopYears":100,"age":0,"ageR":0,"intAge":0,"indexType":"String","indexTypePre":"String","indexTypePost":"String","deflationType":"String","custom":{"String":"String"},"countryCalcConfig":{},"summary":{"age":0,"salary":0,"balance":0,"invOption":"String","contributions":[{"code":"String","name":"String","assetCode":"String","assetName":"String","isEmployeeCont":false,"amount":0,"freq":0,"rate":0}]},"lastModified":"0001-01-01T00:00:00.0000000","isReturningUser":false,"clientCountryConfigCacheKey":"ClientCountryConfig-String-String","personalAssets":0,"resultsSummary":{"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"},"totalContribution":{"asAt":"0001-01-01T00:00:00.0000000","age":0,"intAge":0,"year":0,"periodToNextEOFY":0.5,"indexType":"String","deflationType":"String","indexTypePre":"String","indexTypePost":"String"},"id":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{}