{ "uuid": "bc80d0f4-eb53-4ce1-850b-61ae0df2d6c5", "lastMigration": 29, "name": "Advicent.FactFinderService", "endpointPrefix": "factfinder", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "b8f9ad5a-9c6c-426f-99bd-72ba74c73161", "documentation": "Description: This operation retrieves all Account Types for the specified country.
\r\n Purpose: Provides access to the Account Types including id and type description.", "method": "get", "endpoint": "api/AccountTypes", "responses": [ { "uuid": "cd313d66-f9bf-4f33-891e-e6cd1f4c138e", "body": "{\n \"accountTypes\": [\n {\n \"allowedSavingsTypes\": [\n {\n \"typeName\": \"{{oneOf (array 'PostTaxSavings' 'PreTaxSavings' 'EmployerSavings' 'MandatorySavings')}}\",\n \"validAmountTypes\": [\n \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\"\n ]\n }\n ],\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1900fc8c-b2ed-48e7-8f2b-2e2017981c74", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "736f3403-3b79-436b-98ac-a733b183d974", "body": "", "latency": 0, "statusCode": 404, "label": "Account Type not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "42ffb3fe-9a68-43a9-8fed-92cb02b8977d", "documentation": "Description: This operation retrieves all Account Types for the specified id.
\r\n Purpose: Provides access to the Account Types including id and type description.", "method": "get", "endpoint": "api/AccountTypes/:id", "responses": [ { "uuid": "74289fa8-501b-4941-a43c-6008df2a698e", "body": "{\n \"allowedSavingsTypes\": [\n {\n \"typeName\": \"{{oneOf (array 'PostTaxSavings' 'PreTaxSavings' 'EmployerSavings' 'MandatorySavings')}}\",\n \"validAmountTypes\": [\n \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\"\n ]\n }\n ],\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "20e0fb43-5231-4146-91d2-d9f603153b53", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "081eaa97-2bd8-4db9-acad-64d984218d47", "body": "", "latency": 0, "statusCode": 404, "label": "Account Type not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e6f2de00-2ea8-476a-906f-f74736884ce5", "documentation": "Description: This operation retrieves all Accounts for the specified Fact Finder ID and/or external source ID.
\r\n Purpose: Provides access to the Account information including description and market value.", "method": "get", "endpoint": "api/Accounts", "responses": [ { "uuid": "5b52d58d-18c3-4a70-afbe-9c0798b3473a", "body": "{\n \"accounts\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "15dcfc49-08ac-449c-875e-2613b5b77051", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5d89e3cc-4b9d-45fd-bcdb-479086aea9eb", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf6404a1-db03-4e2f-afba-0ece7eca132f", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d6a3f08-af15-445d-b799-061372fa6de5", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "400d0469-7d91-48b6-9e52-d5ca0faa26b7", "documentation": "Description: The operation creates an Account.
\r\n Purpose: Allows for creation of Accounts on a Fact Finder.", "method": "post", "endpoint": "api/Accounts", "responses": [ { "uuid": "491c857b-bc3c-461e-af67-9493e1574824", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2663d4ae-85a3-4e47-9f0a-195320c09c5f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3249c81d-4bef-4eee-95f3-cbb0363fe6ff", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3b49d141-747d-427e-8471-9024a2f006a5", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5879583-61d5-48ac-b5e8-134fd42f0b4b", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9793cb28-29b2-480c-ae38-48d5d920844c", "documentation": "Retrieves all holdings in the specified Account.", "method": "get", "endpoint": "api/Accounts/:accountId/Holdings", "responses": [ { "uuid": "77b69df6-7eef-4069-9189-0bb9c4b432c1", "body": "{\n \"holdings\": [\n {\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6d3c63d3-27ea-427a-b06f-11740221bc3a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ee229e6-c2ec-4610-93e1-ba7f17e1109b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5bdb6657-3eb8-445d-a027-a5141de1cfb8", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9dc5f4c4-db9b-4681-b810-806e44d23340", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a2e1073-7deb-406a-885c-f3d9da0b30cd", "documentation": "Creates a holding and adds it to an existing Account.", "method": "post", "endpoint": "api/Accounts/:accountId/Holdings", "responses": [ { "uuid": "5a95649d-9ebc-46fd-aa87-e6618efb8fb1", "body": "{\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "74527d6a-08f4-4a55-a420-3767b60b4263", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3c1158c1-2d47-4d99-be37-fae7aa51b291", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e552c73c-9362-42f5-b761-1586d363c11a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9156a0ff-2411-46d8-a46a-726f26bd4d8d", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b511fbc-5b8f-4032-8561-b82ed7118cc0", "documentation": "Updates all holdings associated with an account", "method": "put", "endpoint": "api/Accounts/:accountId/Holdings", "responses": [ { "uuid": "d3bf1213-a5ea-467c-9081-1d50f853b326", "body": "{\n \"holdings\": [\n {\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6736de49-47f7-4337-9d3a-d6cac4e01ddd", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "99eda2e7-cd2d-4799-8f2c-a9dfc85c94d8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "16b21a1d-2134-42cb-a28a-0a9056cd9a59", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c85d3213-c909-4aac-b1f2-51ce7e105222", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1982f9d0-7523-4e61-93bc-fd0e918a3f06", "documentation": "Description: This operation deletes a single Account Holding for the specified Account Holding ID and Account ID.
\r\n Purpose: Provides the ability to remove individual holdings from a specified Account.", "method": "delete", "endpoint": "api/Accounts/:accountId/Holdings/:id", "responses": [ { "uuid": "4e3f4752-cbda-4a6e-9ad7-4eb4d6ea35d1", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b50e9645-c6a0-4671-855e-2ed69b865805", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e7d08e3b-9a97-4d60-8c2f-0308ea3b734a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4ae504a8-8b63-4f41-99ac-65902e4d4928", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "75747821-b935-49cb-9654-0030a0ea675b", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a337fc2a-9280-4c47-ac46-1ba9c3095cef", "documentation": "Description: This operation retrieves a single Account Holding for the specified Account Holding ID and Account ID.
\r\n Purpose: Provides access to the Account Holding information including description and market value.", "method": "get", "endpoint": "api/Accounts/:accountId/Holdings/:id", "responses": [ { "uuid": "dd786d1b-6b5b-41df-bd98-d8a30ae9b712", "body": "{\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bb57c8a5-a938-4d14-b3b3-dc3dc2111deb", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "578da736-41f0-4198-9344-ead68ec52aa0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "11fdb549-b972-4b34-90f1-5505bd9d69ec", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0edb52b7-903c-4e41-b063-a4ca87a0adf1", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f5c56f4c-00a7-4e5e-bc90-fa56d7489272", "documentation": "Updates a holding associated with an account", "method": "put", "endpoint": "api/Accounts/:accountId/Holdings/:id", "responses": [ { "uuid": "bd63a592-7cf5-42d4-bda7-6eca810e307e", "body": "{\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3f5608de-7990-4ac4-abb0-b4e35f087b37", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3c352010-bcb5-4d56-bffe-661e355088d5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d5777e5d-6430-4ff3-b983-c3d9fdbc5306", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b1f69301-3f02-41f7-8999-01c17ea37b37", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c8d36c1-ce8d-46d6-bc67-165a7eadd9ca", "documentation": "Deletes all savings strategies tied to an account", "method": "delete", "endpoint": "api/Accounts/:accountId/SavingsStrategies", "responses": [ { "uuid": "724e14fd-e18a-4d87-9525-eb9ece577d33", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "31d49bae-556c-433b-81f3-2d561e62c8df", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97942e38-54dc-4541-b823-1a66718c4d04", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6b4e797c-91df-405e-9d83-254424bb3821", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d93263e2-3543-4609-b43d-d0a99d91705f", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10a9500c-d4c5-474b-93ea-59aa699c1446", "documentation": "Get all of the savings strategies for a specific account", "method": "get", "endpoint": "api/Accounts/:accountId/SavingsStrategies", "responses": [ { "uuid": "81b31ac4-9c4e-46e0-980b-486ccda8d22b", "body": "{\n \"savingsStrategies\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "26da7e18-6b51-4a4e-91ba-9517c9a1fcd0", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a14664d6-4c45-41c8-965d-788ef28704b5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "50606877-33d4-4b90-80d7-a820e2691320", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fb50d252-5747-4cd0-9f7f-d9c8ff6aa30e", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dec5c7a1-ee92-45b6-8264-d541afc87953", "documentation": "Creates a savings strategy on a specific account", "method": "post", "endpoint": "api/Accounts/:accountId/SavingsStrategies", "responses": [ { "uuid": "5fec25d4-30de-4b8b-ba80-4567e81b5740", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b2a78357-998b-43db-ad98-30c861ae51a0", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "216da0ea-4a7e-494d-a305-4770fb99cc3c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "657d95a2-2e45-4e21-b65d-ab9101e1ba33", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d6cd94d7-1399-4e26-9adb-b8f939d5d647", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e9e5977b-07d9-4ed9-b1ae-faba31b34db0", "documentation": "Deletes a specific savings strategy", "method": "delete", "endpoint": "api/Accounts/:accountId/SavingsStrategies/:id", "responses": [ { "uuid": "cec33917-33d9-4cf0-a2b4-bd709e5fe064", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cf36b65b-fbc8-4e75-8529-b008c2d7a000", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2be400e7-1c31-48ee-b740-5f76b08cce8e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a6149333-120a-4bb7-a9a8-a2df500f29d6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "41188700-a2ac-4228-9b2e-9cabd9f22ec0", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ae4ac58-41fd-4867-b349-d81b0407e5a6", "documentation": "Get a specific savings strategy for an account", "method": "get", "endpoint": "api/Accounts/:accountId/SavingsStrategies/:id", "responses": [ { "uuid": "241be0b6-0586-49d1-bf10-08ad4a2ebe38", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2a01c6d8-38f1-4e6d-be09-78749d5e73d7", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7f608a70-0bf4-413f-a97b-338ed59b5df8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6a5bc9ef-d6ae-4911-99a1-a3de4dbbc4af", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6e7ec8e9-c6db-4b44-85d4-56590e20c798", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b876868-9a7e-4d2c-b306-12129faffaf6", "documentation": "Updates a specific savings strategy", "method": "put", "endpoint": "api/Accounts/:accountId/SavingsStrategies/:id", "responses": [ { "uuid": "a9be589b-b3e1-491d-871f-89a0c79875ee", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35336ee6-1e62-4835-8889-5dd2017bec52", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a5c2e7b7-873b-4e4c-a02e-ff4a0e3e7e09", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "af691138-1c99-43e9-b9ae-a9d25297f258", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ca43ed0d-22b4-4182-831a-74a3bcf933e2", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f951a41d-3d2b-4d86-bb65-8cff5c1ebe03", "documentation": "Description: The operation removes an Account tied to a Fact Finder.
\r\n Purpose: Allows for removal of an Account from a Fact Finder.", "method": "delete", "endpoint": "api/Accounts/:id", "responses": [ { "uuid": "0ae6d267-4642-44b5-b995-3525705fd691", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "80136d2e-83b4-4826-a09e-b5276f101faa", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "995112a7-27a9-4fef-a990-4e35e72d40e1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "79580ca0-5f80-4eb4-8a8f-f1dcff32aaac", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63d90c69-5739-494d-9463-4d346edb2a52", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a7bd6969-b07a-4ee0-9faf-97e2cbcc95df", "documentation": "Description: This operation retrieves a single Account for the specified Account ID.
\r\n Purpose: Provides access to the Account information including description and market value.", "method": "get", "endpoint": "api/Accounts/:id", "responses": [ { "uuid": "572e67a8-8a44-49ba-98c8-278401f0432d", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "08fa5132-e79c-4a4b-ab42-125b529f1a99", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8534b823-28f9-4a77-8ef9-ee71c71bf8dc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1b466797-19df-4406-9115-7ec7d0eef22e", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0596aa87-840b-46c8-9b0c-46c6a43f0ea4", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0a80202b-da8b-42fa-88ca-163093b6cf01", "documentation": "Description: The operation updates an Account, deletes associated saving strategies if the account type changes.
\r\n Purpose: Allows for complete replacement of an Account on a Fact Finder.", "method": "put", "endpoint": "api/Accounts/:id", "responses": [ { "uuid": "f3faabb4-fff3-487c-ae73-3f17722e9705", "body": "{\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86a73b2c-be89-43a3-acb6-aba9c6592c8c", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "daa15c88-76b3-44a2-85d0-55c826e1e421", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e628558a-d5d0-409e-ae48-26b7765a8519", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "506d6525-9774-4e0b-9426-8dc0764ecf24", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc8d8b11-ae1e-4ca7-b6bc-1dc1dddcfc63", "documentation": "Description: This operation submits the Fact Finder data to an external system.
\r\n Purpose: Allows Fact Finder data to be persisted in another system for that system's consumption and use.", "method": "post", "endpoint": "api/Clients", "responses": [ { "uuid": "7538da80-2c37-4927-942a-2de0186938da", "body": "{\n \"clientId\": {{faker 'number.int' max=99999}},\n \"message\": \"\",\n \"ownerUser\": \"\",\n \"planId\": {{faker 'number.int' max=99999}},\n \"success\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b9973752-a9ef-4f66-9ae1-5a3fcd2eddde", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48900b19-dbaa-48c5-b6ce-38ef88c23e42", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Client data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5252da9c-f5f3-4a76-bb0f-eda92567a648", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Client.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f76eed4-6294-4a99-b7ed-1098eac5e4da", "documentation": "Description: This operation retrieves all Critical Illness Insurance Policies for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Critical Illness Insurance Policies including description and policy type.", "method": "get", "endpoint": "api/CriticalIllnessInsurancePolicies", "responses": [ { "uuid": "03c80349-bce4-411c-a5fa-fab5caf636d7", "body": "{\n \"criticalIllnessInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c79bfeee-dfd6-406d-9ec7-1afe931bc374", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eaf8a40a-108a-47be-bfa3-1081ee262f4c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Critical Illness Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5c12360-0003-460b-a29b-714d48c01d1e", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Critical Illness Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2680a115-9243-429c-8e91-b16c01f58fd9", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "847ff19c-3004-4efc-b344-18295cdf7946", "documentation": "Description: The operation creates a Critical Illness Insurance Policy.
\r\n Purpose: Allows for creation of Critical Illness Insurance Policies on a Fact Finder.", "method": "post", "endpoint": "api/CriticalIllnessInsurancePolicies", "responses": [ { "uuid": "a7411e24-eb3d-49fc-acc8-75486a2aac38", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ad1fbf89-7276-4b9f-a1e7-03dacf1167f0", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8d36c907-6082-4d31-808f-79254e8cf6bc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Critical Illness Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f3ae2173-c69f-45d1-90c9-817236ec265c", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Critical Illness Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59b5f44d-3f58-490c-8a2f-28bcab35e6cf", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8bbc0091-3700-4356-941d-22b68fc31310", "documentation": "Description: The operation removes a Critical Illness Insurance Policy tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Critical Illness Insurance Policy from a Fact Finder.", "method": "delete", "endpoint": "api/CriticalIllnessInsurancePolicies/:id", "responses": [ { "uuid": "8e9c5bf8-e5f6-43fe-bd21-77f4f88e5bc7", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7a623cc4-cb7f-4607-bdf3-27a2f6b659d7", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e0652fa6-ace1-40a6-a008-82d306169f72", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Critical Illness Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4a049191-94ae-4ac5-a468-3caeec23b500", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Critical Illness Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5d39762f-cf25-4b4b-b07f-52050a548a45", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4aab651b-8baa-44bd-966e-57e0801dc2e3", "documentation": "Description: This operation retrieves a single Critical Illness Insurance Policy for the specified Critical Illness Insurance Policy ID.
\r\n Purpose: Provides access to the Critical Illness Insurance Policy including description and policy type.", "method": "get", "endpoint": "api/CriticalIllnessInsurancePolicies/:id", "responses": [ { "uuid": "85e8dc1f-b9ee-43c2-87c0-d22b95a4049f", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c7090a5b-21db-4716-b986-2c265ced20ea", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e86736ad-6e31-4831-832c-b614a2679296", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Critical Illness Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3ad178b5-190d-4215-ab27-c69ec7f6962d", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Critical Illness Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3eee9f29-1b51-4817-93b2-633338c33ed3", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "638f815b-e062-438a-ae0d-8ada1c90a309", "documentation": "Description: The operation updates a Critical Illness Insurance Policy.
\r\n Purpose: Allows for complete replacement of a Critical Illness Insurance Policy on a Fact Finder.", "method": "put", "endpoint": "api/CriticalIllnessInsurancePolicies/:id", "responses": [ { "uuid": "c7d76cc1-06b1-46d8-8229-5cbe109c2cb0", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b26c8c75-5cad-4965-8bb8-0cb17bfd60d4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "565ff82c-a7b6-42ef-aba0-204f61a633a9", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Critical Illness Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "99932bd7-2f5e-49dd-95b7-afe887cc6e97", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Critical Illness Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "248ee496-bd41-4297-adb6-2a5d3644cd51", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2cb4f029-679a-4a8e-983b-5828de4f4fae", "documentation": "Description: This operation retrieves all Critical Illness Insurance Policy Types for the specified country.
\r\n Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/CriticalIllnessInsurancePolicyTypes", "responses": [ { "uuid": "36f1a760-1e49-4ebf-ae09-dcfa8bf03503", "body": "{\n \"insurancePolicyTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3b726b20-43f2-4a54-8cb8-5fc2c576086d", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "de95dd39-298e-475c-8ffc-86adc65585ef", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6a659182-17b5-4d1f-84c9-5f228736955e", "documentation": "Description: This operation retrieves the Critical Illness Insurance Policy Type for the specified id.
\r\n Purpose: Provides access to the Critical Illness Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/CriticalIllnessInsurancePolicyTypes/:id", "responses": [ { "uuid": "0ae7ff3b-18ca-4a93-8fa9-58e9c7f685fe", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f23ed432-b7ed-42b7-8431-aa454b7b6871", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12ae652d-f770-49c6-82fb-9ce3d971bdd9", "body": "", "latency": 0, "statusCode": 404, "label": "Critical Illness Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b430e5ef-f927-40df-bf2e-5d3ca930bc06", "documentation": "Description: This operation retrieves all Defined Benefit Pensions for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Defined Benefit Pensions including description and start date.", "method": "get", "endpoint": "api/DefinedBenefitPensions", "responses": [ { "uuid": "de4ae772-69ef-4d2d-8bac-722813a0f58f", "body": "{\n \"definedBenefitPensions\": [\n {\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d8021927-c31a-4c93-81a6-73866d268611", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ba9a5537-dae2-4134-9b97-ab00e135591c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "00be51d4-d1ee-4aae-a2fa-f25bd08b15b2", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69e9939a-b664-491e-ba9b-4cfce76e53ef", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d52cffde-6016-47f2-b687-e763cc58b2c8", "documentation": "Description: The operation creates a Defined Benefit Pension.
\r\n Purpose: Allows for creation of Defined Benefit Pensions on a Fact Finder.", "method": "post", "endpoint": "api/DefinedBenefitPensions", "responses": [ { "uuid": "4bcd77ef-e75b-4841-b0e4-37c40d89833a", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "42bc5521-f809-4bc3-89a8-4314fb25bf13", "body": "{\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1fbfb2c1-45a6-40ad-b3f6-0eef54a62e23", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c97d573f-841e-448c-919a-c0b5dde55945", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1b24040c-ca94-460b-b011-38dcee672476", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "18a86050-1362-48a1-8bf5-ec1ca04b3636", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e57fea9e-2895-4599-9f8c-fcb69eda941a", "documentation": "Description: The operation removes a Defined Benefit Pension tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Defined Benefit Pension from a Fact Finder.", "method": "delete", "endpoint": "api/DefinedBenefitPensions/:id", "responses": [ { "uuid": "d93504c9-04ba-4fb0-ba5e-b7e121156d62", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "389b6343-92e3-4b85-a7be-db7783401760", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "49138b71-a894-4043-891d-790f551ad553", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "589aed1c-76f9-446f-afe5-dea83d0be98a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "66a59549-6a0c-4dd9-9020-8c23f95de843", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "945dac2a-9dd1-4e34-966a-97b04ab27d38", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f10f45e4-0352-4c2e-b2a8-b114db7fa372", "documentation": "Description: This operation retrieves a single Defined Benefit Pension for the specified Defined Benefit Pension ID.
\r\n Purpose: Provides access to the Defined Benefit Pension including description and start date.", "method": "get", "endpoint": "api/DefinedBenefitPensions/:id", "responses": [ { "uuid": "c897d627-8ad9-4895-914d-880f2e881180", "body": "{\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "67d47949-42ea-4178-8c6a-6dd749d6efc6", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4eca4133-681e-4cce-8b98-4cc107173600", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "928344ab-5560-4a88-9f1f-835c3ca28537", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "26883df1-dd3d-48a9-8ad1-86c808f0fd17", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6710d5e3-2472-4d0b-91e3-7604fb1574a6", "documentation": "Description: The operation updates a Defined Benefit Pension.
\r\n Purpose: Allows for complete replacement of a Defined Benefit Pension on a Fact Finder.", "method": "put", "endpoint": "api/DefinedBenefitPensions/:id", "responses": [ { "uuid": "f6aa9c5b-a98c-4d89-ab91-2ca7d54c3be2", "body": "{\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "342b9b25-477a-4e52-8c8a-d90008461a65", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d04ee4e9-add3-4363-8541-7cc76e6040d8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "257fd10c-03e4-495e-a3b6-728a09d6caef", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9a23238-994d-419f-8edc-376999824969", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee0badc5-57d1-43f7-99af-52d2aec2874c", "documentation": "Description: This operation retrieves all Demographic information for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Demographic information including city and state.", "method": "get", "endpoint": "api/Demographics", "responses": [ { "uuid": "525a29b4-221d-4ccb-9be7-1a60387365ee", "body": "{\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "72a9493e-0f68-4593-a893-19cfcd9f3d36", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5adc14af-7e90-4b47-96c6-d72bdd87ecf1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "43eb66ac-0a93-4237-a7e5-101df3e514e6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2673386e-fa57-47e8-8787-c8d855d89540", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4fbeaf8e-66de-4ccd-990b-60915c5afd21", "documentation": "Description: The operation creates Demographic information.
\r\n Purpose: Allows for creation of Demographic information on a Fact Finder.", "method": "post", "endpoint": "api/Demographics", "responses": [ { "uuid": "c260acbc-e7e3-45e0-86e2-b95c59c67ba2", "body": "{\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e0cdebf6-1fe9-432d-979a-9a1c25d0a240", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "07d7b8e6-9156-4915-9988-7e5e78c29362", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f4e080bf-8e8b-4513-8fb9-4ea79c9cc4e1", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "813ae215-bdba-4a3a-b1b8-1df652d08cce", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bebc5bfc-cc2f-4efc-981b-a7c528bb6b09", "documentation": "Description: This operation retrieves all Dependents for the specified Demographic information ID.
\r\n Purpose: Provides access to the Dependents including first and last name.", "method": "get", "endpoint": "api/Demographics/:demographicId/Dependents", "responses": [ { "uuid": "f64ba609-c3aa-48d5-9c40-647ef1360896", "body": "{\n \"dependents\": [\n {\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b54fb41-54f5-4463-842d-e351d47a3658", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b1366ba9-83b4-49f8-9fc6-3bda8da84281", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "17d8bab7-c341-480f-bf7e-c036ac20e6c7", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2ab2f726-b3a3-4648-af83-fb139f6887a2", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4c1dc71-da7e-48d9-8cf5-e4dc68e0b231", "documentation": "Description: The operation creates a Dependent.
\r\n Purpose: Allows for creation of Dependents on a Fact Finder.", "method": "post", "endpoint": "api/Demographics/:demographicId/Dependents", "responses": [ { "uuid": "b3f41534-206e-4d85-9b11-d2be24b7f0cf", "body": "{\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c7b70f44-df3f-465c-a32d-0dc6178fbb09", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7152c8c-a87e-404e-86d8-e92859781992", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Dependent information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ad4fd9ed-adb4-4864-8e9e-bde3a275d73c", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Dependent information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9365acc8-17de-44c5-8cb4-a8339f52a21f", "body": "", "latency": 0, "statusCode": 404, "label": "Dependent information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "15b52924-f7a6-45d7-91c2-f20e508d6620", "body": "", "latency": 0, "statusCode": 409, "label": "The request cannot be completed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4850e6c1-9a02-4cc0-bdad-6ad621648b08", "documentation": "Description: The operation removes a Dependent tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Dependent from a Fact Finder.", "method": "delete", "endpoint": "api/Demographics/:demographicId/Dependents/:id", "responses": [ { "uuid": "fdab6b53-f969-4df0-b89d-ead5d8b9a855", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a658bf18-4067-418a-9950-e5de4efa501a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "92d0690a-f7db-45ac-a365-9e60d583b4d5", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Dependent information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5f0e1f12-b005-4b7e-8915-7775f35e746a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Dependent information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffdcdf9b-265f-4cff-92fc-2005803db40b", "body": "", "latency": 0, "statusCode": 404, "label": "Dependent information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41d9f06d-d961-4c64-a7a8-e7d67fc1df13", "documentation": "Description: This operation retrieves a single Dependent for the specified Dependent ID.
\r\n Purpose: Provides access to the Dependent including first and last name.", "method": "get", "endpoint": "api/Demographics/:demographicId/Dependents/:id", "responses": [ { "uuid": "1aadcc1c-f6d6-4ea0-8bdf-b8c4bf4d6baf", "body": "{\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "27c7ad45-1358-481f-9260-61e293a0c839", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ad7f87d8-0853-480e-a500-dc7e6b70cf9c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13104ae4-7ddc-4992-8719-3eaf32f73413", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9683d59-fcea-4943-9226-f2138e478955", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "39a72af9-a65b-46cb-bdce-6289e29496c4", "documentation": "Description: The operation updates a Dependent.
\r\n Purpose: Allows for complete replacement of a Dependent on a Fact Finder.", "method": "put", "endpoint": "api/Demographics/:demographicId/Dependents/:id", "responses": [ { "uuid": "9eca4ac6-5051-454b-acd6-e2ff97e99ff2", "body": "{\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7fdf0598-9010-4095-bc9e-1aea987c84ab", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "35ef8f3c-2bb2-4c45-ad4d-efc4721caad1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Dependent information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2696172e-3cde-4bfb-a149-f4d49b917225", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Dependent information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "de058726-0925-445f-900e-313879461397", "body": "", "latency": 0, "statusCode": 404, "label": "Dependent information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43b65fcb-d99a-45ad-93eb-7a4cca2a3fa9", "documentation": "Description: This operation retrieves Demographic information for the specified Demographic information ID.
\r\n Purpose: Provides access to the Demographic information including city and state.", "method": "get", "endpoint": "api/Demographics/:id", "responses": [ { "uuid": "8946ffa0-e991-48a2-ae1e-9de58491e7bf", "body": "{\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c69dfa96-31b6-4439-bf8d-1c331f532db4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "87476db4-3593-44c8-9738-fac4700b27c3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3f54ba4-0d06-44a8-94a4-9dd4e397a82f", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7e83ea6-8708-4145-9691-f0340f920137", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b514ce0-6a3e-48e8-9591-fbc0d6b24e21", "documentation": "Description: The operation updates Demographic information.
\r\n Purpose: Allows for complete replacement of Demographic information on a Fact Finder.", "method": "put", "endpoint": "api/Demographics/:id", "responses": [ { "uuid": "61ee9392-bd1e-494c-b2c1-9546b8313b7f", "body": "{\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "38a9efce-dcd5-4da3-90da-4a4d2a13966d", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a8207cdb-5c7f-42be-b29b-58f3e4937e45", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7bde9521-5bf4-413e-870f-582876f79706", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bd1be96c-4720-4842-b40a-7c15dae43a9a", "body": "", "latency": 0, "statusCode": 404, "label": "Demographic information not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5a903151-657f-4b37-9d44-88c391c40f63", "body": "", "latency": 0, "statusCode": 409, "label": "The request cannot be completed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "702c320a-f80c-46c6-ae55-6036a7822fa1", "documentation": "Description: This operation retrieves all Disability Insurance Policies for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Disability Insurance Policies including description and policy type.", "method": "get", "endpoint": "api/DisabilityInsurancePolicies", "responses": [ { "uuid": "36d46c5b-a1f9-4e9a-b4f2-5254389f70c3", "body": "{\n \"disabilityInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8ab19323-fe34-4260-aa5e-20af28815605", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2257e489-636c-41f9-a531-4f111293f38d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Disability Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "45352acd-adeb-4558-a576-b093bb7b8acd", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Disability Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3885b728-1c23-4f34-8db2-49ec022efb4d", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e2febb84-2bb5-47ee-8374-fc0cca3c2828", "documentation": "Description: The operation creates a Disability Insurance Policy.
\r\n Purpose: Allows for creation of Disability Insurance Policies on a Fact Finder.", "method": "post", "endpoint": "api/DisabilityInsurancePolicies", "responses": [ { "uuid": "d4ff5818-59d0-44fd-95db-327cebc2c216", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6e9700ae-7fba-4e68-b6cc-dc8e6226d847", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "73d956ac-e622-4845-8192-782389664fcc", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Disability Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e0f7147c-b956-4331-9ea9-96dea55283bc", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Disability Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ed1bdb73-e51b-4326-a1a7-a4afc651e241", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba8d8d2b-5069-4018-8b75-ba91f1cb2c10", "documentation": "Description: The operation removes a Disability Insurance Policy tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Disability Insurance Policy from a Fact Finder.", "method": "delete", "endpoint": "api/DisabilityInsurancePolicies/:id", "responses": [ { "uuid": "9eec7b13-76ce-49a0-a61f-9267b143d252", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2cd72357-bc03-4129-ab95-5d968a62b385", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8a4e11dc-66a0-49ec-8b7f-8ff6d674e818", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Disability Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c67b0023-587b-43b3-8317-ae16de5874c6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Disability Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71a18b10-0dc4-4060-aac1-332692491989", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99d5ec8c-86ee-43f8-baee-fe789de87033", "documentation": "Description: This operation retrieves a single Disability Insurance Policy for the specified Disability Insurance Policy ID.
\r\n Purpose: Provides access to the Disability Insurance Policy including description and policy type.", "method": "get", "endpoint": "api/DisabilityInsurancePolicies/:id", "responses": [ { "uuid": "5e8c080f-2f41-4789-bdea-b73cf606b9d2", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "82d29f80-67e5-4a98-b1be-3fc48e83ea44", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5464d36-2857-4d54-984a-73366ddf96a9", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Disability Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b4ea997d-dbf3-471f-a2db-89604a266d74", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Disability Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "735de1e4-97e3-4cac-bd6d-20012872813f", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "41264189-0019-4261-b0c2-3e5e360d5619", "documentation": "Description: The operation updates a Disability Insurance Policy.
\r\n Purpose: Allows for complete replacement of a Disability Insurance Policy on a Fact Finder.", "method": "put", "endpoint": "api/DisabilityInsurancePolicies/:id", "responses": [ { "uuid": "b41ead94-e429-4406-b699-aa213cf77689", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ffde2410-3148-4f86-bb76-d3da503969e8", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7bc2e818-1396-4a66-a1a5-f14bb94caf6f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Disability Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4bf49123-4b06-4aad-b2e8-37ea4a6b575c", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Disability Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a280b75a-51ba-417c-98e8-07b87aac4474", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c9fcad15-03ef-4145-a018-0c7b280807df", "documentation": "Description: This operation retrieves all Disability Insurance Policy Types for the specified country.
\r\n Purpose: Provides access to the Disability Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/DisabilityInsurancePolicyTypes", "responses": [ { "uuid": "5c56670d-670e-4181-ba57-95b974e3a2e0", "body": "{\n \"insurancePolicyTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "21140391-a07c-4219-9c0a-eda6aece3a31", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9b28d6d1-e6ad-444f-a645-cec0750cfdfd", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bec8e35e-e0ef-48fb-bab4-8adacdae6ae4", "documentation": "Description: This operation retrieves all Disability Insurance Policy Types for the specified id.
\r\n Purpose: Provides access to the Disability Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/DisabilityInsurancePolicyTypes/:id", "responses": [ { "uuid": "7ceb060e-60ab-44c6-b261-7a7820e2864e", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1ed27e5c-c416-4c04-90ef-ffd011e3ad6a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e89dcf87-ed7a-4f6a-87a1-f8fd322b85be", "body": "", "latency": 0, "statusCode": 404, "label": "Disability Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5a2f8f76-56b6-41e5-97f3-63a7679b92cf", "documentation": "Description: This operation retrieves all Education Goals for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Education Goals including description and projected cost.", "method": "get", "endpoint": "api/EducationGoals", "responses": [ { "uuid": "84de063b-2bd5-40f0-9f9d-c8325ad959c8", "body": "{\n \"educationGoals\": [\n {\n \"description\": \"\",\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"projectedCost\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "dc93266d-2de8-430a-9e84-8bd2b9ed3e25", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a9685bb0-0f38-450d-bab4-21700c7465ec", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "42540ff7-4191-4292-9acc-c87242af3cd6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0d9637aa-bdf6-4f2c-bae1-93e6ca267b2b", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cd7331ab-718b-4d4d-be5b-811968e8498b", "documentation": "Description: The operation creates an Education Goal.
\r\n Purpose: Allows for creation of Education Goals on a Fact Finder.", "method": "post", "endpoint": "api/EducationGoals", "responses": [ { "uuid": "275b4ffa-7165-4eb2-bdcc-80c81b384dff", "body": "{\n \"description\": \"\",\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"projectedCost\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "65b6c623-18ba-450c-98ec-e5817888790e", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4a430580-b03e-417f-9de7-bf6fad42a4c0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "20ce00a6-3a85-4f48-b51d-9e2fac1ff7ce", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2a279478-2e0b-4b5d-aebc-af2e7673fbc2", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14bb6c3e-f23d-4afc-9c96-5310554d6c5c", "documentation": "Description: This operation retrieves all Education Goal Expenses for the specified Education Goal ID.
\r\n Purpose: Provides access to the Education Goal Expenses including description and annual cost.", "method": "get", "endpoint": "api/EducationGoals/:educationGoalId/Expenses", "responses": [ { "uuid": "c6d83edb-6039-4afc-a1ba-16882c4cb3ce", "body": "{\n \"educationExpenses\": [\n {\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e73bdb4c-77e4-48ff-a82a-6574915c9e61", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b89bf7a2-28fb-4ee3-8523-dee1a24336ea", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "312e79bf-a9b1-4a41-b3ae-efdec1de08aa", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d7208b80-19c6-4bf8-8b7b-d8cb5a6ef57e", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "acca95ba-bc4e-428a-ba99-0c74e423a421", "documentation": "Description: The operation creates an Education Goal Expense.
\r\n Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.", "method": "post", "endpoint": "api/EducationGoals/:educationGoalId/Expenses", "responses": [ { "uuid": "cd25753f-c123-4627-b629-9432a66fe7b5", "body": "{\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "49d33ac2-f134-43ca-ba0b-2dc1e42699c3", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb8d6deb-bef3-47a1-b30f-b35fc872da26", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7acf3194-85ec-4439-89fc-b7a0329a10aa", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f7bf12f-8ce9-4017-8477-12285f1eca98", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6e636fb3-a31b-42ef-a8a4-44c2ada3f393", "documentation": "Description: The operation removes an Education Goal Expense tied to a Fact Finder.
\r\n Purpose: Allows for removal of an Education Goal Expense from a Fact Finder.", "method": "delete", "endpoint": "api/EducationGoals/:educationGoalId/Expenses/:id", "responses": [ { "uuid": "e7cfef11-4e9d-4a33-bc38-647eb7bc0657", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4c78704c-4e76-47ac-9a2f-da4fd63bccbc", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e31e909b-70d2-4f6e-867e-ca85cb72453e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b167c8e4-f684-4634-8a66-94099d4b7d46", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0d240bf6-ac57-4a43-8ea3-97b5421dcf14", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "96430bfa-a38d-4f81-8eca-55ac9cc5bfe7", "documentation": "Description: This operation retrieves a single Education Goal Expense for the specified Education Goal Expense ID.
\r\n Purpose: Provides access to the Education Goal Expense including description and annual cost.", "method": "get", "endpoint": "api/EducationGoals/:educationGoalId/Expenses/:id", "responses": [ { "uuid": "a92f5b07-d7ba-469f-a5ea-527f68e4980e", "body": "{\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "59383d34-4603-4947-9850-b5020c8f7b5f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b49e7a54-0819-4dbd-aefe-fa834d0567e8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71fb2ef1-178b-4be9-b2e5-b75fb29b6edf", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "02d71f97-ac40-4b46-9f63-e9a0db069f48", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f1cecdd8-4af5-4640-9c9f-9571f34de874", "documentation": "Description: The operation updates an Education Goal Expense.
\r\n Purpose: Allows for complete replacement of an Education Goal Expense on a Fact Finder.", "method": "put", "endpoint": "api/EducationGoals/:educationGoalId/Expenses/:id", "responses": [ { "uuid": "74350d11-6d93-4baa-ad93-b2e0b4eb9980", "body": "{\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2914a693-1edf-45ac-815e-887d2f23674f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ba9b5700-cca2-4d03-b7c3-6706c2440544", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4961baf2-30db-47d6-b425-12fea683a891", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "74a80521-ae07-4742-b91f-fdd47f996879", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8b2e8997-e803-46d1-9132-841d0fdd7f09", "documentation": "Description: The operation removes an Education Goal tied to a Fact Finder.
\r\n Purpose: Allows for removal of an Education Goal from a Fact Finder.", "method": "delete", "endpoint": "api/EducationGoals/:id", "responses": [ { "uuid": "ec9ac631-a560-4a07-b1d5-f9d065c5f9d9", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "219876ff-ec25-426a-aae2-df515995c0fc", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d411b7d5-4c1c-4555-a282-f51cb43e587a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb9fc612-e46b-47c3-afa6-1b75d84f846a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "87829b27-fe99-4b47-868c-2702d28a26e0", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b963588-5269-4f40-bb36-ab182b508b44", "documentation": "Description: This operation retrieves a single Education Goal for the specified Education Goal ID.
\r\n Purpose: Provides access to the Education Goal including description and projected cost.", "method": "get", "endpoint": "api/EducationGoals/:id", "responses": [ { "uuid": "988ee5c2-7c18-4942-9c44-a69892d5dfd4", "body": "{\n \"description\": \"\",\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"projectedCost\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8b2b138e-75f1-45ca-971b-6fbd087b9e1b", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8acd57dd-7144-4414-89c2-b5def1cef806", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e39add00-d2bf-478a-b930-d57bf276a6c3", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3bcdcb8b-352d-4974-924a-a32ab1e9691f", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "daae2e6c-c360-4652-92d2-24ddc1df2200", "documentation": "Description: The operation creates an Education Goal Expense.
\r\n Purpose: Allows for creation of Education Goal Expenses on a Fact Finder.", "method": "put", "endpoint": "api/EducationGoals/:id", "responses": [ { "uuid": "28280584-65dd-4a51-80eb-1c78dfb03eab", "body": "{\n \"description\": \"\",\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"projectedCost\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f802a91f-9fbe-4bae-8e12-0a7f48140b6e", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ceaeae61-9d72-4660-8f1f-f025d39b4b13", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Education Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5276a0d7-5ee0-41cf-84da-d7c1be98c811", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Education Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4b1b1522-7d69-464c-a91a-b868c5192a00", "body": "", "latency": 0, "statusCode": 404, "label": "Education Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9c0fbca5-ac22-4456-9d35-d53436d90ce9", "documentation": "Description: This operation retrieves all Expense Types for the specified country.
\r\n Purpose: Provides access to the Expense Types including id and type description.", "method": "get", "endpoint": "api/ExpenseTypes", "responses": [ { "uuid": "fa7c3950-d771-4c70-83d9-e4a1c8494f47", "body": "{\n \"expenseTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5cd31ff3-1723-4177-85e0-d31272ca66e4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5f95d0f7-f42f-4c7f-a5e2-9dc69dd03792", "body": "", "latency": 0, "statusCode": 404, "label": "Expense Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f8580f3-ac40-4ea1-acc8-0a1152fedbd5", "documentation": "Description: This operation retrieves all Expense Types for the specified country.
\r\n Purpose: Provides access to the Expense Types including id and type description.", "method": "get", "endpoint": "api/ExpenseTypes/:id", "responses": [ { "uuid": "6ba3aac6-00b9-46c9-97b3-60b4df6dac0d", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "77e3e1c9-654b-44d4-98b5-39367e9ea839", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a575210c-3770-4ffd-ab32-f4f8babbca38", "body": "", "latency": 0, "statusCode": 404, "label": "Expense Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "875398e2-f5e1-4298-a94f-d9b8853f5d54", "documentation": "Description: This operation retrieves all Expenses for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Expenses including description and Expense type.", "method": "get", "endpoint": "api/Expenses", "responses": [ { "uuid": "f93210e0-7b7e-4c17-9dd1-d5c970f6f260", "body": "{\n \"expenses\": [\n {\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a049f7c5-79e8-49fb-aa94-ee9f0efe24a9", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1ae27400-6a14-40b0-9967-be1f15887e35", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "29e6f508-5a52-4255-b05c-3df7bcaf97c2", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c5f8a38-22a6-495f-94eb-d2dd7bf538c4", "body": "", "latency": 0, "statusCode": 404, "label": "Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7bb7c5fb-e9ab-4f2f-be3c-ba4025b39e36", "documentation": "Description: The operation creates an Expense.
\r\n Purpose: Allows for creation of Expenses on a Fact Finder.", "method": "post", "endpoint": "api/Expenses", "responses": [ { "uuid": "50e63bab-8204-40ed-bfd2-fa7bcaf4d325", "body": "{\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "923a5f0f-4d8b-4b45-892a-fbeb49da74ed", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fe94f8ab-9982-46a1-b1ea-72ed6a35d88c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "301460aa-90e5-48ae-848a-0801229e090a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "722e9aad-01e4-4266-a871-0d757d40afe2", "body": "", "latency": 0, "statusCode": 404, "label": "Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "795577d6-3e21-4e5c-9bd8-a19963faa7a7", "documentation": "Description: The operation removes an Expense tied to a Fact Finder.
\r\n Purpose: Allows for removal of an Expense from a Fact Finder.", "method": "delete", "endpoint": "api/Expenses/:id", "responses": [ { "uuid": "f11a92c0-e3cc-4af0-a920-24090d6c2ce2", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "97b7c670-91c7-4905-96fb-aa00459111aa", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "57e9e180-e064-4ac0-8ca4-eb904bd21ad4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "049d2d22-19b3-4b81-9788-99de398e6c46", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e0dc873d-ecd3-4782-8447-c259a5e87d99", "body": "", "latency": 0, "statusCode": 404, "label": "Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "35444db9-9c96-48d8-b56e-a121edae4b2d", "documentation": "Description: This operation retrieves a single Expense for the specified Expense ID.
\r\n Purpose: Provides access to the Expense including description and Expense type.", "method": "get", "endpoint": "api/Expenses/:id", "responses": [ { "uuid": "38f83043-5be3-4207-a6c9-f89673770c56", "body": "{\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "822ad39e-90cb-4d58-b4ad-01101458fcae", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "73235e5f-7253-4071-b58e-5624e60fdaee", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "33e8275b-cab6-4ec1-bf3a-056991185309", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc0c1046-a250-4233-b1e8-1469720876e2", "body": "", "latency": 0, "statusCode": 404, "label": "Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1573335-6112-4e83-9043-4b59ae2ca575", "documentation": "Description: The operation updates an Expense.
\r\n Purpose: Allows for complete replacement of an Expense on a Fact Finder.

\r\n Note: Expense type cannot be changed for expenses prepopulated from NaviPlan.", "method": "put", "endpoint": "api/Expenses/:id", "responses": [ { "uuid": "640e7a58-088f-40ec-9bad-84bc5d84fced", "body": "{\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "51386096-b8ed-44b1-94b5-fbb5d8d04255", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f626c387-5971-4174-b722-54cb7de628fd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b81c64c-ec74-47fe-abd0-6bcc61a35283", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "78364b33-26d0-4ce3-8aa4-95723e483759", "body": "", "latency": 0, "statusCode": 404, "label": "Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "beb9342e-83f1-4727-9af6-3f1c13251294", "documentation": "Description: This operation retrieves all Fact Finders for the specified householdId, \r\n or if null, all households associated with the user.
\r\n Purpose: Provides access to the Fact Finder including status.", "method": "get", "endpoint": "api/FactFinders", "responses": [ { "uuid": "ad6e46c7-74bb-4a50-8bd0-1f0a9273bff8", "body": "[\n {\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n }\n]", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7b861df4-5569-48ae-9a76-6aaab7ae1897", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "76be45b2-84d3-4ece-9d5c-7b346f8637ac", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2434a306-46a0-4e6f-a564-36c7c6112609", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "020f7508-7593-4c88-b059-d38a33251f68", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cbe7a89f-3c8e-44f7-b4b5-db8ca3900031", "documentation": "Description: The operation creates a completely empty draft Fact Finder.
\r\n Requirements: A householdId and list of modules must be provided.
\r\n Purpose: Stages a Fact Finder for population.", "method": "post", "endpoint": "api/FactFinders", "responses": [ { "uuid": "eaa5dda4-1847-4c14-8bb2-eddd006e76e0", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f3072c2c-9d12-4206-abc9-b47d6643b072", "body": "{\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4f6c5e3b-045b-413d-abfc-fc3e65048796", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ae27f3b5-0abe-41e1-9d7e-d4676b9a79ec", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ee0b0d8b-4397-4f5a-af71-99f02e7684dd", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "092685c1-a54c-4173-9192-19bce7e97f68", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "16b9a223-1dda-4d69-a768-acdac8b37108", "body": "", "latency": 0, "statusCode": 409, "label": "The request cannot be completed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b6eda9a-00ea-49cb-bd81-5e7997c20f9b", "documentation": "Description: The operation creates a new Populated Fact Finder.
\r\n Requirements: A householdId and list of modules must be provided.
\r\n Purpose: Creation of a Fact Finder.", "method": "post", "endpoint": "api/FactFinders/Populate", "responses": [ { "uuid": "b507f27f-d26a-462c-a614-fe0ba1c0b8c5", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5fcc289-3958-48ab-963e-2fa705ce4834", "body": "{\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ec6e9748-bd32-4f6f-b8b6-a365bf0307c1", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a43a67df-06f7-4d50-becc-db3598e84671", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ecc17c54-0c7c-42c9-a839-a74d88dc25cd", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c72ff5d-db84-4eae-9f01-debeae7a1e2d", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55f1d904-601d-46ae-b797-4587899d8846", "body": "", "latency": 0, "statusCode": 409, "label": "The request cannot be completed.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5fff6886-381f-48dd-b321-96b8f4eaeedf", "documentation": "Description: This operation retrieves all Fact Finder Modules for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Fact Finder Modules including description and policy type.", "method": "get", "endpoint": "api/FactFinders/:factFinderId/Modules", "responses": [ { "uuid": "7c428c5a-53c7-4ce0-b350-42dbfcb015b1", "body": "{\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24e2a816-e099-4248-80dd-f42444151862", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9a1751ed-1353-4156-befa-1133cf6b0563", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder Module data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1836c7cf-2ac5-49eb-9a31-ca82ed900f9b", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder Module not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b406fca8-9ff5-4a80-a837-3bb722064da3", "documentation": "Description: This operation retrieves a single Fact Finder Module for the specified Fact Finder Module ID.
\r\n Purpose: Provides access to the Fact Finder Module including description and policy type.", "method": "get", "endpoint": "api/FactFinders/:factFinderId/Modules/:id", "responses": [ { "uuid": "88ba3ce7-a044-4f67-b5b9-de872a165dbf", "body": "{\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fa42ec98-6518-4bbd-9f18-9d1cae552b50", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1020509c-44fd-4a0e-ab9f-830ceabcb54b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder Module data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "74671169-9453-4c70-b439-d2b1ddb20a48", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder Module not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "407589e5-82ba-402f-885d-bbe915ac788e", "documentation": "Description: The operation updates a Fact Finder Module.
\r\n Purpose: Allows for complete replacement of a Fact Finder Module on a Fact Finder.", "method": "put", "endpoint": "api/FactFinders/:factFinderId/Modules/:id", "responses": [ { "uuid": "2bcb44a9-2a64-4eb2-b648-dcb01d2887b2", "body": "{\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4fd44058-c9f8-4407-ac9f-bfad513b2739", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cf21a161-b658-4b9f-8e01-9acc10d34e00", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder Module data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "52927527-2a09-4584-9c8c-c7571d5d7019", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder Module not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "55dfdaad-6824-4cdd-a79e-f8cecd91a067", "documentation": "Description: The operation retrieves Snapshots of a Fact Finder.
\r\n Purpose: Allows for advisors to view all Snapshots taken of a Fact Finder.", "method": "get", "endpoint": "api/FactFinders/:factFinderId/Snapshots", "responses": [ { "uuid": "ef62bc54-3c0a-4064-bff3-5b27fa2ed08d", "body": "{\n \"snapshots\": [\n {\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderData\": {\n \"accounts\": [\n {\n \"accountHoldings\": [\n {\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"heldAway\": {{faker 'datatype.boolean'}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}},\n \"savingsStrategies\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n }\n ],\n \"criticalIllnessInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"criticalIllnessInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n }\n ],\n \"definedBenefitPensions\": [\n {\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"demographics\": {\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependents\": [\n {\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n }\n ],\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n },\n \"disabilityInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"disabilityInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ],\n \"educationGoals\": [\n {\n \"description\": \"\",\n \"educationExpenses\": [\n {\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n }\n ],\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"projectedCost\": {{faker 'number.float'}}\n }\n ],\n \"expenses\": [\n {\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"incomes\": [\n {\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"liabilities\": [\n {\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"importSource\": \"\",\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n }\n ],\n \"lifeInsurancePolicies\": [\n {\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"subaccounts\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n }\n ]\n }\n ],\n \"lifestyleAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n }\n ],\n \"longTermCareInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"longTermCareInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ],\n \"majorPurchaseGoals\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"planYear\": {{faker 'number.int' max=99999}},\n \"realEstateAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n }\n ],\n \"retirementGoal\": {\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"retirementExpenses\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n }\n },\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"factFinderStatus\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\",\n \"snapshotId\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "717d82dd-41e0-4aa1-a36a-94348764575f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0750888f-2b53-415b-b0f0-d1120ada3fd3", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cbe3a9ff-57cb-45b7-abdb-f4626ed23283", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e5e2e07d-fe04-4db0-af9f-1b741a951828", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56d4b7eb-3f2c-48f5-84d7-2bce555ae1d3", "documentation": "Description: The operation creates a Snapshot of a Fact Finder.
\r\n Purpose: Allows for advisors to compare the current fact finder to a snapshot prior to acceptance.", "method": "post", "endpoint": "api/FactFinders/:factFinderId/Snapshots", "responses": [ { "uuid": "2c88e89a-81c7-44d8-acad-54dee38e415a", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2f4ad7b2-3bed-4e4f-9b00-03a83c5911dd", "body": "{\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderData\": {\n \"accounts\": [\n {\n \"accountHoldings\": [\n {\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"heldAway\": {{faker 'datatype.boolean'}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}},\n \"savingsStrategies\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n }\n ],\n \"criticalIllnessInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"criticalIllnessInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n }\n ],\n \"definedBenefitPensions\": [\n {\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"demographics\": {\n \"city\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependents\": [\n {\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"demographicsId\": {{faker 'number.int' max=99999}},\n \"dependentId\": {{faker 'number.int' max=99999}},\n \"dependentOf\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"relationship\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n }\n ],\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"head2\": {\n \"alreadyRetired\": {{faker 'datatype.boolean'}},\n \"birthDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"firstName\": \"\",\n \"gender\": \"{{oneOf (array 'Male' 'Female' 'None')}}\",\n \"lastName\": \"\",\n \"taxFilingStatus\": {{faker 'number.int' max=99999}}\n },\n \"jointAnalysis\": {{faker 'datatype.boolean'}},\n \"lockRetirement\": {{faker 'datatype.boolean'}},\n \"state\": {{faker 'number.int' max=99999}}\n },\n \"disabilityInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"benefitType\": \"{{oneOf (array 'Dollar' 'Percent')}}\",\n \"description\": \"\",\n \"disabilityInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ],\n \"educationGoals\": [\n {\n \"description\": \"\",\n \"educationExpenses\": [\n {\n \"annualCost\": {{faker 'number.float'}},\n \"educationExpenseId\": {{faker 'number.int' max=99999}},\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent')}}\",\n \"memberDependentId\": {{faker 'number.int' max=99999}},\n \"startYear\": \"{{faker 'date.recent' 365}}\",\n \"years\": {{faker 'number.int' max=99999}}\n }\n ],\n \"educationGoalId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"projectedCost\": {{faker 'number.float'}}\n }\n ],\n \"expenses\": [\n {\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"expenseAmount\": {{faker 'number.float'}},\n \"expenseId\": {{faker 'number.int' max=99999}},\n \"expenseTypeId\": {{faker 'number.int' max=99999}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"incomes\": [\n {\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"liabilities\": [\n {\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"importSource\": \"\",\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n }\n ],\n \"lifeInsurancePolicies\": [\n {\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"subaccounts\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n }\n ]\n }\n ],\n \"lifestyleAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n }\n ],\n \"longTermCareInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"longTermCareInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ],\n \"majorPurchaseGoals\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"planYear\": {{faker 'number.int' max=99999}},\n \"realEstateAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n }\n ],\n \"retirementGoal\": {\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"retirementExpenses\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n }\n },\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"factFinderStatus\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\",\n \"snapshotId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a0d54500-87b4-412e-9e7d-11447a4b6269", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cb4c1c5b-0c31-412d-9b2d-1bb91d5ed67c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f419a203-cbf0-41d2-932a-78b10bf18570", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "71d66ec0-1734-4660-9d29-44aa7ee7d588", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f7be2678-f1a9-4b75-8a5e-4c48e4fef7e9", "documentation": "Description: This operation deletes a single Fact Finder for the specified Fact Finder ID.
\r\n Purpose: Deletes the fact finder.", "method": "delete", "endpoint": "api/FactFinders/:id", "responses": [ { "uuid": "0fe5858e-0509-4d74-aa84-66583a19cb0c", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7bfaff9f-f0e0-419c-84a0-7799ee8e1b13", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b8c4b2b5-bb69-48fe-943b-346797e30b0a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dda85bcd-9a6e-483b-9cea-c5b2d50ba1d8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "08b6c09b-5a06-42b8-9b1e-63803435f6f9", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "042dfe31-6060-4333-8888-c312971211ea", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6c81099c-959d-44f1-8213-e50add20b5df", "documentation": "Description: This operation retrieves a single Fact Finder for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Fact Finder including status.", "method": "get", "endpoint": "api/FactFinders/:id", "responses": [ { "uuid": "6c747f7e-f7b1-4099-8c51-db8e43e853c9", "body": "{\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5ffe4b43-ad11-4ee8-bdf2-21eb4f77def2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7abdbf98-c735-4973-9452-294984885cae", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ceafcfeb-4d1e-4f64-b235-cc2abdb8be22", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "694fdad9-cd41-42b8-b84c-9f15179dfa68", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee81121a-945a-4e92-b490-530165ccba75", "documentation": "Description: The operation updates a Fact Finder.
\r\n Purpose: Allows for the updating of a Fact Finder.", "method": "put", "endpoint": "api/FactFinders/:id", "responses": [ { "uuid": "4733e72b-2f3d-4c83-95d6-758d37705e7d", "body": "{\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1d584dd8-5043-4a13-af7b-70533bdd2e32", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fda319e5-d690-406e-aebc-e26cde2e5494", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f66266d3-46f9-4fef-82cb-0c5652a52728", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3e5fedd-a85f-4b93-8021-6a94a2ad9384", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "45787362-2612-417d-9f0a-00da33034009", "documentation": "Description: The operation populates a fact finder.
\r\n Purpose: Allows for the population of a Fact Finder based on a NaviPlan plan or client. This\r\n operation cannot be performed on a Fact Finder more than once.", "method": "put", "endpoint": "api/FactFinders/:id/Populate", "responses": [ { "uuid": "55e38f9f-833f-48e5-9da1-d5a5a9ebae43", "body": "{\n \"countryCode\": \"{{oneOf (array 'UnitedStates' 'Canada')}}\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"householdId\": {{faker 'number.int' max=99999}},\n \"lastStatusUpdate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"modules\": {\n \"factFinderModules\": [\n {\n \"available\": {{faker 'datatype.boolean'}},\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"moduleId\": {{faker 'number.int' max=99999}},\n \"moduleName\": \"{{oneOf (array 'Demographics' 'Assets' 'Liabilities' 'Incomes' 'Expenses' 'Insurance' 'Retirement' 'Education' 'MajorPurchase')}}\",\n \"visited\": {{faker 'datatype.boolean'}}\n }\n ]\n },\n \"planId\": {{faker 'number.int' max=99999}},\n \"planLevel\": \"{{oneOf (array 'Level2' 'Level1')}}\",\n \"status\": \"{{oneOf (array 'New' 'InProgress' 'ClientSubmitted' 'AdvisorAccepted' 'Canceled' 'Draft' 'Deleted')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Fact Finder was successfully populated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "44d0efc0-2f1b-4ba2-adf1-d36eb5eb9f75", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f9627a84-2fbe-42e8-8b3c-dcb758c04189", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Fact Finder data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "98c15654-5d3d-4777-9a87-8848d203095c", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Fact Finder.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "aa42f96c-77e5-46d8-9682-2776a8f1cb5a", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7cdc6899-1b28-4f9c-98b7-fd632dd4b4ae", "body": "", "latency": 0, "statusCode": 409, "label": "Fact Finder already populated.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "658b5f79-ba6d-4eab-9e0b-9d96b49383b6", "documentation": "Description: This operation retrieves all Filing Status Types for the specified country.
\r\n Purpose: Provides access to the Filing Status Types including id and type description.", "method": "get", "endpoint": "api/FilingStatusTypes", "responses": [ { "uuid": "6813326f-4cf2-4adf-bb0a-a8d3d4f024da", "body": "{\n \"filingStatusTypes\": [\n {\n \"filingStatusTypeId\": {{faker 'number.int' max=99999}},\n \"filingStatusTypeName\": \"\",\n \"hasJointDependent\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"partnerStatuses\": [\n {{faker 'number.int' max=99999}}\n ],\n \"validForSingleAnalysis\": {{faker 'datatype.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "71e96d12-9024-4440-bd7d-196cb9ff476f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "afe9eb36-1968-41d4-a244-31b2d228e505", "body": "", "latency": 0, "statusCode": 404, "label": "Filing Status Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9003a5ab-9c26-47d8-8ae2-534ad933288c", "documentation": "Description: This operation retrieves all Filing Status Type for the specified id.
\r\n Purpose: Provides access to the Filing Status Types including id and type description.", "method": "get", "endpoint": "api/FilingStatusTypes/:id", "responses": [ { "uuid": "f71835db-d600-435d-bad0-db736e40d74a", "body": "{\n \"filingStatusTypeId\": {{faker 'number.int' max=99999}},\n \"filingStatusTypeName\": \"\",\n \"hasJointDependent\": {{faker 'datatype.boolean'}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"partnerStatuses\": [\n {{faker 'number.int' max=99999}}\n ],\n \"validForSingleAnalysis\": {{faker 'datatype.boolean'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8c2c745f-8bfa-4b95-8edf-a383fe41efc4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef85651e-5827-4fad-b00f-43e2490243c7", "body": "", "latency": 0, "statusCode": 404, "label": "Filing Status Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d58b3a24-8457-4c32-b24a-a3a551985239", "documentation": "Description: This operation retrieves all Frequency Types for the specified country and entity.
\r\n Purpose: Provides access to the Frequency Types including id and type description.", "method": "get", "endpoint": "api/FrequencyTypes", "responses": [ { "uuid": "b792c94f-c917-4d7f-8ba5-7e28a85c98bb", "body": "{\n \"frequencyTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4ae5ffe9-81e3-4d27-9d0b-c28dca6273fe", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "deae732d-8439-4812-9da9-2ceb0c4373b2", "body": "", "latency": 0, "statusCode": 404, "label": "Frequency Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a96dfca-c2f5-4f92-b249-0002d770e256", "documentation": "Description: This operation retrieves the Frequency Type for the specified id.
\r\n Purpose: Provides access to the Frequency Types including id and type description.", "method": "get", "endpoint": "api/FrequencyTypes/:id", "responses": [ { "uuid": "61a28ec8-d298-4227-b933-45170c206077", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c4b9f729-7011-451d-a886-70f8301ea495", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc56f2ca-c718-4c98-9539-b2f6a1ce580b", "body": "", "latency": 0, "statusCode": 404, "label": "Frequency Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f37a6687-2c91-449e-959d-9655a6e37192", "documentation": "Description: This operation retrieves all Income Types for the specified country.
\r\n Purpose: Provides access to the Income Types including id and type description.", "method": "get", "endpoint": "api/IncomeTypes", "responses": [ { "uuid": "547ffab3-2976-4943-88b5-74ff3508e632", "body": "{\n \"incomeTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c9042264-29e0-47f6-a9dd-4686511fa45c", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b436d553-f7d4-4451-b48f-f8c81aebc396", "body": "", "latency": 0, "statusCode": 404, "label": "Income Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b9f9ff6-5495-4cd9-be32-6b1d5b70b88f", "documentation": "Description: This operation retrieves the Income Type for the specified id.
\r\n Purpose: Provides access to the Income Types including id and type description.", "method": "get", "endpoint": "api/IncomeTypes/:id", "responses": [ { "uuid": "9f0861d8-cafe-49d9-b7d8-eaa7ffa86aff", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d5bc22a8-7c39-4602-999a-b25877602c6a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b03bae54-74e8-42de-930d-67d6304bb423", "body": "", "latency": 0, "statusCode": 404, "label": "Income Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "43c76afe-0d49-4b1d-b12c-7a28137d4f93", "documentation": "Description: This operation retrieves all Incomes for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Incomes including annual amount and start date.", "method": "get", "endpoint": "api/Incomes", "responses": [ { "uuid": "1cd39139-2217-408d-9056-0560334240e6", "body": "{\n \"incomes\": [\n {\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b20a908e-3eb7-455c-866d-6ce5c195709f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "94da6677-a57c-4356-be15-822f08a793fa", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f43a671b-720e-48d4-9a37-d6c350cdb0e6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "64aa107a-8fb8-487a-a84a-bd1f9f55225d", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63f2d152-9de8-469f-a6d6-6b604f1eb11d", "documentation": "Description: The operation creates an Income.
\r\n Purpose: Allows for creation of Incomes on a Fact Finder.", "method": "post", "endpoint": "api/Incomes", "responses": [ { "uuid": "72796e30-cdb3-4608-90d3-c03d137ee309", "body": "{\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ee3804be-8b92-4774-89b8-59a8da3750f2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0b08fe80-c7bc-453c-80b6-037d8e66ea7f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4623d148-d2fc-4bc7-ad24-4cc10217d8fb", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7de42266-0989-4fec-9949-c2c5db727269", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "863366bf-50d6-405d-b5c1-06b2d1021013", "documentation": "Description: The operation removes an Income tied to a Fact Finder.
\r\n Purpose: Allows for removal of an Income from a Fact Finder.", "method": "delete", "endpoint": "api/Incomes/:id", "responses": [ { "uuid": "934a112c-fe76-45c7-b958-4af96477172f", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c328988a-9d3c-41f7-835e-dab685a3f85d", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "221d0476-aa18-4e2a-849e-1cd57e94748b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d5be7a89-f9bd-4f4a-8d12-2280e17d0332", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e23e7284-51a4-4f6a-8e02-8764d74355bf", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e55c987a-74c3-4aae-8fde-b9fa8d958677", "documentation": "Description: This operation retrieves a single Income for the specified Income ID.
\r\n Purpose: Provides access to the Income including annual amount and start date.", "method": "get", "endpoint": "api/Incomes/:id", "responses": [ { "uuid": "9ae8e13d-4969-40bf-9121-047f686c6ba3", "body": "{\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9ebe692-6f7e-41d3-8018-384a008bd8e2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c60008b-9521-4426-880c-8b0b8714fdbf", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "181963e5-55ba-4012-b855-a2ecdc7b1055", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8c6600e0-cfd4-4712-be99-db8d91d8653a", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93a08dad-84cd-4a93-81f1-5ff07d0dddbf", "documentation": "Description: The operation updates an Income.
\r\n Purpose: Allows for complete replacement of an Income on a Fact Finder.", "method": "put", "endpoint": "api/Incomes/:id", "responses": [ { "uuid": "0f8f1694-b7c1-47f1-acfa-13896478000a", "body": "{\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e087adbe-d302-4cd5-b43b-c4f9f83c5f0d", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6cb6b8d9-6fb9-4c4a-84bf-04edbf18acee", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a32ba12b-d37e-408e-a82d-a660ae678168", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f634afcc-6ab1-481b-86bc-6a69960800c1", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82fea037-a964-4bc3-a1b0-c6e4019ae456", "documentation": "Description: This operation retrieves all Liabilities for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Liabilities including owner and type.", "method": "get", "endpoint": "api/Liabilities", "responses": [ { "uuid": "c7958af9-fcdd-4463-b065-7e43ac77a331", "body": "{\n \"liabilities\": [\n {\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "923a1847-4c27-42ed-9518-21ae5a8e59fc", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9e4354f8-c77c-497f-986b-a7fe71e5177c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d569b500-655b-4659-9208-ec025b3c9c3d", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a3ac2431-f006-4da1-9985-a8711004b13d", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1e24eb4e-4d5e-47f1-b002-a0a90df465bc", "documentation": "Description: The operation creates a Liability.
\r\n Purpose: Allows for creation of Liabilities on a Fact Finder.", "method": "post", "endpoint": "api/Liabilities", "responses": [ { "uuid": "86edf130-32bd-4193-9035-83f3097dbc36", "body": "{\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cd882c51-55e7-4ecf-b944-df687f7c17d1", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "161e0742-5045-48ca-a442-6097f2be58d4", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7dc42794-4317-411a-879d-1e3e52061cd4", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2042e255-626d-4562-ad98-25f11ce39e55", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0d1cb102-691c-4f2d-8036-94b952eee107", "documentation": "Description: The operation removes a Liability tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Liability from a Fact Finder.", "method": "delete", "endpoint": "api/Liabilities/:id", "responses": [ { "uuid": "c2f8219e-04dc-4320-bf86-6d1e5c5b43f4", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "de244933-23c5-4319-802a-942428b1277e", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "81119015-a9bd-4b56-a338-9dee2dabc522", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fe2b9421-8351-4208-8e07-2373c12d7b5a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e0b4c67b-3988-408f-b404-ec740655e573", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "40b930dc-7c42-4af4-9f2c-9ed4f13357d6", "documentation": "Description: This operation retrieves a single Liability for the specified Liability ID.
\r\n Purpose: Provides access to the Liability including owner and type.", "method": "get", "endpoint": "api/Liabilities/:id", "responses": [ { "uuid": "2bd9eca1-d1af-4ea9-b7d9-d765b1958abd", "body": "{\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8bbdf55d-9bc1-4cfa-a6cd-9b1f3e9f5de5", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ea132866-4f12-4edd-b6ff-35d8565a5efd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1ecc9ede-97a0-4f5c-b71e-0ccdfc8ca4e7", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "37f567af-a0d5-48a4-ae50-421b1106546e", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "15b535ff-8677-4042-a332-a135a07204ca", "documentation": "Description: The operation updates a Liability.
\r\n Purpose: Allows for complete replacement of a Liability on a Fact Finder.", "method": "put", "endpoint": "api/Liabilities/:id", "responses": [ { "uuid": "98c8cb3d-bc62-473e-87ce-123e8db5eca2", "body": "{\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6dae59db-9ec6-4cb3-a9c2-b44cb2b2c616", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2c60f048-7c18-4bd4-b944-42e02b4dc157", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f123faea-a5cd-4985-96cc-6853232409d0", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "84525ef7-6ccf-4893-b554-8d24aa2aad0b", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7bd0e53e-ec31-45e8-ad52-97a3cb26fd77", "documentation": "Description: This operation retrieves all Liability Types for the specified country.
\r\n Purpose: Provides access to the Liability Types including id and type description.", "method": "get", "endpoint": "api/LiabilityTypes", "responses": [ { "uuid": "a9e8729d-1de6-4c7f-8198-e237d83c4066", "body": "{\n \"liabilityTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "94f6a7df-09a4-4464-b13b-fec4d483d170", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb674085-d0cf-478d-834c-d46d78b87f91", "body": "", "latency": 0, "statusCode": 404, "label": "Liability Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "324ea56a-7ded-44f1-aa38-82ae9cf80b3d", "documentation": "Description: This operation retrieves the Liability Type for the specified id.
\r\n Purpose: Provides access to the Liability Types including id and type description.", "method": "get", "endpoint": "api/LiabilityTypes/:id", "responses": [ { "uuid": "be4a4d9d-b350-430c-ba4e-315127f73edb", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9da56bfe-b4b2-43cc-9ff2-c7e81763885d", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f6a59013-8466-4a81-9873-a1458996ee7b", "body": "", "latency": 0, "statusCode": 404, "label": "Liability Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67117f43-4510-4b46-9904-852460696270", "documentation": "Description: This operation retrieves all Life Insurance Policies for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Life Insurance Policies including description and policy type.", "method": "get", "endpoint": "api/LifeInsurancePolicies", "responses": [ { "uuid": "af671f56-d07c-4318-ad98-7181a0fc6501", "body": "{\n \"lifeInsurancePolicies\": [\n {\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e555c963-76d7-4778-be77-6c6ac7bdfe5f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3c55fe99-404d-4bd9-9d4d-790bfdd8f960", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "719e4f05-9157-44de-a7af-d8fad2abdd6e", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2f3252a-54c4-449c-9cbf-70fbcf9784e9", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6b380f3f-5b5f-4e28-ae41-d3b6b28297bf", "documentation": "Description: The operation creates a Life Insurance Policy.
\r\n Purpose: Allows for creation of Life Insurance Policies on a Fact Finder.", "method": "post", "endpoint": "api/LifeInsurancePolicies", "responses": [ { "uuid": "76ba7acc-e787-47b2-a46a-d768792db0d5", "body": "{\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0a7de09a-bdc5-41a8-ab75-6e5ecbeb61e5", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "03b2ef00-f641-40ae-9bf4-3a68d98a6815", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bbc90d73-1c49-4c85-80c5-10612b2b7c87", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ffaf4cd5-f112-46fd-ba6a-c8891bf223ec", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21cbeeee-1949-4928-875a-addd99e3876b", "documentation": "Description: The operation removes a Life Insurance Policy tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Life Insurance Policy and associated subaccounts from a Fact Finder.", "method": "delete", "endpoint": "api/LifeInsurancePolicies/:id", "responses": [ { "uuid": "b04849a5-b84e-4b25-8a8a-9b4ec7928f34", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "744f8099-4372-481e-9ccc-f52aa20740f5", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e9078bc-71a4-4464-9ffe-5f679d8e64c0", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f9df61e6-8825-4231-a491-84072143da4f", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d4abdf40-9233-407a-ad2d-9745826477ac", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4bc816c3-66a8-4d53-b844-50bc1eaeb8c1", "documentation": "Description: This operation retrieves a single Life Insurance Policy for the specified Life Insurance Policy ID.
\r\n Purpose: Provides access to the Life Insurance Policy including description and policy type.", "method": "get", "endpoint": "api/LifeInsurancePolicies/:id", "responses": [ { "uuid": "efba1f99-13bd-4478-b786-e20a8c5044bd", "body": "{\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "edec3f90-2088-4f0f-87b9-d235aed1ffa3", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2ed8c89b-bab2-4999-8d32-1b2d711f64fb", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c53d52d-9e22-465b-9619-50d75f1238fa", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "35cd4765-94e3-42d7-b654-7fd20875659c", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "34f6e928-aaa1-469d-9519-ff88c65d2f28", "documentation": "Description: The operation updates a Life Insurance Policy, deletes associated sub-accounts if the policy type changes.
\r\n Purpose: Allows for complete replacement of a Life Insurance Policy on a Fact Finder.", "method": "put", "endpoint": "api/LifeInsurancePolicies/:id", "responses": [ { "uuid": "385db510-3e19-4b21-9a16-5b635cd9caf9", "body": "{\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bf4cc69f-dd66-4813-aefe-501785eaaf31", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fa94d3d1-298f-47ac-b72f-3a04711cb82c", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3e83ebaa-2432-4c10-9594-a9db6cadccfb", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c49d520a-9d12-47c6-8852-df0babbc0dfc", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b047354d-8810-4ec4-8c3a-c5ff69281e12", "documentation": "Description: Get all the subaccounts for an existing Life Insurance Policy.
\r\n Purpose: Provides access to all the Life Insurance Policy subaccounts.", "method": "get", "endpoint": "api/LifeInsurancePolicies/:lifeInsurancePolicyId/Subaccounts", "responses": [ { "uuid": "48c958e0-f2f7-4479-835f-6bc1bb39b3e2", "body": "{\n \"lifeInsurancePolicySubaccounts\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "15f8aa0a-d867-46a3-a595-2b9aa37786e0", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "40099fe5-6bb8-481d-8530-fd233a0208ef", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9cb8d47c-1cb4-4017-bb52-76c7a9338955", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "200bfe99-8787-472a-9ae4-554ccd835550", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df459e0c-9637-4405-838d-a15f1d162920", "documentation": "Description: Creates a subaccount and adds it to an existing Life Insurance Policy.
\r\n Purpose: Allows for creation of subaccount on a Life Insurance Policy.", "method": "post", "endpoint": "api/LifeInsurancePolicies/:lifeInsurancePolicyId/Subaccounts", "responses": [ { "uuid": "21902167-46ad-4f42-8149-b40e91ceb6d3", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9db1340-b756-4933-8eae-ad076106218b", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b2cae0af-ebc3-4cee-8989-b353fa469725", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "94ba4ccf-60a9-4897-9726-0cfc9c8934f4", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "53c69c88-9a26-4cd4-b663-64f35b784d1f", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7cec7e9e-964f-470a-980c-32f2b01f2172", "documentation": "Description: Deletes an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy.
\r\n Purpose: Allows for removal of a subaccount from a Life Insurance Policy.", "method": "delete", "endpoint": "api/LifeInsurancePolicies/:lifeInsurancePolicyId/Subaccounts/:id", "responses": [ { "uuid": "b08ec5a6-4f07-4b3e-aa33-6ced776240ac", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "304651af-e1aa-4e9c-874b-b77c83ae5edf", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1c57fa85-9a21-40e7-9566-5024f7168daf", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d8beff2d-f58b-4dee-9d65-44172cf1ef09", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12f564be-5199-471f-877f-11cd79a83a6d", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy Subaccount not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "94641f92-b8bb-4ad4-8e34-569654b3162f", "documentation": "Description: Get a specific subaccount for an existing Life Insurance Policy.
\r\n Purpose: Provides access to the Life Insurance Policy subaccount.", "method": "get", "endpoint": "api/LifeInsurancePolicies/:lifeInsurancePolicyId/Subaccounts/:id", "responses": [ { "uuid": "59b0feaa-7c67-4974-8f8f-90e7f77774e1", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ac1f626d-550d-4b16-a256-04169eb1f8df", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3964180f-b01d-479f-899d-3ad2a5b97306", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f2bbfb1d-4ad6-440a-ae94-3de6c2572284", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59efef7e-3b7b-4675-b725-51ef65c0d40a", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy Subaccount not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "73d29c7b-5816-4e61-ae34-8af0529e9bde", "documentation": "Description: Updates an existing Life Insurance Policy Subaccount for an existing Life Insurance Policy.
\r\n Purpose: Allows for complete replacement of a subaccount on a Life Insurance Policy.", "method": "put", "endpoint": "api/LifeInsurancePolicies/:lifeInsurancePolicyId/Subaccounts/:id", "responses": [ { "uuid": "e4fecf94-af2f-4b61-9823-102e6030e9b1", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f9895248-d903-4681-b5da-fb4b107d6d16", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cad9b2af-e1dc-476b-9f79-2041474765b7", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "48c4d1ec-437c-4d15-9d14-a1fcd592b746", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c20c1515-ea78-449e-b2e1-1274f8b53497", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy Subaccount not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e639a5c7-e3f8-4c5d-861d-036d7fcc1165", "documentation": "Description: This operation retrieves all Life Insurance Policy Types for the specified country.
\r\n Purpose: Provides access to the Life Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/LifeInsurancePolicyTypes", "responses": [ { "uuid": "fcdc9546-122d-455b-a7bc-bab82d68de43", "body": "{\n \"insurancePolicyTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "505eb5f8-8d94-478a-8c6e-9a0bfbe1a4d2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e1117ae5-bfbd-4aca-ada1-e36cdcb893e4", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b3afe98-6b55-46aa-800a-16333a26f886", "documentation": "Description: This operation retrieves the Life Insurance Policy Type for the specified id.
\r\n Purpose: Provides access to the Life Insurance Policy Types including id and type description.", "method": "get", "endpoint": "api/LifeInsurancePolicyTypes/:id", "responses": [ { "uuid": "457ece4b-4374-4a09-be79-c1ba398cae36", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9a9b6587-3f50-4817-906b-30de7cf4ee77", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "be580b33-22aa-4085-a75f-81837bbd0747", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c45b6c81-4d07-4ebb-a38e-50bab9ff8ae9", "documentation": "Description: This operation retrieves all Lifestyle Asset Types for the specified country.
\r\n Purpose: Provides access to the Lifestyle Asset Types including id and type description.", "method": "get", "endpoint": "api/LifestyleAssetTypes", "responses": [ { "uuid": "fefab596-efa0-45e1-bfe9-d260c13b5e97", "body": "{\n \"lifestyleAssetTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f570b6ef-114d-422f-9282-0bb486f94a73", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fa3bf94e-3c85-4516-b6fe-c4e3ee945d57", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5ecded2a-f146-49fa-a222-cf55d4b47377", "documentation": "Description: This operation retrieves the Lifestyle Asset Type for the specified id.
\r\n Purpose: Provides access to the Lifestyle Asset Types including id and type description.", "method": "get", "endpoint": "api/LifestyleAssetTypes/:id", "responses": [ { "uuid": "1bf770a6-c05e-494f-9679-2cb3052c4657", "body": "{\n \"id\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8d1ced9f-dff8-4c09-9841-ec4d90d54021", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d67f9c4b-cf00-4534-9ae5-d704c9e5b9c3", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "130b77b2-f4c5-4550-aff5-372a08f84745", "documentation": "Description: This operation retrieves all Lifestyle Assets for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Lifestyle Assets including description and market value.", "method": "get", "endpoint": "api/LifestyleAssets", "responses": [ { "uuid": "cf2025ee-3d8a-4c0b-9340-d966dcb80457", "body": "{\n \"lifestyleAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "134ef99a-d2c0-47bf-b86a-848c18b538ae", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "db3c2f75-370e-4d97-95ff-d388e6fc96df", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Lifestyle Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7ce35168-4e69-452a-a1e0-1ff53af2c717", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Lifestyle Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63c57d8a-5af5-4400-8b3e-879e9a2f0bf4", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a824de2-a0ff-49c9-9856-dd176d3e50ba", "documentation": "Description: The operation creates a Lifestyle Asset.
\r\n Purpose: Allows for creation of Lifestyle Assets on a Fact Finder.", "method": "post", "endpoint": "api/LifestyleAssets", "responses": [ { "uuid": "37a502f8-74d2-4c16-8150-eb22b0bc404d", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "eb821172-3c9d-406f-9df9-7de27e196fe5", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3ebaf8ba-63b3-49ec-8db0-0531853ba2a1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Lifestyle Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab57d97a-691d-42b5-ae0e-539ab8746152", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Lifestyle Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e6ef5f10-3615-424a-956c-08409307c3fb", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "834f233a-4296-4da2-a60e-ca8841fe2a92", "documentation": "Description: The operation removes a Lifestyle Asset tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Lifestyle Asset from a Fact Finder.", "method": "delete", "endpoint": "api/LifestyleAssets/:id", "responses": [ { "uuid": "6a41dcd3-fcc5-4706-9e52-49a0dc825296", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5f9b00da-f834-4097-ab0b-3452ac730863", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "74037922-1388-4238-bccd-fcce7be67b10", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Lifestyle Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6782ba4f-2fda-4314-8dbd-19f7ef5117ec", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Lifestyle Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d0a4d2e9-7137-4c49-9f4b-130ea99ebee7", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fb838057-5f4f-4ff8-a661-b6c6802605c2", "documentation": "Description: This operation retrieves a single Lifestyle Asset for the specified Lifestyle Asset ID.
\r\n Purpose: Provides access to the Lifestyle Asset including description and market value.", "method": "get", "endpoint": "api/LifestyleAssets/:id", "responses": [ { "uuid": "980c4c36-746f-47ff-a516-b9718d3751da", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3600e4ac-c103-45f8-b428-c6eba5ec3bc6", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cc376b5b-0751-4798-a417-148b6550bb2f", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Lifestyle Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a4686a2e-3219-4917-9134-9e95e23fe2c0", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Lifestyle Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "88ba260c-0158-4235-8099-0bd962f1457a", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "05e5c782-c81d-4f97-9039-dc058526d33f", "documentation": "Description: The operation updates a Lifestyle Asset.
\r\n Purpose: Allows for complete replacement of a Lifestyle Asset on a Fact Finder.", "method": "put", "endpoint": "api/LifestyleAssets/:id", "responses": [ { "uuid": "7528dbb9-d4fb-4f6e-a037-fd3cdfc7811e", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"lifestyleAssetId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"type\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "76b0bf9a-9694-4723-a142-ed952d6a971a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46705c1a-0569-489d-b025-41fe8b497abd", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Lifestyle Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f93cf099-b1eb-4696-b68a-7e26030b254b", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Lifestyle Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3718eb65-c1b4-41e6-aa27-a2baed18dc20", "body": "", "latency": 0, "statusCode": 404, "label": "Lifestyle Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6b7ca929-4977-40cf-812e-bd20323efd07", "documentation": "Description: This operation retrieves all Long Term Care Insurance Policies for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Long Term Care Insurance Policies including description and premium.", "method": "get", "endpoint": "api/LongTermCareInsurancePolicies", "responses": [ { "uuid": "acf0755a-0a9c-4176-a0e7-6b9a16cbb620", "body": "{\n \"longTermCareInsurancePolicies\": [\n {\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1b38aa66-f495-4dd5-abc1-7fcebb8806f3", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "689b4593-ba4d-4147-a730-12900cacbdc8", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Long Term Care Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2567da34-0bde-497a-9d47-4ffaf297fbd3", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Long Term Care Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d32741db-5a56-49ec-b5ff-56227ad43cfd", "body": "", "latency": 0, "statusCode": 404, "label": "Long Term Care Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f12eea01-921f-4d68-aaa9-01f757034117", "documentation": "Description: The operation creates a Long Term Care Insurance Policy.
\r\n Purpose: Allows for creation of Long Term Care Insurance Policies on a Fact Finder.", "method": "post", "endpoint": "api/LongTermCareInsurancePolicies", "responses": [ { "uuid": "482da4ef-0b8c-4c8f-8eb3-eac4ecebb529", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "270d09fe-0198-423a-8231-0c442f9fdc71", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9caeccfa-08ff-4d72-8a30-b3d1f4cea521", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Long Term Care Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "774feab3-b839-438d-93eb-ef2906f7f97a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Long Term Care Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "599b7954-e26d-4aea-b3f1-d9d6124263da", "body": "", "latency": 0, "statusCode": 404, "label": "Long Term Care Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6b0c9778-85bf-45ef-9462-70d6292c6584", "documentation": "Description: The operation removes a Long Term Care Insurance Policy tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Long Term Care Insurance Policy from a Fact Finder.", "method": "delete", "endpoint": "api/LongTermCareInsurancePolicies/:id", "responses": [ { "uuid": "23920d54-2200-4523-aa91-25ddfdb9523d", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2520e0a2-fba8-43eb-b6d3-b85dbec13309", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2449f282-61aa-4790-951b-28819b413681", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Long Term Care Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f4a7c061-c595-49c5-98d0-41c418b5b34b", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Long Term Care Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3a6f9b2e-7835-4394-9165-f4bcdc0db815", "body": "", "latency": 0, "statusCode": 404, "label": "Long Term Care Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ad007254-abe8-4848-9bc3-63ab8028915a", "documentation": "Description: This operation retrieves a single Long Term Care Insurance Policy for the specified Long Term Care Insurance Policy ID.
\r\n Purpose: Provides access to the Long Term Care Insurance Policy including description and premium.", "method": "get", "endpoint": "api/LongTermCareInsurancePolicies/:id", "responses": [ { "uuid": "26205ad3-917f-4ad6-acb2-3fc6ccdef375", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9f7b31f2-8fe3-4fb3-a082-3dee832cc5f1", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97262d5e-1419-487d-a8a3-b12fc5266cdf", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Long Term Care Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "68792492-23eb-4633-a7fa-47082a7abd20", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Long Term Care Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a078da22-c32e-41fb-a71b-e5d3224b8f43", "body": "", "latency": 0, "statusCode": 404, "label": "Long Term Care Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6c2cef6-d60a-491d-bb10-4dd4d75a2de0", "documentation": "Description: The operation updates a Long Term Care Insurance Policy.
\r\n Purpose: Allows for complete replacement of a Long Term Care Insurance Policy on a Fact Finder.", "method": "put", "endpoint": "api/LongTermCareInsurancePolicies/:id", "responses": [ { "uuid": "2b469ac6-07b3-4c3d-9d40-86ba19ddb8f4", "body": "{\n \"benefit\": {{faker 'number.float'}},\n \"benefitFrequency\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"premium\": {{faker 'number.float'}},\n \"premiumFrequency\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f44d6d5f-51ce-4311-a07a-e5c5a25c3b85", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "68a7582b-3d9f-43aa-b890-ef200182c278", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Long Term Care Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ba6ae78a-f24c-4f11-a929-c91c56456f8d", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Long Term Care Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9a5c21cf-1fde-4fad-9f2b-974fb4c541fb", "body": "", "latency": 0, "statusCode": 404, "label": "Long Term Care Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6e4fcdf2-89cc-493f-b2b4-f1d354b24d58", "documentation": "Description: This operation retrieves all Major Purchase Goal Types for the specified country.
\r\n Purpose: Provides access to the Major Purchase Goal Types including id and type description.", "method": "get", "endpoint": "api/MajorPurchaseGoalTypes", "responses": [ { "uuid": "8232a9f8-dd3a-43ad-a878-1b7c06998773", "body": "{\n \"majorPurchaseGoalTypes\": [\n {\n \"description\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "855c5ab9-23ed-492a-b066-198a6977b84a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5bc826bc-8781-4b80-9fe5-d6c774528870", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase Goal Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e66261ef-9c0a-4d03-a356-9aa613dfc61c", "documentation": "Description: This operation retrieves the Major Purchase Goal Type for the specified id.
\r\n Purpose: Provides access to the Major Purchase Goal Types including id and type description.", "method": "get", "endpoint": "api/MajorPurchaseGoalTypes/:id", "responses": [ { "uuid": "4f273440-ebd7-41dd-9744-f1a1e4c41f96", "body": "{\n \"description\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0681364d-ffb8-4a72-ba97-a729aa0be5f1", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9fa816b3-bedb-4994-8978-bbd883b23b08", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase Goal Type not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f9641d01-4b47-4ac7-be98-4c536a75889c", "documentation": "Description: This operation retrieves all Major Purchases for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Major Purchases including description and amount.", "method": "get", "endpoint": "api/MajorPurchaseGoals", "responses": [ { "uuid": "01fa0ffe-7289-437b-b974-5069cc196127", "body": "{\n \"majorPurchaseGoals\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1cca8fdc-9f3f-413c-b1ad-652b6bb1c6c2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a173d577-2fbc-4006-871a-f2ef6170289d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Major Purchase data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e510ab81-8afd-4baf-b351-c125dbd19cc2", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Major Purchase.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3f6bd0da-520d-493e-840e-24c62750b847", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b1d864e-f82c-4678-8530-d5a62ed8568c", "documentation": "Description: The operation creates a Major Purchase.
\r\n Purpose: Allows for creation of Major Purchases on a Fact Finder.", "method": "post", "endpoint": "api/MajorPurchaseGoals", "responses": [ { "uuid": "9781ebf5-3575-4189-a007-82fbedbc6544", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "39a18d6e-da85-4184-8484-cc5bfe84b497", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c2fee4e-bdf8-46f2-bd40-f602f0f93a6e", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Major Purchase data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e3df336a-8a2b-41ca-a0be-46e50dfceb96", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Major Purchase.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "85d45626-2d46-456c-99c3-8edb94643ec6", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bcc2172f-f6d0-4bc6-a4b8-79fc697df5b0", "documentation": "Description: The operation removes a Major Purchase tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Major Purchase from a Fact Finder.", "method": "delete", "endpoint": "api/MajorPurchaseGoals/:id", "responses": [ { "uuid": "7a16dd36-ab0b-4ec2-a51c-36aaa919e563", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "54b0cb21-9c1a-441f-b974-7f3a6b6e4963", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6067fe92-99bb-450f-87bf-38b32f801781", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Major Purchase data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "564ba7be-a186-480b-871c-4f9395690e9f", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Major Purchase.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f57721eb-de03-462d-a876-f9c2c3f18785", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "56bab9b8-d1a6-44af-940f-008e5add2284", "documentation": "Description: This operation retrieves a single Major Purchase for the specified Major Purchase ID.
\r\n Purpose: Provides access to the Major Purchase including description and amount.", "method": "get", "endpoint": "api/MajorPurchaseGoals/:id", "responses": [ { "uuid": "60d2f0e4-82da-4bb0-b8c6-29e6f1e6164d", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22f2b890-23c9-4662-a25c-6e74d52830bd", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3ef414f8-7dbd-41d0-af81-6f8b0ffff383", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Major Purchase data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "594167d6-c898-4803-8531-f090dc35f784", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Major Purchase.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6b798d80-0c99-4380-9187-1cff079ed0c4", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99847750-704c-4be1-9a11-bfafb2cadba7", "documentation": "Description: The operation updates a Major Purchase.
\r\n Purpose: Allows for complete replacement of a Major Purchase on a Fact Finder.", "method": "put", "endpoint": "api/MajorPurchaseGoals/:id", "responses": [ { "uuid": "5082380b-7f3e-4daa-b13b-411584cdd8c4", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"majorPurchaseGoalId\": {{faker 'number.int' max=99999}},\n \"majorPurchaseGoalTypeId\": {{faker 'number.int' max=99999}},\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"targetDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c88f5e2c-c11a-49f4-9b83-2bbbabcc71c9", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b7cdeb6-27b6-43f5-be53-88a6f670a79b", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Major Purchase data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "929830fa-a9f1-4f37-97b2-e8f209900f00", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Major Purchase.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b71198f7-eeed-430b-af3d-b7163d7a9521", "body": "", "latency": 0, "statusCode": 404, "label": "Major Purchase not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d764436d-dd4a-4a5a-98a5-129d06061068", "documentation": "Description: This operation retrieves all current Accounts for the specified Fact Finder ID, as well as\r\n all of the holdings and savings strategies belonging to those accounts.
\r\n Purpose: Provides access to the Accounts in a Fact Finder as well as any sub-entities belonging to them.", "method": "get", "endpoint": "api/Presentation/Accounts", "responses": [ { "uuid": "f40114d7-84d2-47c3-9dc1-ca5f06a00eef", "body": "{\n \"accounts\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"accountType\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"holdings\": [\n {\n \"accountHoldingId\": {{faker 'number.int' max=99999}},\n \"accountId\": {{faker 'number.int' max=99999}},\n \"costBasis\": {{faker 'number.float'}},\n \"cusip\": \"\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\",\n \"valuationDate\": \"{{faker 'date.recent' 365}}\"\n }\n ],\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Dependent' 'Other')}}\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}},\n \"savingsStrategies\": [\n {\n \"accountId\": {{faker 'number.int' max=99999}},\n \"employerSavingsAmount\": {{faker 'number.float'}},\n \"employerSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequencyId\": {{faker 'number.int' max=99999}},\n \"mandatoryAmount\": {{faker 'number.float'}},\n \"mandatoryAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"postTaxSavingsAmount\": {{faker 'number.float'}},\n \"postTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"preTaxSavingsAmount\": {{faker 'number.float'}},\n \"preTaxSavingsAmountType\": \"{{oneOf (array 'Dollar' 'Percent' 'Max')}}\",\n \"savingsStrategyId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b0f3dab3-a500-44ca-bb33-c104f32dc1f4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8cb6267b-8dd2-42b7-a427-58011b599488", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Account data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2b65cd40-4675-4f91-921a-08434cd2aab2", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Account.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9ae85b1-f311-435b-bff0-f75d8c711b44", "body": "", "latency": 0, "statusCode": 404, "label": "Account not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b167b35-1eda-4e48-93b7-c9bcd4585a39", "documentation": "Description: This operation retrieves owner values for the fact finder based on demographics data\r\n Purpose: Provides the list of valid options for owner, student, beneficiary, etc.", "method": "get", "endpoint": "api/Presentation/Demographics/Owners", "responses": [ { "uuid": "d10663d7-7db4-49e4-b9d7-1136a1f56a33", "body": "{\n \"owners\": [\n {\n \"displayName\": \"\",\n \"owner\": \"\",\n \"ownerDependentId\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "badec6b6-ddce-43bc-a591-8926534b71ed", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "12d9c6d0-dbd9-40ae-ae95-85912a750d8a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Demographic information data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1d7cf24a-788d-4e01-bc04-82d699da01e7", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Demographic information.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c61af5ed-add6-43da-95ba-93fc4e50bcd8", "body": "", "latency": 0, "statusCode": 404, "label": "Fact Finder not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "185849b6-10b2-4d6d-9fca-fd2c890ed23c", "documentation": "Description: This operation retrieves all relationship types relevant to demographics.
\r\n Purpose: Provides a list of relationship types organized by whether or not they can be defined as children.", "method": "get", "endpoint": "api/Presentation/Demographics/Relationships", "responses": [ { "uuid": "e78c8ab7-1385-4464-b9eb-2bec8980c504", "body": "{\n \"relationshipTypes\": [\n {\n \"id\": {{faker 'number.int' max=99999}},\n \"isChildType\": {{faker 'datatype.boolean'}},\n \"relationshipType\": \"{{oneOf (array 'Son' 'Daughter' 'FosterSon' 'FosterDaughter' 'Grandson' 'Granddaughter' 'Nephew' 'Niece' 'MaleCousin' 'FemaleCousin' 'Father' 'Mother' 'Grandfather' 'Grandmother' 'Uncle' 'Aunt' 'Brother' 'Sister' 'SonInLaw' 'DaughterInLaw' 'MaleOther' 'FemaleOther')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2d56170a-dd3e-43ac-a2c3-fcd7b77a508a", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ec4f54f2-fe70-450c-bfce-a687e9d0c6dd", "body": "", "latency": 0, "statusCode": 404, "label": "Object not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "10d016fb-80a0-478d-a131-c12509d69b85", "documentation": "Description: This operation retrieves all current Incomes for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Incomes in a Fact Finder, filtered by Incomes that are current.", "method": "get", "endpoint": "api/Presentation/Incomes", "responses": [ { "uuid": "4d0df0b4-920c-4063-8974-efc06daad33b", "body": "{\n \"incomes\": [\n {\n \"annualAmount\": {{faker 'number.float'}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"incomeId\": {{faker 'number.int' max=99999}},\n \"incomeTypeId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"owner\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2b4c7417-c88f-457e-b3ee-86c2b54cf201", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9446b3e0-cb3e-42a0-a310-cc186a82bd14", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Income data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef2dbb40-8dc2-4bc2-b614-7d58306e46a6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Income.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a1537a25-7691-4626-931d-a442401d4f0d", "body": "", "latency": 0, "statusCode": 404, "label": "Income not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9f65ce5d-2d1b-4baf-a36c-4abc3c60de32", "documentation": "Description: This operation retrieves all current Liabilities for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Liabilities in a Fact Finder, filtered by Liabilities that are current.", "method": "get", "endpoint": "api/Presentation/Liabilities", "responses": [ { "uuid": "434f1dc5-07b2-4d92-bbcc-7214e430fa6f", "body": "{\n \"liabilities\": [\n {\n \"balance\": {{faker 'number.float'}},\n \"balanceAsOfDate\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"externalSourceId\": \"\",\n \"externalSourceName\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"interestRate\": {{faker 'number.float'}},\n \"lastUpdated\": \"{{faker 'date.recent' 365}}\",\n \"liabilityId\": {{faker 'number.int' max=99999}},\n \"liabilityType\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"loanDate\": \"{{faker 'date.recent' 365}}\",\n \"originalPrincipal\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"payment\": {{faker 'number.float'}},\n \"paymentType\": \"{{oneOf (array 'InterestOnly' 'PrincipalAndInterest' 'SetPrincipal' 'LastPeriod')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6a20029-9191-4f17-958f-c71711ab808b", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f8acb365-7ff0-4861-8a62-6192b0d61f4d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Liability data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "95c5c287-cb3b-4579-ba39-bb0953579e0b", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Liability.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a50d2d48-7fde-4f28-ab7a-c0d0ea466b5e", "body": "", "latency": 0, "statusCode": 404, "label": "Liability not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eff74189-21b6-47ad-900a-7c036f745a34", "documentation": "Description: This operation retrieves all life insurance policies, including subaccounts if available, for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Life Insurance Policies in a Fact Finder.", "method": "get", "endpoint": "api/Presentation/LifeInsurancePolicies", "responses": [ { "uuid": "8a866e7c-72de-494b-88b2-3d313b9e1618", "body": "{\n \"lifeInsurancePolicies\": [\n {\n \"beneficiary\": \"{{oneOf (array 'Client' 'CoClient' 'Dependent' 'Other')}}\",\n \"beneficiaryDependentId\": {{faker 'number.int' max=99999}},\n \"benefit\": {{faker 'number.float'}},\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"generalAccountMarketValue\": {{faker 'number.float'}},\n \"insurancePolicyId\": {{faker 'number.int' max=99999}},\n \"insured\": \"{{oneOf (array 'Client' 'CoClient' 'FirstToDie' 'SecondToDie' 'Other')}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"payer\": \"{{oneOf (array 'Client' 'CoClient' 'Joint' 'Other')}}\",\n \"policyType\": {{faker 'number.int' max=99999}},\n \"premium\": {{faker 'number.float'}},\n \"subaccounts\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"lifeInsurancePolicyId\": {{faker 'number.int' max=99999}},\n \"lifeInsurancePolicySubaccountId\": {{faker 'number.int' max=99999}},\n \"marketValue\": {{faker 'number.float'}},\n \"symbol\": \"\"\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5c506f46-2ec1-4e0c-b5ed-970576ee85df", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8243de9d-fd74-49fb-8d5a-efe5eeddec28", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Life Insurance Policy data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06a51fbb-808d-446e-91a9-24abebe3e2dd", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Life Insurance Policy.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6df426dc-8867-4010-aae2-9f5518544837", "body": "", "latency": 0, "statusCode": 404, "label": "Life Insurance Policy not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d6b29d9e-c093-4ab3-931a-1d4bf185cd3a", "documentation": "Description: This operation retrieves all future Defined Benefit Pensions for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Pensions in a Fact Finder, filtered by Pensions that are in the future.", "method": "get", "endpoint": "api/Presentation/Pensions", "responses": [ { "uuid": "fc19a14c-76f2-40c3-8352-80eb09c06386", "body": "{\n \"definedBenefitPensions\": [\n {\n \"definedBenefitPensionId\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"estimatedAmount\": {{faker 'number.float'}},\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient')}}\",\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1cd0e259-d484-45bb-9253-b0ae0c64b5bc", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14bc321f-4e31-4630-94fb-9b840c59f105", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Defined Benefit Pension data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "760c3254-c8d6-4325-af88-a00376e379cf", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Defined Benefit Pension.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d95672e-4712-4751-9d59-61f053f60e6b", "body": "", "latency": 0, "statusCode": 404, "label": "Defined Benefit Pension not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99a19109-5872-4960-abcc-ee5fdbe708ed", "documentation": "Description: This operation retrieves all Real Estate Assets for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Real Estate Assets including description and market value.", "method": "get", "endpoint": "api/RealEstateAssets", "responses": [ { "uuid": "1107d41b-b099-4695-af2d-404414ea5c36", "body": "{\n \"realEstateAssets\": [\n {\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b5802fad-f7b0-46f9-9c3b-b826ac490f43", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ce027c9c-4888-4100-8a01-e645695f5022", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Real Estate Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "39fd2749-691c-4de2-a951-b9fbcd7e5ea9", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Real Estate Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a2a0bfb8-db17-4cd9-8d3a-6dd94289fd52", "body": "", "latency": 0, "statusCode": 404, "label": "Real Estate Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0661df0b-e383-4ca8-bc4e-6e8c5d8ac33d", "documentation": "Description: The operation creates a Real Estate Asset.
\r\n Purpose: Allows for creation of Real Estate Assets on a Fact Finder.", "method": "post", "endpoint": "api/RealEstateAssets", "responses": [ { "uuid": "639018f8-e238-4b3b-9005-2b9636d872f0", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "faddd99c-a41d-4896-9bf1-74a90e3f31c3", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1d1b12ff-57c1-483e-a8c9-63a44bc78eb6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Real Estate Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "22070d63-1509-4745-9b92-ddf1079e4245", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Real Estate Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4273bb93-9d0e-4880-a78f-f9b96157040a", "body": "", "latency": 0, "statusCode": 404, "label": "Real Estate Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f50768c7-d250-4124-9365-a9124aa2ae1d", "documentation": "Description: The operation removes a Real Estate Asset tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Real Estate Asset from a Fact Finder.", "method": "delete", "endpoint": "api/RealEstateAssets/:id", "responses": [ { "uuid": "2ae57325-d5b1-485c-910b-5f82a62a12eb", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86772769-2c04-4afc-9214-443d6d9df684", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dda331be-1544-4a26-a0a7-9074e8f0d9cf", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Real Estate Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb675156-c6d4-4415-8b0f-12519d2ae126", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Real Estate Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ad51af27-b1ca-47ed-924c-23a594cda908", "body": "", "latency": 0, "statusCode": 404, "label": "Real Estate Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2ff62615-473e-4a03-bc36-781e20d8ac81", "documentation": "Description: This operation retrieves a single Real Estate Asset for the specified Real Estate Asset ID.
\r\n Purpose: Provides access to the Real Estate Asset including description and market value.", "method": "get", "endpoint": "api/RealEstateAssets/:id", "responses": [ { "uuid": "db819634-089d-4636-9d79-53f4ad49d226", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b7150eb2-f2c5-4a71-91c4-919f43c60718", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b765dd27-d48d-4309-8e3a-7afcf7e6b5e2", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Real Estate Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "855c2187-11aa-4d59-a37a-fa34116e82f9", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Real Estate Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c118f861-f0f4-45c8-b16c-cb270d553b3b", "body": "", "latency": 0, "statusCode": 404, "label": "Real Estate Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6de911ba-5baf-47bb-a933-5c10e7bef3af", "documentation": "Description: The operation updates a Real Estate Asset.
\r\n Purpose: Allows for complete replacement of a Real Estate Asset on a Fact Finder.", "method": "put", "endpoint": "api/RealEstateAssets/:id", "responses": [ { "uuid": "58ef2c1c-30c1-4f19-897c-1e8cebc6ec2b", "body": "{\n \"description\": \"\",\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"marketValue\": {{faker 'number.float'}},\n \"owner\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"purchaseAmount\": {{faker 'number.float'}},\n \"purchaseDate\": \"{{faker 'date.recent' 365}}\",\n \"realEstateAssetId\": {{faker 'number.int' max=99999}},\n \"rentalIncome\": {{faker 'number.float'}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9ef937ce-6e08-4fb2-ba33-880ba8765a0c", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "65cc6b21-5c98-4279-9163-af3369f40606", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Real Estate Asset data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "664c84dd-82ec-461e-a79c-03372956ff30", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Real Estate Asset.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f28260fc-5545-4fd2-a8ff-806d07431c18", "body": "", "latency": 0, "statusCode": 404, "label": "Real Estate Asset not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7de77eb0-1e65-496e-8617-209dd7a2d065", "documentation": "Description: This operation retrieves all Retirement Goals for the specified Fact Finder ID.
\r\n Purpose: Provides access to the Retirement Goals including retirement date.", "method": "get", "endpoint": "api/RetirementGoals", "responses": [ { "uuid": "551148cd-94a3-4658-b906-a4a8ac4183ca", "body": "{\n \"retirementGoals\": [\n {\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b3012833-085d-4a29-b018-ab4a61c4dc38", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "84a7d04c-1997-4422-a257-34bc8eb2a721", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6b8ebe9a-4521-4cc4-bb3e-dc16c7cbf29a", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a217281a-db20-4956-9ada-738180624de7", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dba13a1a-f377-477a-a249-919e3b5867df", "documentation": "Description: The operation creates a Retirement Goal.
\r\n Purpose: Allows for creation of Retirement Goals on a Fact Finder.", "method": "post", "endpoint": "api/RetirementGoals", "responses": [ { "uuid": "0d405d93-f7b7-443a-8ce6-b655b7e8e068", "body": "{\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fee84314-77b6-44c4-b803-070666fcdc5f", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69c86b0c-f80b-4b44-8d39-641ed269131d", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3a1552cc-2237-4dd7-bfcd-18cb58289571", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7e00eb3c-77b8-4cfa-afad-01ad39cec61c", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "72ef117c-84f0-40af-a525-e60689289857", "documentation": "Description: The operation removes a Retirement Goal tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Retirement Goal from a Fact Finder.", "method": "delete", "endpoint": "api/RetirementGoals/:id", "responses": [ { "uuid": "d87ede34-3d3c-4c57-b16d-4b1ac7b30d08", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b9f637d0-df7c-406b-999b-9fcad49ae3d1", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "990a9737-7454-4034-b9ca-02ab3e9cc135", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d04cd97a-88cb-4fed-9054-a4432d383ab8", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0510abd7-698f-451f-9de7-3e7bd9be522f", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e512227d-1357-467d-8c05-16c2d77f4ee8", "documentation": "Description: This operation retrieves a single Retirement Goal for the specified Retirement Goal ID.
\r\n Purpose: Provides access to the Retirement Goal including retirement date.", "method": "get", "endpoint": "api/RetirementGoals/:id", "responses": [ { "uuid": "aa2c08c7-d896-4c8b-905c-5480bad7109d", "body": "{\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8baf5da7-ccdb-46dc-ae87-aa1ada20aa01", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "96e5440d-f036-4300-88e6-d0d7ccd6dc05", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ddacdb41-d1e6-4431-ab68-af2763b7d671", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a41d22bf-afb3-4a68-abad-d8c5337296e5", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5d7bbea-dc9d-47af-9c42-4d200d7bc766", "documentation": "Description: The operation updates a Retirement Goal.
\r\n Purpose: Allows for complete replacement of a Retirement Goal on a Fact Finder.", "method": "put", "endpoint": "api/RetirementGoals/:id", "responses": [ { "uuid": "ba90b8be-6b56-4953-b7c2-7d390939c0cc", "body": "{\n \"externalDestinationId\": \"\",\n \"factFinderId\": {{faker 'number.int' max=99999}},\n \"head1RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"head2RetirementDate\": \"{{faker 'date.recent' 365}}\",\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"retirementGoalId\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f710f196-5ccd-4e3a-8bcc-7e52f8e99a69", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "299583ea-4367-4770-91ee-c3fac4994f2a", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7d096bb2-8342-4099-a032-8782ca48bf90", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2053fdce-d43e-4c6e-9fb0-9f64fe884728", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44f0e0c8-dce3-449a-9d3b-e09f0adee676", "documentation": "Description: This operation retrieves all Retirement Goal Expenses for the specified Retirement Goal ID.
\r\n Purpose: Provides access to the Retirement Goal Expenses including description and amount.", "method": "get", "endpoint": "api/RetirementGoals/:retirementGoalId/Expenses", "responses": [ { "uuid": "fd47a164-fd45-4cfb-a603-0cf64a878d60", "body": "{\n \"retirementExpenses\": [\n {\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "10a5ea3a-e147-47c8-a029-62ca2670d8e2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bbb87843-aaf5-474e-b4be-525d9c75c812", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b7985d75-4ede-433e-8f41-42a19ff10a8f", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ade58f35-5885-4622-96d1-a1e46884a942", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2f458be2-045d-4075-9a1d-4648a99e350e", "documentation": "Description: The operation creates a Retirement Goal Expense.
\r\n Purpose: Allows for creation of Retirement Goal Expenses on a Fact Finder.", "method": "post", "endpoint": "api/RetirementGoals/:retirementGoalId/Expenses", "responses": [ { "uuid": "0ab961a5-c1eb-4b3b-8c54-cb823ef0c951", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9c06c30f-cf0c-48de-be9b-d9c474eb7296", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "edee070d-9741-4385-bd5a-ed351636c3e6", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b1b227fe-bd0b-4c4f-9184-750e6f35cd22", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "23ba2cde-f245-499b-a826-1d0c5cfada77", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "98549f51-f12e-4c28-a7bd-3a05de1760a2", "documentation": "Description: The operation removes a Retirement Goal Expense tied to a Fact Finder.
\r\n Purpose: Allows for removal of a Retirement Goal Expense from a Fact Finder.", "method": "delete", "endpoint": "api/RetirementGoals/:retirementGoalId/Expenses/:id", "responses": [ { "uuid": "1b370044-698b-4b2f-b3d7-2a3b83d09b70", "body": "", "latency": 0, "statusCode": 204, "label": "Deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c1b65d03-7a10-4bc1-8e8c-ea8cdeea85c2", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dfd127fc-5d7f-4feb-bfb5-db9db0fa9a97", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9b27cf71-9cc6-4e17-9a1b-42fa61b2480c", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1349c674-a770-4b31-9f8e-1874b3432029", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d76ef2ab-c744-4713-872c-bfff39af7368", "documentation": "Description: This operation retrieves a single Retirement Goal Expense for the specified Retirement Goal Expense ID.
\r\n Purpose: Provides access to the Retirement Goal Expense including description and amount.", "method": "get", "endpoint": "api/RetirementGoals/:retirementGoalId/Expenses/:id", "responses": [ { "uuid": "5fc6c961-d1f1-4b78-aa08-00a54866bfef", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7cc2f83f-a569-4042-b228-656658133030", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f5d1dfaa-c7fd-404a-b698-d236a170b7c1", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "36fba917-76ec-44e9-99dc-5155cfba16a6", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1a1f5550-8c52-43df-96a9-c2a4b52cf761", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7851cc69-01b9-486f-a656-0e777cdbe97d", "documentation": "Description: The operation updates a Retirement Goal Expense.
\r\n Purpose: Allows for complete replacement of a Retirement Goal Expense on a Fact Finder.", "method": "put", "endpoint": "api/RetirementGoals/:retirementGoalId/Expenses/:id", "responses": [ { "uuid": "420fdb8e-53dc-4338-984a-cb74bfc1a763", "body": "{\n \"amount\": {{faker 'number.float'}},\n \"annualPeriod\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"endDate\": \"{{faker 'date.recent' 365}}\",\n \"externalDestinationId\": \"\",\n \"frequency\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"member\": \"{{oneOf (array 'Client' 'CoClient' 'Joint')}}\",\n \"retirementExpenseId\": {{faker 'number.int' max=99999}},\n \"retirementGoalId\": {{faker 'number.int' max=99999}},\n \"startDate\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "aeace571-2f62-4451-bdf1-b06e98c19764", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0e6f6eab-cde5-496f-80b7-3d3a5ecb0766", "body": "", "latency": 0, "statusCode": 401, "label": "Unauthorized for Retirement Goal Expense data access.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "844af321-b413-4f0b-b487-129e986d7a4b", "body": "", "latency": 0, "statusCode": 403, "label": "Request is restricted for access to Retirement Goal Expense.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7631b355-b0bc-41ef-8ccf-db2a2518cde9", "body": "", "latency": 0, "statusCode": 404, "label": "Retirement Goal Expense not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "09393fc6-578c-4542-a274-3dd12a8483c3", "documentation": "Description: This operation retrieves information statistics for the current service.
\r\n Purpose: Provides access to Service Information.", "method": "get", "endpoint": "api/ServiceInformation", "responses": [ { "uuid": "598556d4-5e81-4ed0-b8e4-94518d8948bd", "body": "{\n \"name\": \"\",\n \"schemaVersion\": {{faker 'number.int' max=99999}},\n \"serviceVersion\": \"\",\n \"status\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e52009b8-c36a-49c7-a4aa-8a7526fac429", "body": "", "latency": 0, "statusCode": 404, "label": "Object not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5ddb3540-e2ef-45d6-81ae-8247a0912e64", "documentation": "Description: This operation retrieves all States and Provinces for the specified country.
\r\n Purpose: Provides access to the States and Provinces.", "method": "get", "endpoint": "api/StatesProvinces", "responses": [ { "uuid": "7a4f74bb-281c-446a-b37d-0554d22e4643", "body": "{\n \"statesProvinces\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"stateProvinceId\": {{faker 'number.int' max=99999}},\n \"stateProvinceName\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "42d43075-e9e2-40c7-a178-516f1d790111", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9fe904f7-a5ae-4a74-a81c-e8990c906b7b", "body": "", "latency": 0, "statusCode": 404, "label": "State or Province not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dcea1572-f969-47f1-beeb-189a994fbaea", "documentation": "Description: This operation retrieves the States and Provinces for the specified id.
\r\n Purpose: Provides access to the States and Provinces.", "method": "get", "endpoint": "api/StatesProvinces/:id", "responses": [ { "uuid": "9e884d9b-3960-41c3-b72f-04f7e4711dd6", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"rel\": \"\"\n }\n ],\n \"stateProvinceId\": {{faker 'number.int' max=99999}},\n \"stateProvinceName\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "91bb6f6c-02f0-40cb-97ba-e81a5c7a38c4", "body": "", "latency": 0, "statusCode": 400, "label": "The request is invalid.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc2bce5d-c438-4ef9-8a28-2a1257642f5a", "body": "", "latency": 0, "statusCode": 404, "label": "State or Province not found.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "b8f9ad5a-9c6c-426f-99bd-72ba74c73161" }, { "type": "route", "uuid": "42ffb3fe-9a68-43a9-8fed-92cb02b8977d" }, { "type": "route", "uuid": "e6f2de00-2ea8-476a-906f-f74736884ce5" }, { "type": "route", "uuid": "400d0469-7d91-48b6-9e52-d5ca0faa26b7" }, { "type": "route", "uuid": "9793cb28-29b2-480c-ae38-48d5d920844c" }, { "type": "route", "uuid": "9a2e1073-7deb-406a-885c-f3d9da0b30cd" }, { "type": "route", "uuid": "9b511fbc-5b8f-4032-8561-b82ed7118cc0" }, { "type": "route", "uuid": "1982f9d0-7523-4e61-93bc-fd0e918a3f06" }, { "type": "route", "uuid": "a337fc2a-9280-4c47-ac46-1ba9c3095cef" }, { "type": "route", "uuid": "f5c56f4c-00a7-4e5e-bc90-fa56d7489272" }, { "type": "route", "uuid": "2c8d36c1-ce8d-46d6-bc67-165a7eadd9ca" }, { "type": "route", "uuid": "10a9500c-d4c5-474b-93ea-59aa699c1446" }, { "type": "route", "uuid": "dec5c7a1-ee92-45b6-8264-d541afc87953" }, { "type": "route", "uuid": "e9e5977b-07d9-4ed9-b1ae-faba31b34db0" }, { "type": "route", "uuid": "1ae4ac58-41fd-4867-b349-d81b0407e5a6" }, { "type": "route", "uuid": "1b876868-9a7e-4d2c-b306-12129faffaf6" }, { "type": "route", "uuid": "f951a41d-3d2b-4d86-bb65-8cff5c1ebe03" }, { "type": "route", "uuid": "a7bd6969-b07a-4ee0-9faf-97e2cbcc95df" }, { "type": "route", "uuid": "0a80202b-da8b-42fa-88ca-163093b6cf01" }, { "type": "route", "uuid": "dc8d8b11-ae1e-4ca7-b6bc-1dc1dddcfc63" }, { "type": "route", "uuid": "3f76eed4-6294-4a99-b7ed-1098eac5e4da" }, { "type": "route", "uuid": "847ff19c-3004-4efc-b344-18295cdf7946" }, { "type": "route", "uuid": "8bbc0091-3700-4356-941d-22b68fc31310" }, { "type": "route", "uuid": "4aab651b-8baa-44bd-966e-57e0801dc2e3" }, { "type": "route", "uuid": "638f815b-e062-438a-ae0d-8ada1c90a309" }, { "type": "route", "uuid": "2cb4f029-679a-4a8e-983b-5828de4f4fae" }, { "type": "route", "uuid": "6a659182-17b5-4d1f-84c9-5f228736955e" }, { "type": "route", "uuid": "b430e5ef-f927-40df-bf2e-5d3ca930bc06" }, { "type": "route", "uuid": "d52cffde-6016-47f2-b687-e763cc58b2c8" }, { "type": "route", "uuid": "e57fea9e-2895-4599-9f8c-fcb69eda941a" }, { "type": "route", "uuid": "f10f45e4-0352-4c2e-b2a8-b114db7fa372" }, { "type": "route", "uuid": "6710d5e3-2472-4d0b-91e3-7604fb1574a6" }, { "type": "route", "uuid": "ee0badc5-57d1-43f7-99af-52d2aec2874c" }, { "type": "route", "uuid": "4fbeaf8e-66de-4ccd-990b-60915c5afd21" }, { "type": "route", "uuid": "bebc5bfc-cc2f-4efc-981b-a7c528bb6b09" }, { "type": "route", "uuid": "a4c1dc71-da7e-48d9-8cf5-e4dc68e0b231" }, { "type": "route", "uuid": "4850e6c1-9a02-4cc0-bdad-6ad621648b08" }, { "type": "route", "uuid": "41d9f06d-d961-4c64-a7a8-e7d67fc1df13" }, { "type": "route", "uuid": "39a72af9-a65b-46cb-bdce-6289e29496c4" }, { "type": "route", "uuid": "43b65fcb-d99a-45ad-93eb-7a4cca2a3fa9" }, { "type": "route", "uuid": "7b514ce0-6a3e-48e8-9591-fbc0d6b24e21" }, { "type": "route", "uuid": "702c320a-f80c-46c6-ae55-6036a7822fa1" }, { "type": "route", "uuid": "e2febb84-2bb5-47ee-8374-fc0cca3c2828" }, { "type": "route", "uuid": "ba8d8d2b-5069-4018-8b75-ba91f1cb2c10" }, { "type": "route", "uuid": "99d5ec8c-86ee-43f8-baee-fe789de87033" }, { "type": "route", "uuid": "41264189-0019-4261-b0c2-3e5e360d5619" }, { "type": "route", "uuid": "c9fcad15-03ef-4145-a018-0c7b280807df" }, { "type": "route", "uuid": "bec8e35e-e0ef-48fb-bab4-8adacdae6ae4" }, { "type": "route", "uuid": "5a2f8f76-56b6-41e5-97f3-63a7679b92cf" }, { "type": "route", "uuid": "cd7331ab-718b-4d4d-be5b-811968e8498b" }, { "type": "route", "uuid": "14bb6c3e-f23d-4afc-9c96-5310554d6c5c" }, { "type": "route", "uuid": "acca95ba-bc4e-428a-ba99-0c74e423a421" }, { "type": "route", "uuid": "6e636fb3-a31b-42ef-a8a4-44c2ada3f393" }, { "type": "route", "uuid": "96430bfa-a38d-4f81-8eca-55ac9cc5bfe7" }, { "type": "route", "uuid": "f1cecdd8-4af5-4640-9c9f-9571f34de874" }, { "type": "route", "uuid": "8b2e8997-e803-46d1-9132-841d0fdd7f09" }, { "type": "route", "uuid": "9b963588-5269-4f40-bb36-ab182b508b44" }, { "type": "route", "uuid": "daae2e6c-c360-4652-92d2-24ddc1df2200" }, { "type": "route", "uuid": "9c0fbca5-ac22-4456-9d35-d53436d90ce9" }, { "type": "route", "uuid": "5f8580f3-ac40-4ea1-acc8-0a1152fedbd5" }, { "type": "route", "uuid": "875398e2-f5e1-4298-a94f-d9b8853f5d54" }, { "type": "route", "uuid": "7bb7c5fb-e9ab-4f2f-be3c-ba4025b39e36" }, { "type": "route", "uuid": "795577d6-3e21-4e5c-9bd8-a19963faa7a7" }, { "type": "route", "uuid": "35444db9-9c96-48d8-b56e-a121edae4b2d" }, { "type": "route", "uuid": "d1573335-6112-4e83-9043-4b59ae2ca575" }, { "type": "route", "uuid": "beb9342e-83f1-4727-9af6-3f1c13251294" }, { "type": "route", "uuid": "cbe7a89f-3c8e-44f7-b4b5-db8ca3900031" }, { "type": "route", "uuid": "1b6eda9a-00ea-49cb-bd81-5e7997c20f9b" }, { "type": "route", "uuid": "5fff6886-381f-48dd-b321-96b8f4eaeedf" }, { "type": "route", "uuid": "b406fca8-9ff5-4a80-a837-3bb722064da3" }, { "type": "route", "uuid": "407589e5-82ba-402f-885d-bbe915ac788e" }, { "type": "route", "uuid": "55dfdaad-6824-4cdd-a79e-f8cecd91a067" }, { "type": "route", "uuid": "56d4b7eb-3f2c-48f5-84d7-2bce555ae1d3" }, { "type": "route", "uuid": "f7be2678-f1a9-4b75-8a5e-4c48e4fef7e9" }, { "type": "route", "uuid": "6c81099c-959d-44f1-8213-e50add20b5df" }, { "type": "route", "uuid": "ee81121a-945a-4e92-b490-530165ccba75" }, { "type": "route", "uuid": "45787362-2612-417d-9f0a-00da33034009" }, { "type": "route", "uuid": "658b5f79-ba6d-4eab-9e0b-9d96b49383b6" }, { "type": "route", "uuid": "9003a5ab-9c26-47d8-8ae2-534ad933288c" }, { "type": "route", "uuid": "d58b3a24-8457-4c32-b24a-a3a551985239" }, { "type": "route", "uuid": "7a96dfca-c2f5-4f92-b249-0002d770e256" }, { "type": "route", "uuid": "f37a6687-2c91-449e-959d-9655a6e37192" }, { "type": "route", "uuid": "7b9f9ff6-5495-4cd9-be32-6b1d5b70b88f" }, { "type": "route", "uuid": "43c76afe-0d49-4b1d-b12c-7a28137d4f93" }, { "type": "route", "uuid": "63f2d152-9de8-469f-a6d6-6b604f1eb11d" }, { "type": "route", "uuid": "863366bf-50d6-405d-b5c1-06b2d1021013" }, { "type": "route", "uuid": "e55c987a-74c3-4aae-8fde-b9fa8d958677" }, { "type": "route", "uuid": "93a08dad-84cd-4a93-81f1-5ff07d0dddbf" }, { "type": "route", "uuid": "82fea037-a964-4bc3-a1b0-c6e4019ae456" }, { "type": "route", "uuid": "1e24eb4e-4d5e-47f1-b002-a0a90df465bc" }, { "type": "route", "uuid": "0d1cb102-691c-4f2d-8036-94b952eee107" }, { "type": "route", "uuid": "40b930dc-7c42-4af4-9f2c-9ed4f13357d6" }, { "type": "route", "uuid": "15b535ff-8677-4042-a332-a135a07204ca" }, { "type": "route", "uuid": "7bd0e53e-ec31-45e8-ad52-97a3cb26fd77" }, { "type": "route", "uuid": "324ea56a-7ded-44f1-aa38-82ae9cf80b3d" }, { "type": "route", "uuid": "67117f43-4510-4b46-9904-852460696270" }, { "type": "route", "uuid": "6b380f3f-5b5f-4e28-ae41-d3b6b28297bf" }, { "type": "route", "uuid": "21cbeeee-1949-4928-875a-addd99e3876b" }, { "type": "route", "uuid": "4bc816c3-66a8-4d53-b844-50bc1eaeb8c1" }, { "type": "route", "uuid": "34f6e928-aaa1-469d-9519-ff88c65d2f28" }, { "type": "route", "uuid": "b047354d-8810-4ec4-8c3a-c5ff69281e12" }, { "type": "route", "uuid": "df459e0c-9637-4405-838d-a15f1d162920" }, { "type": "route", "uuid": "7cec7e9e-964f-470a-980c-32f2b01f2172" }, { "type": "route", "uuid": "94641f92-b8bb-4ad4-8e34-569654b3162f" }, { "type": "route", "uuid": "73d29c7b-5816-4e61-ae34-8af0529e9bde" }, { "type": "route", "uuid": "e639a5c7-e3f8-4c5d-861d-036d7fcc1165" }, { "type": "route", "uuid": "2b3afe98-6b55-46aa-800a-16333a26f886" }, { "type": "route", "uuid": "c45b6c81-4d07-4ebb-a38e-50bab9ff8ae9" }, { "type": "route", "uuid": "5ecded2a-f146-49fa-a222-cf55d4b47377" }, { "type": "route", "uuid": "130b77b2-f4c5-4550-aff5-372a08f84745" }, { "type": "route", "uuid": "9a824de2-a0ff-49c9-9856-dd176d3e50ba" }, { "type": "route", "uuid": "834f233a-4296-4da2-a60e-ca8841fe2a92" }, { "type": "route", "uuid": "fb838057-5f4f-4ff8-a661-b6c6802605c2" }, { "type": "route", "uuid": "05e5c782-c81d-4f97-9039-dc058526d33f" }, { "type": "route", "uuid": "6b7ca929-4977-40cf-812e-bd20323efd07" }, { "type": "route", "uuid": "f12eea01-921f-4d68-aaa9-01f757034117" }, { "type": "route", "uuid": "6b0c9778-85bf-45ef-9462-70d6292c6584" }, { "type": "route", "uuid": "ad007254-abe8-4848-9bc3-63ab8028915a" }, { "type": "route", "uuid": "f6c2cef6-d60a-491d-bb10-4dd4d75a2de0" }, { "type": "route", "uuid": "6e4fcdf2-89cc-493f-b2b4-f1d354b24d58" }, { "type": "route", "uuid": "e66261ef-9c0a-4d03-a356-9aa613dfc61c" }, { "type": "route", "uuid": "f9641d01-4b47-4ac7-be98-4c536a75889c" }, { "type": "route", "uuid": "7b1d864e-f82c-4678-8530-d5a62ed8568c" }, { "type": "route", "uuid": "bcc2172f-f6d0-4bc6-a4b8-79fc697df5b0" }, { "type": "route", "uuid": "56bab9b8-d1a6-44af-940f-008e5add2284" }, { "type": "route", "uuid": "99847750-704c-4be1-9a11-bfafb2cadba7" }, { "type": "route", "uuid": "d764436d-dd4a-4a5a-98a5-129d06061068" }, { "type": "route", "uuid": "0b167b35-1eda-4e48-93b7-c9bcd4585a39" }, { "type": "route", "uuid": "185849b6-10b2-4d6d-9fca-fd2c890ed23c" }, { "type": "route", "uuid": "10d016fb-80a0-478d-a131-c12509d69b85" }, { "type": "route", "uuid": "9f65ce5d-2d1b-4baf-a36c-4abc3c60de32" }, { "type": "route", "uuid": "eff74189-21b6-47ad-900a-7c036f745a34" }, { "type": "route", "uuid": "d6b29d9e-c093-4ab3-931a-1d4bf185cd3a" }, { "type": "route", "uuid": "99a19109-5872-4960-abcc-ee5fdbe708ed" }, { "type": "route", "uuid": "0661df0b-e383-4ca8-bc4e-6e8c5d8ac33d" }, { "type": "route", "uuid": "f50768c7-d250-4124-9365-a9124aa2ae1d" }, { "type": "route", "uuid": "2ff62615-473e-4a03-bc36-781e20d8ac81" }, { "type": "route", "uuid": "6de911ba-5baf-47bb-a933-5c10e7bef3af" }, { "type": "route", "uuid": "7de77eb0-1e65-496e-8617-209dd7a2d065" }, { "type": "route", "uuid": "dba13a1a-f377-477a-a249-919e3b5867df" }, { "type": "route", "uuid": "72ef117c-84f0-40af-a525-e60689289857" }, { "type": "route", "uuid": "e512227d-1357-467d-8c05-16c2d77f4ee8" }, { "type": "route", "uuid": "d5d7bbea-dc9d-47af-9c42-4d200d7bc766" }, { "type": "route", "uuid": "44f0e0c8-dce3-449a-9d3b-e09f0adee676" }, { "type": "route", "uuid": "2f458be2-045d-4075-9a1d-4648a99e350e" }, { "type": "route", "uuid": "98549f51-f12e-4c28-a7bd-3a05de1760a2" }, { "type": "route", "uuid": "d76ef2ab-c744-4713-872c-bfff39af7368" }, { "type": "route", "uuid": "7851cc69-01b9-486f-a656-0e777cdbe97d" }, { "type": "route", "uuid": "09393fc6-578c-4542-a274-3dd12a8483c3" }, { "type": "route", "uuid": "5ddb3540-e2ef-45d6-81ae-8247a0912e64" }, { "type": "route", "uuid": "dcea1572-f969-47f1-beeb-189a994fbaea" } ] }