{ "uuid": "7f2cd2df-9413-416f-8820-91f5e17886eb", "lastMigration": 19, "name": "Contribly", "endpointPrefix": "1", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "bd948f0d-730e-4702-9fe6-fcdc0c397a10", "documentation": "Artifact formats", "method": "get", "endpoint": "artifact-formats", "responses": [ { "uuid": "9383d06f-03dd-4bcb-9c75-10b84272d1ae", "body": "{\n \"contribution\": [\n {\n \"contentType\": \"\",\n \"fileExtension\": \"\",\n \"forContentType\": \"\",\n \"label\": \"\",\n \"preserveAspectRatio\": {{faker 'random.boolean'}},\n \"public\": {{faker 'random.boolean'}},\n \"upscaleAllowed\": {{faker 'random.boolean'}}\n }\n ],\n \"cover\": [\n {\n \"contentType\": \"\",\n \"fileExtension\": \"\",\n \"forContentType\": \"\",\n \"label\": \"\",\n \"preserveAspectRatio\": {{faker 'random.boolean'}},\n \"public\": {{faker 'random.boolean'}},\n \"upscaleAllowed\": {{faker 'random.boolean'}}\n }\n ],\n \"profileImage\": [\n {\n \"contentType\": \"\",\n \"fileExtension\": \"\",\n \"forContentType\": \"\",\n \"label\": \"\",\n \"preserveAspectRatio\": {{faker 'random.boolean'}},\n \"public\": {{faker 'random.boolean'}},\n \"upscaleAllowed\": {{faker 'random.boolean'}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "A list of artifact formats", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "dc4569f3-be43-4345-bb91-337895e60628", "documentation": "List assignments", "method": "get", "endpoint": "assignments", "responses": [ { "uuid": "9bf05b76-2376-4a09-9beb-6f7cf7b56cc3", "body": "[\n {\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of assignments", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "45fdc8f2-f4ce-483d-b8f4-7c2d4a044d9b", "documentation": "Create a new assignment", "method": "post", "endpoint": "assignments", "responses": [ { "uuid": "acb13e46-90a1-4b6e-977b-e91a80e77ec1", "body": "{\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Assignment created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "8cdc102c-5c7c-4635-bf87-74e6a5feaaf5", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The new assignment vailed to validate. Check the response body for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "80f0daac-4737-42c4-9350-8eccfcc991de", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Failed to create the new assignment due to an unexpected error.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "2c6b90f3-e435-46af-92f3-226874b2643f", "documentation": "Delete this assignment and all of it's contributions", "method": "delete", "endpoint": "assignments/:id", "responses": [ { "uuid": "57da868e-7eb2-42f5-ada0-ec102bca5379", "body": "", "latency": 0, "statusCode": 200, "label": "Assignment deleted", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "41c7fd85-aaa8-4c30-a3c4-b363492391c8", "body": "", "latency": 0, "statusCode": 403, "label": "Not permitted to delete this assignment.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bc2b0f19-ed6b-42b6-9deb-260da6a3bdb1", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e183bcc2-f19c-4550-b09d-61eafad90fff", "documentation": "Get a single assigment by id", "method": "get", "endpoint": "assignments/:id", "responses": [ { "uuid": "5104c2f5-e507-4cf5-842b-179e5538914f", "body": "{\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Assignment found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "fe3a0061-553b-4090-b97d-7b69d6626fce", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "02cf3482-504e-4e0c-aa1d-468058ef9737", "documentation": "Recent changes", "method": "get", "endpoint": "change-log", "responses": [ { "uuid": "3cba11c3-8cce-4f36-b857-de96c2dbe3cf", "body": "[\n {\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"title\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of change log items", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "de3345c4-ede4-4611-a3af-7b84a5cfb155", "documentation": "List valid contribution refinement types", "method": "get", "endpoint": "contribution-refinement-types", "responses": [ { "uuid": "ea5959a1-4a54-43d3-8e95-9e6a1e47f7ad", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "An array of refinement types. These are the possible values of the get contribution refinements parameter.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "35b54cf4-4dc5-4bbb-bad2-2b5bb7080e5b", "documentation": "List contribution refinement options", "method": "get", "endpoint": "contribution-refinements", "responses": [ { "uuid": "7b0a3d18-6d28-450b-aaa5-9356187869a5", "body": "{}", "latency": 0, "statusCode": 200, "label": "A map of refinement names to lists of options", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ee6b4613-5a11-480a-93f4-c1dfaf27685d", "documentation": "List contributions", "method": "get", "endpoint": "contributions", "responses": [ { "uuid": "3b271b11-c3a0-43c9-b1ad-2226368873ea", "body": "[\n {\n \"assignment\": {\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n },\n \"attribution\": \"\",\n \"body\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"headline\": \"\",\n \"id\": \"\",\n \"mediaUsages\": [\n {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n }\n ],\n \"moderationHistory\": [\n {\n \"action\": {\n \"id\": \"\",\n \"label\": \"\",\n \"resultingState\": {\n \"id\": \"\",\n \"label\": \"\",\n \"public\": {{faker 'random.boolean'}}\n }\n },\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"notes\": \"\"\n }\n ],\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"urlWords\": \"\",\n \"via\": {\n \"authority\": {\n \"client\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"user\": {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n },\n \"ipAddress\": \"\",\n \"ipAddressPlace\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n }\n }\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of contributions", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "406c3c7e-a3e9-4aa1-ba94-b81c202100aa", "documentation": "Create a new contribution", "method": "post", "endpoint": "contributions", "responses": [ { "uuid": "cb6b4364-34eb-4464-bfc3-785cd165a271", "body": "{\n \"assignment\": {\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n },\n \"attribution\": \"\",\n \"body\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"headline\": \"\",\n \"id\": \"\",\n \"mediaUsages\": [\n {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n }\n ],\n \"moderationHistory\": [\n {\n \"action\": {\n \"id\": \"\",\n \"label\": \"\",\n \"resultingState\": {\n \"id\": \"\",\n \"label\": \"\",\n \"public\": {{faker 'random.boolean'}}\n }\n },\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"notes\": \"\"\n }\n ],\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"urlWords\": \"\",\n \"via\": {\n \"authority\": {\n \"client\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"user\": {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n },\n \"ipAddress\": \"\",\n \"ipAddressPlace\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Contribution created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "1750dd41-0e57-4ba0-ae87-c37f5879b6f4", "documentation": "Delete this contribution", "method": "delete", "endpoint": "contributions/:id", "responses": [ { "uuid": "2fadb17d-e92f-49b6-9e7b-64a4a0948e62", "body": "{\n \"assignment\": {\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n },\n \"attribution\": \"\",\n \"body\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"headline\": \"\",\n \"id\": \"\",\n \"mediaUsages\": [\n {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n }\n ],\n \"moderationHistory\": [\n {\n \"action\": {\n \"id\": \"\",\n \"label\": \"\",\n \"resultingState\": {\n \"id\": \"\",\n \"label\": \"\",\n \"public\": {{faker 'random.boolean'}}\n }\n },\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"notes\": \"\"\n }\n ],\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"urlWords\": \"\",\n \"via\": {\n \"authority\": {\n \"client\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"user\": {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n },\n \"ipAddress\": \"\",\n \"ipAddressPlace\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "The deletion request has been accepted and will be processed in the background.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "24ef9356-662d-4273-8987-62bcc9ffdc13", "body": "", "latency": 0, "statusCode": 403, "label": "The currently authorised user is not allowed to delete this contribution.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "1f933bc0-ce61-4141-81bd-05e1f24b87b7", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a5ad2e0b-81b8-43c4-9cb1-01a25bd6a032", "documentation": "Get a single contribution by id", "method": "get", "endpoint": "contributions/:id", "responses": [ { "uuid": "a1f703b4-029d-44df-9396-c1e89f9e09d2", "body": "{\n \"assignment\": {\n \"allowsAnonymousContributions\": {{faker 'random.boolean'}},\n \"callToAction\": \"\",\n \"cover\": {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n },\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"description\": \"\",\n \"embargo\": \"{{faker 'date.recent' 365}}\",\n \"ends\": \"{{faker 'date.recent' 365}}\",\n \"featured\": {{faker 'random.boolean'}},\n \"id\": \"\",\n \"mediaRequired\": {{faker 'random.boolean'}},\n \"moderator\": \"\",\n \"name\": \"\",\n \"open\": {{faker 'random.boolean'}},\n \"receiptMessage\": \"\",\n \"starts\": \"{{faker 'date.recent' 365}}\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ],\n \"urlWords\": \"\",\n \"webUrl\": \"\"\n },\n \"attribution\": \"\",\n \"body\": \"\",\n \"created\": \"{{faker 'date.recent' 365}}\",\n \"headline\": \"\",\n \"id\": \"\",\n \"mediaUsages\": [\n {\n \"artifacts\": [\n {\n \"contentLength\": {{faker 'random.number'}},\n \"contentType\": \"\",\n \"height\": {{faker 'random.number'}},\n \"label\": \"\",\n \"url\": \"\",\n \"width\": {{faker 'random.number'}}\n }\n ],\n \"id\": \"\",\n \"media\": {\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n }\n }\n ],\n \"moderationHistory\": [\n {\n \"action\": {\n \"id\": \"\",\n \"label\": \"\",\n \"resultingState\": {\n \"id\": \"\",\n \"label\": \"\",\n \"public\": {{faker 'random.boolean'}}\n }\n },\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"notes\": \"\"\n }\n ],\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"urlWords\": \"\",\n \"via\": {\n \"authority\": {\n \"client\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"user\": {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n },\n \"ipAddress\": \"\",\n \"ipAddressPlace\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e8105289-1e8d-49cd-a790-7b8488b4ac8f", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6c071894-daaa-4285-becb-55369965ab72", "documentation": "Raise a flag against this contribution", "method": "post", "endpoint": "contributions/:id/flag", "responses": [ { "uuid": "70ea6647-383d-40e4-8bc2-33432f586e08", "body": "{\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"email\": \"\",\n \"id\": \"\",\n \"notes\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Flag created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "489bb983-84fe-4240-9366-f35c90eb2a9a", "documentation": "Allows a user to mark a contribution as liked", "method": "post", "endpoint": "contributions/:id/like", "responses": [ { "uuid": "95cb1327-afd8-4b27-a8e2-5533a35ea7a6", "body": "{{faker 'random.number'}}", "latency": 0, "statusCode": 200, "label": "The updated like count for this contribution.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "b838b863-1eb9-48b2-9b6f-230534f6e6ce", "documentation": "List users who have liked this contributions", "method": "get", "endpoint": "contributions/:id/likes", "responses": [ { "uuid": "c134de76-aff8-47d3-87a9-6e8b67611fbc", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "A list of user ids.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0f8189ae-2caf-4bc9-98b0-0b8bbb639732", "documentation": "Perform a moderation action on this contribution", "method": "post", "endpoint": "contributions/:id/moderate", "responses": [ { "uuid": "561e7195-a609-4d38-904c-99c28d1cb296", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "The moderation action was successfully applied", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "ce3d30d3-3aed-4e06-a971-b7452d319987", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The submission falied to validate. Check the response body for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4ee224cb-e689-4ee4-a232-4dd3d90a804a", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 401, "label": "The request was not correctly authorised.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "e46e9d0e-17e8-4a97-8fd0-b2fab1185618", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 403, "label": "You do not have permission to perform this moderation action.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "38e886fb-338f-4244-8154-286e917349b2", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "An unexpected error occurred.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7fd8e506-8b72-4c24-93f8-f696bb5ba2e8", "documentation": "List the credentials associated with the authenticated user.", "method": "get", "endpoint": "credentials", "responses": [ { "uuid": "9ea436ae-e9df-46f2-910f-5cf9dd857dfa", "body": "[\n {\n \"scopes\": [\n \"\"\n ],\n \"type\": \"\",\n \"user\": \"\",\n \"value\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of credentials associated with this user.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "51c811e0-1a8b-4eaa-99c4-6628a467e196", "body": "", "latency": 0, "statusCode": 401, "label": "Not authorised", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "6625d2f1-e7f7-472f-b6bc-633433e3a480", "documentation": "Event types", "method": "get", "endpoint": "event-types", "responses": [ { "uuid": "0d3b0ee4-f29f-42c4-88fc-32567a4e52c3", "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of event types", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "a6fdef4f-7292-4e88-9a7d-52fa9fc26faa", "documentation": "Export contributions.", "method": "post", "endpoint": "export", "responses": [ { "uuid": "a1cc5795-99a1-424b-91f8-d3cc025a8152", "body": "{\n \"downloadUrl\": \"\",\n \"finished\": \"{{faker 'date.recent' 365}}\",\n \"id\": \"\",\n \"owner\": \"\",\n \"progress\": {{faker 'random.number'}},\n \"started\": \"{{faker 'date.recent' 365}}\",\n \"step\": \"\"\n}", "latency": 0, "statusCode": 202, "label": "An export job describing the state of an export job.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "97d7b19f-3fe0-4b79-9954-b7b9e1a582ec", "documentation": "Export contributions preflight summary.", "method": "post", "endpoint": "export-summary", "responses": [ { "uuid": "2840e39a-6ead-4668-8afa-017c68750dde", "body": "{\n \"contributions\": {{faker 'random.number'}},\n \"estimatedSize\": \"\",\n \"media\": {{faker 'random.number'}},\n \"totalMediaSize\": {{faker 'random.number'}}\n}", "latency": 0, "statusCode": 200, "label": "A summary of the number of contributions, media files and approximate total size of media files.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e18b6609-f776-4b0c-bea9-43adaab47e5c", "documentation": "Get a single export job; poll to follow export progress.", "method": "get", "endpoint": "exports/:id", "responses": [ { "uuid": "1c41cfbc-8472-449c-9900-10c076224195", "body": "{\n \"downloadUrl\": \"\",\n \"finished\": \"{{faker 'date.recent' 365}}\",\n \"id\": \"\",\n \"owner\": \"\",\n \"progress\": {{faker 'random.number'}},\n \"started\": \"{{faker 'date.recent' 365}}\",\n \"step\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "4635dde2-815b-4e96-8e07-994a0f3b9e5c", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "bc8a927e-1982-4520-af0e-323461fe9943", "documentation": "List form responses", "method": "get", "endpoint": "form-responses", "responses": [ { "uuid": "f8053a58-a1a3-4214-8528-b67861a62d73", "body": "[\n {\n \"contribution\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"form\": \"\",\n \"id\": \"\",\n \"responses\": {},\n \"user\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of form responses", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "ed520249-714a-406a-94e7-f45291f67e3f", "documentation": "Submit a response to a form", "method": "post", "endpoint": "form-responses", "responses": [ { "uuid": "3a164cd9-f623-4002-939e-2fc0d9e82275", "body": "{\n \"contribution\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"form\": \"\",\n \"id\": \"\",\n \"responses\": {},\n \"user\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Form response saved", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "3215433d-b682-44ed-bf6c-bfe04dd3a0c3", "documentation": "Get a single form response by id", "method": "get", "endpoint": "form-responses/:id", "responses": [ { "uuid": "195e5997-434a-4163-916e-83d50b53859a", "body": "{\n \"contribution\": \"\",\n \"date\": \"{{faker 'date.recent' 365}}\",\n \"form\": \"\",\n \"id\": \"\",\n \"responses\": {},\n \"user\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Form response found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "bbfebc4c-c48c-465b-8040-82ea7d375cdc", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "8cfa75a0-e2f3-440c-8bc3-bc63ccbb6b96", "documentation": "List forms", "method": "get", "endpoint": "forms", "responses": [ { "uuid": "7c59856c-3e0e-44c7-8d48-11c6e263de85", "body": "[\n {\n \"callToAction\": \"\",\n \"cssUrl\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"options\": [\n \"\"\n ],\n \"public\": {{faker 'random.boolean'}},\n \"required\": {{faker 'random.boolean'}},\n \"type\": \"\"\n }\n ],\n \"heading\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"noCss\": {{faker 'random.boolean'}},\n \"ownedBy\": \"\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ]\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of forms", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "fd0ff04a-573b-430d-af2c-7e5f2bc76025", "documentation": "Create a form", "method": "post", "endpoint": "forms", "responses": [ { "uuid": "e0bcb824-bcf7-4e17-b6f9-931a5a54e72e", "body": "{\n \"callToAction\": \"\",\n \"cssUrl\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"options\": [\n \"\"\n ],\n \"public\": {{faker 'random.boolean'}},\n \"required\": {{faker 'random.boolean'}},\n \"type\": \"\"\n }\n ],\n \"heading\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"noCss\": {{faker 'random.boolean'}},\n \"ownedBy\": \"\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Form created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5e1d45ca-0531-4894-aeb8-c8cb80bc2085", "documentation": "Delete this form and all of it's responses.", "method": "delete", "endpoint": "forms/:id", "responses": [ { "uuid": "0e71ac55-5d22-4d04-8ca5-daa84996f478", "body": "", "latency": 0, "statusCode": 200, "label": "Form deleted", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "c9946cbf-b4ce-4e65-b5d6-0fc73dbf75d6", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "72184213-74ca-46d7-8219-16da0cfa0c4f", "documentation": "Get a single form by id", "method": "get", "endpoint": "forms/:id", "responses": [ { "uuid": "4b8235c8-30f6-4181-8b2b-72d230f9677d", "body": "{\n \"callToAction\": \"\",\n \"cssUrl\": \"\",\n \"fields\": [\n {\n \"description\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"options\": [\n \"\"\n ],\n \"public\": {{faker 'random.boolean'}},\n \"required\": {{faker 'random.boolean'}},\n \"type\": \"\"\n }\n ],\n \"heading\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"noCss\": {{faker 'random.boolean'}},\n \"ownedBy\": \"\",\n \"tags\": [\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Form found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "2dc3be12-66ea-426e-9cf5-0ccb311e13fc", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "48083c02-a719-4706-a930-35200d44548e", "documentation": "Submit a new media file", "method": "post", "endpoint": "media", "responses": [ { "uuid": "9953864c-bdad-43fc-8ecd-bde43a756bd3", "body": "{\n \"duration\": {{faker 'random.number'}},\n \"id\": \"\",\n \"place\": {\n \"country\": \"\",\n \"geohash\": \"\",\n \"google\": \"\",\n \"latLong\": {\n \"latitude\": {{faker 'random.float'}},\n \"longitude\": {{faker 'random.float'}}\n },\n \"name\": \"\",\n \"osm\": {\n \"osmId\": {{faker 'random.number'}},\n \"osmType\": \"\"\n }\n },\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Media created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "0b235d62-6567-401f-af0b-6e3a93e06140", "documentation": "", "method": "get", "endpoint": "notifications/contributions/:id/preview", "responses": [ { "uuid": "8b8d863c-b514-41b3-a0bc-e44f609db042", "body": "{\n \"email\": \"\",\n \"html\": \"\",\n \"subject\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Notification preview", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "803cfdd5-6e0b-49e9-ab08-8d16d1025352", "documentation": "Scopes", "method": "get", "endpoint": "scopes", "responses": [ { "uuid": "92dea545-bd58-4a21-bb88-135cd1084c25", "body": "[\n \"\"\n]", "latency": 0, "statusCode": 200, "label": "A list of scopes", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "01fcbdc6-cbd4-46c5-bb02-ea3cf355fca9", "documentation": "Subscription types", "method": "get", "endpoint": "subscription-types", "responses": [ { "uuid": "8f291543-54a1-4cf7-a086-09a46dc8fa3f", "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of subscription event types", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "34842962-92ea-4e81-9623-dcbde11cac37", "documentation": "List subscriptions for the authorised user.", "method": "get", "endpoint": "subscriptions", "responses": [ { "uuid": "0632ba0b-b1f8-4c36-a102-7ce3c37edf80", "body": "[\n {\n \"assignment\": \"\",\n \"email\": \"\",\n \"id\": \"\",\n \"includeBody\": {{faker 'random.boolean'}},\n \"includeThumbenail\": {{faker 'random.boolean'}},\n \"slackChannel\": \"\",\n \"token\": \"\",\n \"types\": [\n \"\"\n ],\n \"user\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of notification subscriptions", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "f51f9ace-6993-4436-8fec-c18ce93572a2", "documentation": "Delete a subscription.", "method": "delete", "endpoint": "subscriptions/:id", "responses": [ { "uuid": "0bb8ccf4-bbe2-45ee-856e-b8a3b295b57f", "body": "", "latency": 0, "statusCode": 200, "label": "The subscription has been successfully deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "599ae52d-b983-47be-b7fb-3c4c87a5b54a", "documentation": "List tags", "method": "get", "endpoint": "tags", "responses": [ { "uuid": "6b7ee579-9bcb-4f80-9ae8-585315ff6c35", "body": "[\n {\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of tags", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e2db5fac-dc30-4890-9aba-50f5c63e1035", "documentation": "Create a new tag", "method": "post", "endpoint": "tags", "responses": [ { "uuid": "4221d902-45e5-4a28-b3bd-fe733b22b9ba", "body": "{\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Tag created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "11def324-8f7c-42c7-9c8d-2b250039b71b", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 400, "label": "The new tag submission failed to validate. Check the response body for details.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "17a5b4c2-440d-4e61-a152-4095cf3de236", "body": "{\n \"fields\": [\n {\n \"message\": \"\",\n \"name\": \"\"\n }\n ],\n \"message\": \"\"\n}", "latency": 0, "statusCode": 500, "label": "Failed to create the new tag due to an unexcepted error.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "11cd82c4-0b2c-48de-a938-e45c6285e415", "documentation": "Retrieve a single tag by id", "method": "get", "endpoint": "tags/:id", "responses": [ { "uuid": "19339b26-a161-4410-9b97-b82438ec420e", "body": "{\n \"colour\": \"#0061a6\",\n \"id\": \"\",\n \"name\": \"\",\n \"tagSet\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"urlWords\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The tag", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "d678e932-0fde-4fff-8502-6b25b15938ed", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "23976962-b211-4773-aa2f-aa9028867c7e", "documentation": "List tag sets", "method": "get", "endpoint": "tagsets", "responses": [ { "uuid": "cbb0a6b6-e50b-4b02-b32a-d6cfb8c94350", "body": "[\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of tag sets", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "c2b8efb9-09b2-480b-9b2b-8eae89b6c21e", "documentation": "Create a new tag set", "method": "post", "endpoint": "tagsets", "responses": [ { "uuid": "37283cbf-53c8-4ef5-bef3-2a6eb4aca3fe", "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Tagset created", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "4e89dc7a-6151-489e-acb9-ed8619dc360e", "documentation": "Retrieve a single tag set by id", "method": "get", "endpoint": "tagsets/:id", "responses": [ { "uuid": "631799b0-47fd-4c23-bfc3-3aed1d26c652", "body": "{\n \"id\": \"\",\n \"name\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "The tag set", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "34e3ad59-1fe4-4253-a05d-b99c7c6e1fa5", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "e22b600f-4117-4e85-9a1d-c310de2aef47", "documentation": "List users", "method": "get", "endpoint": "users", "responses": [ { "uuid": "adedafcf-605e-4246-819e-3bc426853734", "body": "[\n {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "A list of users", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-total-count", "value": "" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "5045f20c-a421-499c-8b38-e20c1ff44398", "documentation": "Retrieve a single user by id", "method": "get", "endpoint": "users/:id", "responses": [ { "uuid": "605f2ca4-e7b0-4c82-93fc-c6f497eeceee", "body": "{\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "f8a76b68-e508-40bd-b573-fac315775cf7", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "7663b1e0-5a5f-4b69-badf-225955e22680", "documentation": "Retrieve a users linked profile by type", "method": "get", "endpoint": "users/:id/linked/:type", "responses": [ { "uuid": "5c23d56d-c0d4-41da-8a1a-dafbc5e9d014", "body": "{\n \"bio\": \"\",\n \"email\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"picture\": \"\",\n \"profile\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false }, { "uuid": "266dd5cc-3f99-4dc9-957f-9ee84e621743", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false }, { "uuid": "be3ff48f-35ea-4ba7-845b-bfa7e1441397", "documentation": "Verify token and return details of the owning user", "method": "post", "endpoint": "verify", "responses": [ { "uuid": "466544fc-054a-484e-bc34-b4348daa4269", "body": "{\n \"client\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"id\": \"\",\n \"user\": {\n \"bio\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"registered\": \"{{faker 'date.recent' 365}}\",\n \"username\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Token is valid", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "filePath": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false } ], "enabled": true, "randomResponse": false, "sequentialResponse": false } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ] }