Pera Administrators Service

<back to all web services

ContactSparkDataRequest

The following routes are available for this service:
GET/v1/Contact/{EmployeeSSN}/SparkData

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

HTTP + XML

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

POST /xml/reply/ContactSparkDataRequest HTTP/1.1 
Host: testapi.peraadministrators.com 
Content-Type: application/xml
Content-Length: length

<ContactSparkDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <EmployeeSSN>String</EmployeeSSN>
</ContactSparkDataRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactSparkDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PeraAdministrators.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <SparkData>
    <ContactSparkData>
      <AITD15YearCatchUpContributions>0</AITD15YearCatchUpContributions>
      <AITDEEContributions>0</AITDEEContributions>
      <AggregatorPlanID>String</AggregatorPlanID>
      <AggregatorSourceName>String</AggregatorSourceName>
      <CashValue403b7>0</CashValue403b7>
      <CashValueDate>0001-01-01T00:00:00</CashValueDate>
      <CashValueEE1986>0</CashValueEE1986>
      <CashValueER1986>0</CashValueER1986>
      <CashValueType3>String</CashValueType3>
      <ContractCertificateIssueDate>0001-01-01T00:00:00</ContractCertificateIssueDate>
      <DateofBirth>0001-01-01T00:00:00</DateofBirth>
      <DateofFirstRothContribution>0001-01-01T00:00:00</DateofFirstRothContribution>
      <EEDeferralCashValue>0</EEDeferralCashValue>
      <EEPostTaxCashValue>0</EEPostTaxCashValue>
      <EmployeeAccountNumber>String</EmployeeAccountNumber>
      <EmployeeFirstName>String</EmployeeFirstName>
      <EmployeeID>String</EmployeeID>
      <EmployeeLastName>String</EmployeeLastName>
      <EmployeeSSN>String</EmployeeSSN>
      <EmployerCashValue>0</EmployerCashValue>
      <EmployerEIN>String</EmployerEIN>
      <EmployerPlanID>String</EmployerPlanID>
      <HardshipComponentA>0</HardshipComponentA>
      <HardshipComponentB>0</HardshipComponentB>
      <HardshipComponentC>0</HardshipComponentC>
      <HardshipComponentD>0</HardshipComponentD>
      <HardshipReportingMethod>String</HardshipReportingMethod>
      <HighestOutstandingLoanBalance12MonthsComponent3>0</HighestOutstandingLoanBalance12MonthsComponent3>
      <Id>0</Id>
      <InServiceAvailableCashValue>0</InServiceAvailableCashValue>
      <LatestHardshipDistributionAmount>0</LatestHardshipDistributionAmount>
      <LatestHardshipDistributionDate>0001-01-01T00:00:00</LatestHardshipDistributionDate>
      <LatestHardshipDistributionType>String</LatestHardshipDistributionType>
      <LoanDefaultIndicator>String</LoanDefaultIndicator>
      <LoanInitiationDateComponent3>0001-01-01T00:00:00</LoanInitiationDateComponent3>
      <LoanStatusComponent3>String</LoanStatusComponent3>
      <LoanTypeIndicatorComponent3>String</LoanTypeIndicatorComponent3>
      <MaximumLoanAmountEligibleVendor>0</MaximumLoanAmountEligibleVendor>
      <MethodofReportingLoanData>String</MethodofReportingLoanData>
      <NumberofSetsofLoanComponentDataReported>String</NumberofSetsofLoanComponentDataReported>
      <OriginalLoanAmountComponent3>0</OriginalLoanAmountComponent3>
      <ProductID>String</ProductID>
      <RemainingBalanceDateComponent3>0001-01-01T00:00:00</RemainingBalanceDateComponent3>
      <RemainingLoanBalanceComponent3>0</RemainingLoanBalanceComponent3>
      <RolloverEEPostTaxCashValue>0</RolloverEEPostTaxCashValue>
      <RolloverEEPreTaxCashValue>0</RolloverEEPreTaxCashValue>
      <RolloverRothCashValue>0</RolloverRothCashValue>
      <RothCashValue>0</RothCashValue>
      <SparkHeaderId>0</SparkHeaderId>
      <TotalHardshipAmountAvailable>0</TotalHardshipAmountAvailable>
      <TypeofAccount>String</TypeofAccount>
      <VendorEIN>String</VendorEIN>
      <VendorLoanNumberComponent5>String</VendorLoanNumberComponent5>
      <VendorPlanID>String</VendorPlanID>
      <VendorSourceID>String</VendorSourceID>
      <VendorSourceName>String</VendorSourceName>
      <YTDEEContributions>0</YTDEEContributions>
      <YTDERContributions>0</YTDERContributions>
    </ContactSparkData>
  </SparkData>
</ContactSparkDataResponse>