{ "uuid": "fe3c68a3-7226-430d-acd2-5412f37a48b5", "lastMigration": 29, "name": "Treaties API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "983851c9-a8c2-4c55-b7f8-e49aebedbff9", "documentation": "Returns the business item for the given ID.", "method": "get", "endpoint": "api/BusinessItem/:id", "responses": [ { "uuid": "1200f20f-8798-4f8f-be3f-d5c08aa0e68f", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"houses\": [\n {\n \"house\": \"{{oneOf (array 'Commons' 'Lords')}}\",\n \"name\": \"\"\n }\n ],\n \"id\": \"\",\n \"itemDate\": \"{{faker 'date.recent' 365}}\",\n \"link\": \"\",\n \"sequence\": {{faker 'number.int' max=99999}},\n \"stepName\": \"\",\n \"treatyId\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested business item", "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": "c35f14ed-f556-48c1-befe-d77321cd3d8a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad 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": "95aeefad-3aa5-4e12-9701-ece5bd69bc07", "body": "", "latency": 0, "statusCode": 404, "label": "If the item doesn't exist", "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": "ee2ba926-2c62-4517-b952-f243d98ad3a7", "documentation": "Returns all government organisations.", "method": "get", "endpoint": "api/GovernmentOrganisation", "responses": [ { "uuid": "c1d40e24-1daa-41c7-a964-b0827ba4fbf5", "body": "{\n \"items\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n }\n }\n ],\n \"itemsPerPage\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"totalResults\": {{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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5d1c14cb-9526-47e3-8ca1-2c11dc9a9143", "documentation": "Returns all series memberships.", "method": "get", "endpoint": "api/SeriesMembership", "responses": [ { "uuid": "05b51077-9ec6-4988-8f70-e6d9375fb7cd", "body": "{\n \"items\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"description\": \"\",\n \"id\": {{faker 'number.int' max=99999}}\n }\n }\n ],\n \"itemsPerPage\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"totalResults\": {{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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "57212961-78c6-4da8-baf4-32e6ae237df8", "documentation": "Returns a list of treaties.", "method": "get", "endpoint": "api/Treaty", "responses": [ { "uuid": "dfe07858-f211-4a27-a6b3-015d0972c2f9", "body": "{\n \"items\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"commandPaperNumber\": {{faker 'number.int' max=99999}},\n \"commandPaperPrefix\": \"\",\n \"commonsLayingDate\": \"{{faker 'date.recent' 365}}\",\n \"debateScheduled\": \"{{oneOf (array 'Chamber' 'DelegatedLegislationCommittee' 'None')}}\",\n \"id\": \"\",\n \"layingBodyDepartment\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n },\n \"leadDepartment\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n },\n \"lordsLayingDate\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"parliamentaryConclusion\": \"{{oneOf (array 'NotConcluded' 'CanRatify' 'CantRatify')}}\",\n \"treatySeriesMembership\": {\n \"citation\": \"\",\n \"seriesMembershipType\": \"{{oneOf (array 'CountrySeriesMembership' 'EuropeanUnionSeriesMembership' 'MiscellaneousSeriesMembership')}}\",\n \"uri\": \"\"\n },\n \"uri\": \"\",\n \"webLink\": \"\"\n }\n }\n ],\n \"itemsPerPage\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"totalResults\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "A list of treaties", "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": "f402e027-9c6e-4236-bdad-e867fc99ab48", "body": "", "latency": 0, "statusCode": 400, "label": "Bad 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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "14c0adf6-9cee-4ef0-b8ff-2ca9548cd559", "documentation": "Returns a treaty by ID.", "method": "get", "endpoint": "api/Treaty/:id", "responses": [ { "uuid": "8da6ab3c-2db6-47c5-b637-f411abb7d54e", "body": "{\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"commandPaperNumber\": {{faker 'number.int' max=99999}},\n \"commandPaperPrefix\": \"\",\n \"commonsLayingDate\": \"{{faker 'date.recent' 365}}\",\n \"debateScheduled\": \"{{oneOf (array 'Chamber' 'DelegatedLegislationCommittee' 'None')}}\",\n \"id\": \"\",\n \"layingBodyDepartment\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n },\n \"leadDepartment\": {\n \"id\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n },\n \"lordsLayingDate\": \"{{faker 'date.recent' 365}}\",\n \"name\": \"\",\n \"parliamentaryConclusion\": \"{{oneOf (array 'NotConcluded' 'CanRatify' 'CantRatify')}}\",\n \"treatySeriesMembership\": {\n \"citation\": \"\",\n \"seriesMembershipType\": \"{{oneOf (array 'CountrySeriesMembership' 'EuropeanUnionSeriesMembership' 'MiscellaneousSeriesMembership')}}\",\n \"uri\": \"\"\n },\n \"uri\": \"\",\n \"webLink\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Details of the requested treaty", "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": "d903e185-de9d-41e5-86ac-39f2521bc5e8", "body": "", "latency": 0, "statusCode": 400, "label": "Bad 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": "5b978bf6-28e1-43f3-9717-f82e2fc9aa8b", "body": "", "latency": 0, "statusCode": 404, "label": "If the treaty can't be 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": "4550925b-8fbc-43f5-8ce7-efd79af5e3d5", "documentation": "Returns business items belonging to the treaty with ID.", "method": "get", "endpoint": "api/Treaty/:id/BusinessItems", "responses": [ { "uuid": "39dca8af-be32-4555-a394-4f86f7bc577f", "body": "{\n \"items\": [\n {\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"value\": {\n \"houses\": [\n {\n \"house\": \"{{oneOf (array 'Commons' 'Lords')}}\",\n \"name\": \"\"\n }\n ],\n \"id\": \"\",\n \"itemDate\": \"{{faker 'date.recent' 365}}\",\n \"link\": \"\",\n \"sequence\": {{faker 'number.int' max=99999}},\n \"stepName\": \"\",\n \"treatyId\": \"\"\n }\n }\n ],\n \"itemsPerPage\": {{faker 'number.int' max=99999}},\n \"links\": [\n {\n \"href\": \"\",\n \"method\": \"\",\n \"rel\": \"\"\n }\n ],\n \"totalResults\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "The business items for the requested treaty", "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": "6e62e191-5847-4f94-a97b-ffbcb22262da", "body": "", "latency": 0, "statusCode": 400, "label": "Bad 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": "b4c51bb9-c439-498e-8111-f66c82f2d966", "body": "", "latency": 0, "statusCode": 404, "label": "If the treaty cannot be 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": "983851c9-a8c2-4c55-b7f8-e49aebedbff9" }, { "type": "route", "uuid": "ee2ba926-2c62-4517-b952-f243d98ad3a7" }, { "type": "route", "uuid": "5d1c14cb-9526-47e3-8ca1-2c11dc9a9143" }, { "type": "route", "uuid": "57212961-78c6-4da8-baf4-32e6ae237df8" }, { "type": "route", "uuid": "14c0adf6-9cee-4ef0-b8ff-2ca9548cd559" }, { "type": "route", "uuid": "4550925b-8fbc-43f5-8ce7-efd79af5e3d5" } ] }