{ "uuid": "7018d7cc-94d4-40b5-83f4-e2c1ea45b6d9", "lastMigration": 29, "name": "Benefits Intake", "endpointPrefix": "services/vba_documents/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "65b27cc9-7d5f-442d-9d16-cb9ed0100bf3", "documentation": "Accepts document upload.", "method": "put", "endpoint": "path", "responses": [ { "uuid": "70c8e81a-3fa0-4d2d-ac6e-16452b5efa89", "body": "", "latency": 0, "statusCode": 200, "label": "Document upload staged", "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": "e5b15b80-287f-4fb2-b21f-24aab5f24f7c", "body": "{\n \"Message\": \"Unauthorized Request\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf476a80-75bf-4c48-8558-48a980f64417", "body": "", "latency": 0, "statusCode": 403, "label": "Document upload failed", "headers": [{ "key": "Content-Type", "value": "application/xml" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a27eb2e1-e38e-463b-b78d-81c31cc648e8", "body": "{\n \"errors\": [\n {\n \"detail\": \"DOC104 - Upload rejected by upstream system. Processing failed and upload must be resubmitted\",\n \"status\": \"422\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1ac918e6-a2ce-41d9-9f06-b0d3d3182b79", "body": "{\n \"Message\": \"API rate limit exceeded\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f64a8860-148a-4764-8138-79073699fcf1", "body": "{\n \"code\": 500,\n \"detail\": \"Internal server error\",\n \"status\": 500,\n \"title\": \"Internal server error\"\n}", "latency": 0, "statusCode": 500, "label": "Internal server error", "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": "739b8d02-e17e-4da7-9a96-8e3d95a6ea52", "documentation": "Get a location for subsequent document upload PUT request", "method": "post", "endpoint": "uploads", "responses": [ { "uuid": "112f4108-ab55-450d-8cf8-35dcbdf415df", "body": "{\n \"data\": {\n \"attributes\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"guid\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"location\": \"https://sandbox-api.va.gov/services_user_content/vba_documents/{idpath}\",\n \"status\": \"{{oneOf (array 'pending' 'uploaded' 'received' 'processing' 'success' 'vbms' 'error')}}\",\n \"updated_at\": \"2018-07-30T17:31:15.958Z\",\n \"uploaded_pdf\": \"null\"\n },\n \"id\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"type\": \"document_upload\"\n }\n}", "latency": 0, "statusCode": 202, "label": "Accepted. Location generated", "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": "057e7c31-d934-46b9-b82b-d27ecf227a9c", "body": "{\n \"Message\": \"Unauthorized Request\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e7d35b7b-018e-4fcd-ad39-abbf2a3bda4e", "body": "{\n \"Message\": \"Invalid authentication credentials\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "17a33090-087f-4506-b6d4-d248f83185af", "body": "{\n \"errors\": [\n {\n \"detail\": \"DOC104 - Upload rejected by upstream system. Processing failed and upload must be resubmitted\",\n \"status\": \"422\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4a4e66ba-3cab-413a-af0f-449c8f55f3ae", "body": "{\n \"Message\": \"API rate limit exceeded\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a154cc33-9c5a-42d7-b20a-b789b23926bf", "body": "{\n \"code\": 500,\n \"detail\": \"Internal server error\",\n \"status\": 500,\n \"title\": \"Internal server error\"\n}", "latency": 0, "statusCode": 500, "label": "Internal server error", "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": "deceb14d-e0cd-4522-a564-7a07983ea8b7", "documentation": "Get a bulk status report for a list of previous uploads", "method": "post", "endpoint": "uploads/report", "responses": [ { "uuid": "de510cfd-3cc7-4cbf-9786-d9cb31377d5b", "body": "{\n \"data\": [\n {\n \"attributes\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"guid\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"message\": \"\",\n \"status\": \"{{oneOf (array 'pending' 'uploaded' 'received' 'processing' 'success' 'vbms' 'error')}}\",\n \"updated_at\": \"2018-07-30T17:31:15.958Z\",\n \"uploaded_pdf\": {\n \"content\": {\n \"attachments\": [\n {\n \"dimensions\": {\n \"height\": \"11.0\",\n \"oversized_pdf\": \"false\",\n \"width\": \"8.5\"\n },\n \"page_count\": \"2\"\n }\n ],\n \"dimensions\": {\n \"height\": \"11.0\",\n \"oversized_pdf\": \"false\",\n \"width\": \"8.5\"\n },\n \"page_count\": \"1\"\n },\n \"total_documents\": \"2\",\n \"total_pages\": \"3\"\n }\n },\n \"id\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"type\": \"document_upload\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Upload status report retrieved successfully", "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": "7c6b7c16-efea-4647-be7e-a5f657e1ffc3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request - invalid or missing list of guids", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "35752269-e723-4d3e-b2ea-c31d8d6e2457", "body": "{\n \"Message\": \"Unauthorized Request\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b157fae9-31e9-42c9-bc87-2d5a5acb9c05", "body": "{\n \"Message\": \"Invalid authentication credentials\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2aebb47a-5efa-45b3-b7d4-5fb09f681fc2", "body": "{\n \"errors\": [\n {\n \"detail\": \"DOC104 - Upload rejected by upstream system. Processing failed and upload must be resubmitted\",\n \"status\": \"422\"\n }\n ]\n}", "latency": 0, "statusCode": 422, "label": "Unprocessable Entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5c1351f5-60ef-4cb1-9c2a-580ba84d8ec6", "body": "{\n \"Message\": \"API rate limit exceeded\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "458dc89d-a67e-4b00-9b28-2d30d5d09a22", "body": "{\n \"code\": 500,\n \"detail\": \"Internal server error\",\n \"status\": 500,\n \"title\": \"Internal server error\"\n}", "latency": 0, "statusCode": 500, "label": "Internal server error", "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": "9fa35c2d-b0dc-443c-8559-3f6043fcdc77", "documentation": "Get status for a previous benefits document upload", "method": "get", "endpoint": "uploads/:id", "responses": [ { "uuid": "7cf26942-6fa4-404b-ac0c-c9c25dad0fbe", "body": "{\n \"data\": {\n \"attributes\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"guid\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"message\": \"\",\n \"status\": \"{{oneOf (array 'pending' 'uploaded' 'received' 'processing' 'success' 'vbms' 'error')}}\",\n \"updated_at\": \"2018-07-30T17:31:15.958Z\",\n \"uploaded_pdf\": {\n \"content\": {\n \"attachments\": [\n {\n \"dimensions\": {\n \"height\": \"11.0\",\n \"oversized_pdf\": \"false\",\n \"width\": \"8.5\"\n },\n \"page_count\": \"2\"\n }\n ],\n \"dimensions\": {\n \"height\": \"11.0\",\n \"oversized_pdf\": \"false\",\n \"width\": \"8.5\"\n },\n \"page_count\": \"1\"\n },\n \"total_documents\": \"2\",\n \"total_pages\": \"3\"\n }\n },\n \"id\": \"6d8433c1-cd55-4c24-affd-f592287a7572\",\n \"type\": \"document_upload\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Upload status retrieved successfully", "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": "edff3db1-378a-4a64-b42a-7b22ea963784", "body": "{\n \"Message\": \"Unauthorized Request\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "47c334af-2333-4ee7-a58e-e97893168fea", "body": "{\n \"Message\": \"Invalid authentication credentials\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7c40fc1e-a323-4584-8434-4bdbb810f9e2", "body": "{\n \"code\": 404,\n \"detail\": \"The record identified by {{ind}} could not be found\",\n \"status\": 404,\n \"title\": \"Record not found\"\n}", "latency": 0, "statusCode": 404, "label": "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": "99076f5a-ba8e-4ff4-b428-c5d6d7445a21", "body": "{\n \"Message\": \"API rate limit exceeded\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4c62fa94-2915-4123-b774-d17ab8a036f5", "body": "{\n \"code\": 500,\n \"detail\": \"Internal server error\",\n \"status\": 500,\n \"title\": \"Internal server error\"\n}", "latency": 0, "statusCode": 500, "label": "Internal server error", "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": "53b13a7c-0b54-42c3-9e0b-4e6327d7c1b3", "documentation": "Download zip of \"what the server sees\"", "method": "get", "endpoint": "uploads/:id/download", "responses": [ { "uuid": "77977ab4-c479-4ab9-a866-2eb1ca94621a", "body": "", "latency": 0, "statusCode": 200, "label": "Zip file with the contents of your payload as parsed by our server", "headers": [{ "key": "Content-Type", "value": "application/zip" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f990b515-0925-43ce-816e-8f7b4896f43c", "body": "{\n \"Message\": \"Unauthorized Request\"\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d0e3aa7e-da1d-4a12-88ce-1b2d394d10a9", "body": "{\n \"Message\": \"Invalid authentication credentials\"\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4f86dfe3-b330-4571-8e35-03671574bb2c", "body": "{\n \"code\": 404,\n \"detail\": \"The record identified by {{ind}} could not be found\",\n \"status\": 404,\n \"title\": \"Record not found\"\n}", "latency": 0, "statusCode": 404, "label": "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": "02c79b79-a8ca-428e-a5fb-74e9888693f5", "body": "{\n \"Message\": \"API rate limit exceeded\"\n}", "latency": 0, "statusCode": 429, "label": "Too many requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef83be80-4056-4cec-8c03-68a7e5e2b979", "body": "{\n \"code\": 500,\n \"detail\": \"Internal server error\",\n \"status\": 500,\n \"title\": \"Internal server error\"\n}", "latency": 0, "statusCode": 500, "label": "Internal server error", "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": "65b27cc9-7d5f-442d-9d16-cb9ed0100bf3" }, { "type": "route", "uuid": "739b8d02-e17e-4da7-9a96-8e3d95a6ea52" }, { "type": "route", "uuid": "deceb14d-e0cd-4522-a564-7a07983ea8b7" }, { "type": "route", "uuid": "9fa35c2d-b0dc-443c-8559-3f6043fcdc77" }, { "type": "route", "uuid": "53b13a7c-0b54-42c3-9e0b-4e6327d7c1b3" } ] }