{ "uuid": "07e241a4-7881-41ae-8954-224dcead10e5", "lastMigration": 29, "name": "DigitalNZ API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "1b5b1498-fc82-4acd-9c4d-16bdaa275410", "documentation": "Run queries against DigitalNZ metadata search service.", "method": "get", "endpoint": "records.:format", "responses": [ { "uuid": "7820ea64-ce3b-4f14-9d61-22796b8adbac", "body": "{\n \"facets\": {\n \"display_collection\": {\n \"Canterbury Museum\": 39109,\n \"Figure.NZ\": 40185,\n \"Napier Public Libraries\": 39343\n },\n \"year\": {\n \"1997\": 4,\n \"1998\": 10,\n \"1999\": 16\n }\n },\n \"page\": 3,\n \"per_page\": 20,\n \"records\": [\n {\n \"category\": [\n \"{{oneOf (array 'Newspapers' 'Images' 'Books' 'Articles' 'Journals' 'Archives' 'Audio' 'Other' 'Manuscripts' 'Reference sources' 'Research papers' 'Videos' 'Music Score' 'Groups' 'Data' 'Websites' 'Sets')}}\"\n ],\n \"collection\": [\n \"\"\n ],\n \"collection_title\": [\n \"\"\n ],\n \"content_partner\": [\n \"\"\n ],\n \"copyright\": [\n \"{{oneOf (array 'All rights reserved' 'Some rights reserved' 'No known copyright restrictions' 'Unknown')}}\"\n ],\n \"created_at\": \"2012-04-21T05:32:02.000+13:00\",\n \"creator\": [\n \"\"\n ],\n \"date\": \"1996-01-01T00:00:00.000Z\",\n \"dc_identifier\": [\n \"\"\n ],\n \"description\": \"\",\n \"display_collection\": \"\",\n \"display_content_partner\": \"\",\n \"display_date\": \"Circa 1996\",\n \"id\": 1788754,\n \"landing_url\": \"\",\n \"large_thumbnail_url\": \"\",\n \"locations\": [\n {\n \"comment\": \"Location provided by the Alexander Turnbull Library\",\n \"lat\": -37.508219086,\n \"lng\": 177.1802173,\n \"placename\": \"White Island\"\n }\n ],\n \"primary_collection\": [\n \"\"\n ],\n \"rights\": \"\",\n \"rights_url\": [\n \"\"\n ],\n \"source_url\": \"https://api.digitalnz.org/records/1788754/source\",\n \"subject\": [\n \"\"\n ],\n \"thumbnail_url\": \"\",\n \"title\": \"Election night crowd, Wellington, 1931\",\n \"updated_at\": \"2020-12-06T01:36:37.359+13:00\",\n \"usage\": [\n \"{{oneOf (array 'All rights reserved' 'Share' 'Modify' 'Use commercially' 'Unknown')}}\"\n ]\n }\n ],\n \"request_url\": \"https://api.digitalnz.org/v3/records.json?api_key=********&per_page=10&facets_per_page=100&facets=category&text=Wainuiomata\",\n \"result_count\": 8190\n}", "latency": 0, "statusCode": 200, "label": "search results matching criteria", "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": "ab823cd3-df4e-4411-beb8-0bc878425980", "body": "{}", "latency": 0, "statusCode": 400, "label": "Incorrect field specified in the 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": "07ff8ff1-7048-4333-9c1f-891dc510e4d8", "body": "{}", "latency": 0, "statusCode": 403, "label": "API Key is missing or 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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a1098094-d74b-4e1d-b83e-4e4a6e71046e", "documentation": "View metadata associated with a single record.", "method": "get", "endpoint": "records/:record_id.json", "responses": [ { "uuid": "75677841-5f13-4fd7-9b12-42697dcf16bc", "body": "{\n \"category\": [\n \"{{oneOf (array 'Newspapers' 'Images' 'Books' 'Articles' 'Journals' 'Archives' 'Audio' 'Other' 'Manuscripts' 'Reference sources' 'Research papers' 'Videos' 'Music Score' 'Groups' 'Data' 'Websites' 'Sets')}}\"\n ],\n \"collection\": [\n \"\"\n ],\n \"collection_title\": [\n \"\"\n ],\n \"content_partner\": [\n \"\"\n ],\n \"copyright\": [\n \"{{oneOf (array 'All rights reserved' 'Some rights reserved' 'No known copyright restrictions' 'Unknown')}}\"\n ],\n \"created_at\": \"2012-04-21T05:32:02.000+13:00\",\n \"creator\": [\n \"\"\n ],\n \"date\": \"1996-01-01T00:00:00.000Z\",\n \"dc_identifier\": [\n \"\"\n ],\n \"description\": \"\",\n \"display_collection\": \"\",\n \"display_content_partner\": \"\",\n \"display_date\": \"Circa 1996\",\n \"id\": 1788754,\n \"landing_url\": \"\",\n \"large_thumbnail_url\": \"\",\n \"locations\": [\n {\n \"comment\": \"Location provided by the Alexander Turnbull Library\",\n \"lat\": -37.508219086,\n \"lng\": 177.1802173,\n \"placename\": \"White Island\"\n }\n ],\n \"primary_collection\": [\n \"\"\n ],\n \"rights\": \"\",\n \"rights_url\": [\n \"\"\n ],\n \"source_url\": \"https://api.digitalnz.org/records/1788754/source\",\n \"subject\": [\n \"\"\n ],\n \"thumbnail_url\": \"\",\n \"title\": \"Election night crowd, Wellington, 1931\",\n \"updated_at\": \"2020-12-06T01:36:37.359+13:00\",\n \"usage\": [\n \"{{oneOf (array 'All rights reserved' 'Share' 'Modify' 'Use commercially' 'Unknown')}}\"\n ]\n}", "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": "6005b870-32d9-48a8-9fcc-c784c71ef26e", "body": "{}", "latency": 0, "statusCode": 403, "label": "API Key is missing or 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": "cbacd2f9-2f27-4255-9ebd-7d760a354d99", "body": "{\n \"errors\": \"Record with ID *record_id* was not found\"\n}", "latency": 0, "statusCode": 404, "label": "Resource 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": "1b5b1498-fc82-4acd-9c4d-16bdaa275410" }, { "type": "route", "uuid": "a1098094-d74b-4e1d-b83e-4e4a6e71046e" } ] }