This article contains a brief description of the enhancements and updates in PensionPro API.

 

New Endpoints

  • Clients/Employer Data List Values

    • clients/categories (GET/HEAD/POST)
    • clients/categories/{clientCategoryId} (GET/PUT)
    • employerdata/entitytypes (GET/HEAD/POST)
    • employerdata/entitytypes/{entityTypeId} (GET/PUT)
    • employerdata/officertitles (GET/HEAD/POST)
    • employerdata/officertitles/{officerTitleId} (GET/PUT)
    • employerdata/payrollfrequencies (GET/HEAD/POST)
    • employerdata/payrollfrequencies/{payrollFrequencyId} (GET/PUT)
    • employerdata/relationships (GET/HEAD/POST)
    • employerdata/relationships/{familyRelationshipId} (GET/PUT)
  • Contact List Values

    • contacts/contactcategories (GET/HEAD/POST)
    • contacts/contactgroupings (GET/HEAD/POST)
    • contacts/contactprofessions (GET/HEAD/POST)
    • contacts/contactSources (GET/HEAD/POST)
    • contacts/contactstatuses (GET/HEAD/POST)
    • contacts/preferences (GET/HEAD/POST)
    • contacts/prefixes (GET/HEAD/POST)
    • contacts/suffixes (GET/HEAD/POST)
    • contacts/contactcategories/{contactCategoryId} (GET/PUT)
    • contacts/contactgroupings/{contactGroupingId} (GET/PUT)
    • contacts/contactprofessions/{contactProfessionId} (GET/PUT)
    • contacts/contactSources/{contactSourceId} (GET/PUT)
    • contacts/contactstatuses/{contactStatusId} (GET/PUT)
    • contacts/preferences/{preferenceId} (GET/PUT)
    • contacts/prefixes/{prefixId} (GET/PUT)
    • contacts/suffixes/{suffixId} (GET/PUT)
  • File Type List Values 

    • adminformfiletypes (POST)
    • adminformfiletypes/{adminFormPlanFileTypeId} (GET/PUT)
    • adminformplanfiles/adminformfiletypes (GET/HEAD)
    • datacollectionfiletypes (POST)
    • datacollectionfiletypes/{dataCollectionFileTypeId} (GET/PUT)
    • datacollections/datacollectionfiletypes (GET/HEAD)
    • distributionfiles/distributionfiletypes (GET/HEAD)
    • distributionfiletypes (POST)
    • distributionfiletypes/{distributionFileTypeId} (GET/PUT)
    • fiduciaryfiles/fiduciaryfiletypes (GET/HEAD)
    • fiduciaryfiletypes (POST)
    • fiduciaryfiletypes/{fiduciaryFileTypeId} (GET/PUT)
    • legalplanfiles/legalplanfiletypes (GET/HEAD)
    • legalplanfiletypes (POST)
    • legalplanfiletypes/{legalPlanFileTypeId} (GET/PUT)
    • projectfiles/projectfiletypes (GET/HEAD)
    • projectfiletypes (POST)
    • projectfiletypes/{projectFileTypeId} (GET/PUT)
  • General List Values

    • addresstypes (GET/HEAD/POST)
    • addresstypes/{addressTypeId} (GET/PUT)
    • billingcodes (GET/HEAD/POST)
    • billingcodes/{billingCodeId} (GET/PUT)
    • documentspecifications (GET/HEAD/POST)
    • documentspecifications/{documentSpecificationId} (GET/PUT)
    • notes/notecategories (GET/HEAD/POST)
    • notes/notecategories/{noteCategoryId} (GET/PUT)
    • numbertypes (GET/HEAD/POST)
    • numbertypes/{numberTypeId} (GET/PUT)
    • statuses (GET/HEAD/POST)
    • statuses/{statusId} (GET/PUT)
    • todos/todostatuses (GET/HEAD/POST)
    • todos/todostatuses/{todoStatusId} (GET/PUT)
  • Investment List Values

    • datacollectionsources (GET/HEAD/POST)
    • datacollectionsources/{dataCollectionSourceId} (GET/PUT)
    • distributionprocessors (GET/HEAD/POST)
    • distributionprocessors/{distributionProcessorId} (GET/PUT)
    • feedisclosuretypes (GET/HEAD/POST)
    • feedisclosuretypes/{feeDisclosureTypeId} (GET/PUT)
    • investmentproviders/investmentdirections (GET/HEAD/POST)
    • investmentproviders/investmentdirections/{investmentDirectionId} (GET/PUT)
    • investmentproviders/investmentmodels (GET/HEAD/POST)
    • investmentproviders/investmentmodels/{investmentModelId} (GET/PUT)
    • investmentproviders/investmentproviders (GET/HEAD/POST)
    • investmentproviders/investmentproviders/{investmentProviderId}
    • responsibility1099s (GET/HEAD/POST)
    • responsibility1099s/{responsibility1099Id} (GET/PUT)
    • revenuesharingtypes (GET/HEAD/POST)
    • revenuesharingtypes/{revenueSharingTypeId} (GET/PUT)
    • transferstatuses (GET/HEAD/POST)
    • transferstatuses/{transferStatusId} (GET/PUT)
    • vestingsubmissions (GET/HEAD/POST)
    • vestingsubmissions/{vestingSubmissionId} (GET/PUT)
  • Plan List Values

    • plans/administrationtypes (GET/HEAD/POST)
    • plans/administrationtypes/{planAdministrationTypeId} (GET/PUT)
    • plans/claimProcessingLocations (GET/HEAD/POST)
    • plans/claimProcessingLocations/{claimProcessingLocationId} (GET/PUT)
    • plans/clientServicingLevels (GET/HEAD/POST)
    • plans/clientServicingLevels/{clientServicingLevelId} (GET/PUT)
    • plans/comboplans (GET/HEAD/POST)
    • plans/comboplans/{comboPlanId} (GET/PUT)
    • plans/employeeplanroles (GET/HEAD/POST)
    • plans/employeeplanroles/{employeePlanRoleId} (GET/PUT)
    • plans/filingcycles (GET/HEAD/POST)
    • plans/filingcycles/{filingCycleId} (GET/PUT)
    • plans/form5500types (GET/HEAD/POST)
    • plans/form5500types/{form5500TypeId} (GET/PUT)
    • plans/iRARolloverProviders (GET/HEAD/POST)
    • plans/iRARolloverProviders/{iRARolloverProviderId} (GET/PUT)
    • plans/participantStatementDeliveries (GET/HEAD/POST)
    • plans/participantStatementDeliveries/{participantStatementDeliveryId} (GET/PUT)
    • plans/payor1099s (GET/HEAD)
    • plans/payor1099s/{payor1099Id} (GET)
    • plans/payrollContributionCalculations (GET/HEAD/POST)
    • plans/payrollContributionCalculations/{payrollContributionCalculationId} 
    • plans/payrollfrequencies (GET/HEAD/POST)
    • plans/payrollfrequencies/{payrollFrequencyId} (GET/PUT)
    • plans/pbgcs (GET/HEAD/POST)
    • plans/pbgcs/{pbgcId} (GET/PUT)
    • plans/plancategories (GET/HEAD/POST)
    • plans/plancategories/{planCategoryId} (GET/PUT)
    • plans/plancontactroles (GET/HEAD/POST)
    • plans/plancontactroles/{planContactRoleId} (GET/PUT)
    • plans/planCycleStatus (GET/HEAD/POST)
    • plans/planCycleStatus/{planCycleStatusId} (GET)
    • plans/plangroups (GET/HEAD/POST)
    • plans/plangroups/{planGroupId} (GET/PUT)
    • plans/planOnHoldReasons (GET/HEAD/POST)
    • plans/planOnHoldReasons/{planOnHoldReasonId} (GET/PUT)
    • plans/planstatuses (GET/HEAD/POST)
    • plans/planstatuses/{planStatusId} (GET/PUT)
    • plans/plantypes (GET/HEAD/POST)
    • plans/plantypes/{planTypeId} (GET/PUT)
    • plans/qdiafundnames (GET/HEAD/POST)
    • plans/qdiafundnames/{qdiaFundNameId} (GET/PUT)
    • plans/remittanceTypes (GET/HEAD/POST)
    • plans/remittanceTypes/{remittanceTypeId} (GET/PUT)
    • plans/servicesProvided (GET/HEAD/POST)
    • plans/servicesProvided/{servicesProvidedId} (GET/PUT)
    • plans/terminationreasons (GET/HEAD/POST)
    • plans/terminationreasons/{terminationReasonId} (GET/PUT)
    • plans/tradingPlatforms (GET/HEAD/POST)
    • plans/tradingPlatforms/{tradingPlatformId} (GET/PUT)
    • plans/valuationfrequencies (GET/HEAD/POST)
    • plans/valuationfrequencies/{valuationFrequencyId} (GET/PUT)
  • Project List Values

    • projects/coverageTiers (GET/HEAD/POST)
    • projects/coverageTiers/{coverageTierId} (GET/PUT)
    • projects/eventCategories (GET/HEAD/POST)
    • projects/eventCategories/{eventCategoryId} (GET/PUT)
    • projects/projectfields (GET/HEAD/POST)
    • projects/projectfields/{projectFieldId} (GET/PUT)
    • projects/projecttypes (GET/HEAD/POST)
    • projects/projecttypes/{projectTypeId} (GET/PUT)
    • projects/separationReasons (GET/HEAD/POST)
    • projects/separationReasons/{separationReasonId} (GET/PUT)
    • projects/taskCategories (GET/HEAD/POST)
    • projects/taskCategories/{taskCategoryId} (GET/PUT)
    • projects/taskStatuses (GET/HEAD/POST)
    • projects/taskStatuses/{taskStatusId} (GET/PUT)
  •  SalesPitch List Values

    • brokerdealers (GET/HEAD/POST)
    • brokerdealers/{brokerDealerId} (GET/PUT)
    • investmentcustodians (GET/HEAD/POST)
    • investmentcustodians/{investmentCustodianId} (GET/PUT)
    • investmentdirections (GET/HEAD/POST)
    • investmentdirections/{investmentDirectionId} (GET/PUT)
    • investmenttypes (GET/HEAD/POST)
    • investmenttypes/{investmentTypeId} (GET/PUT)
    • opportunityadmintypes (GET/HEAD/POST)
    • opportunityadmintypes/{opportunityAdminTypeId} (GET/PUT)
    • opportunityfiles/opportunityfiletypes (GET/HEAD/POST)
    • opportunityfiles/opportunityfiletypes/{opportunityFileTypeId} (GET/PUT)
    • opportunitystatuses (GET/HEAD/POST)
    • opportunitystatuses/{opportunityStatusId} (GET/PUT)
    • plancyclefrequencies (GET/HEAD/POST)
    • plancyclefrequencies/{planCycleFrequencyId} (GET/PUT)
    • platformpreferences (GET/HEAD/POST)
    • platformpreferences/{platformPreferenceId} (GET/PUT)
    • proposal/conversiontypes (GET/HEAD/POST)
    • proposal/conversiontypes/{conversionTypeId} (GET/PUT)
    • proposal/investmentProviders (GET/HEAD/POST)
    • proposal/investmentProviders/{investmentProviderId} (GET/PUT)
    • proposal/planTypes (GET/HEAD/POST)
    • proposal/planTypes/{planTypeId} (GET/PUT)
    • proposal/resultreasons (GET/HEAD/POST)
    • proposal/resultreasons/{proposalResultReasonId} (GET/PUT)
    • proposal/statuses (GET/HEAD/POST)
    • proposal/statuses/{proposalStatusId} (GET/PUT)
    • proposal/valuationfrequencies (GET/HEAD/POST)
    • proposal/valuationfrequencies/{valuationFrequencyId} (GET/PUT)
    • proposalfiles/proposalfiletypes (GET/HEAD/POST)
    • proposalfiles/proposalfiletypes/{proposalFileTypeId} (GET/PUT)
    • prospectfiles/prospectfiletypes (GET/HEAD/POST)
    • prospectfiles/prospectfiletypes/{prospectFileTypeId} (GET/PUT)
    • prospects/contactroles (GET/HEAD/POST)
    • prospects/contactroles/{salesContactRoleId} (GET/PUT)
    • prospects/prospectcategory (GET/HEAD/POST)
    • prospects/prospectcategory/{prospectCategoryId} (GET/PUT)
    • prospects/salesreferralsources (GET/HEAD/POST)
    • prospects/salesreferralsources/{salesReferralSourceId} (GET/PUT)
    • salesterritories (GET/HEAD/POST)
    • salesterritories/{salesTerritoryId} (GET/PUT)

 

Changes in Endpoints

 

Prior API Endpoint Current API Endpoint
api/addresses/types api/addresstypes (Get All)
api/numbers/types api/numbertypes (Get All)
api/servicesProvided api/plans/servicesProvided (Get, GetById, Update)
api/payer1099s api/plans/payer1099s (Get, GetById, Update)
api/participants/separationReasons api/projects/separationReasons (Get All)
api/participants/coverageTiers api/projects/coverageTiers (Get All)
api/plans/{planId}/employeeplanlinks api/plans/{planId}/employeeplanroles (Get, GetById, Update)

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments