{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.smartwaiver.com" } ], "info": { "name": "Smartwaiver API Docs", "_postman_id": "f1e1d350-2918-4d30-86d3-821c9b123973", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Api Info", "description": "", "item": [ { "name": "Ping", "request": { "url": { "host": "{{baseUrl}}", "path": "ping", "query": [], "raw": "{{baseUrl}}\/ping" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Ping\/Pong Test", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "content-type", "value": "text\/html; charset=UTF-8" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "x-ratelimit-limit", "value": "600" }, { "key": "x-ratelimit-remaining", "value": "599" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "pong", "name": "" } ] }, { "name": "Version\nApi Version Information", "request": { "url": { "host": "{{baseUrl}}", "path": "version", "query": [], "raw": "{{baseUrl}}\/version" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "content-type", "value": "text\/html; charset=UTF-8" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "x-ratelimit-limit", "value": "600" }, { "key": "x-ratelimit-remaining", "value": "598" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 200, "body": "5.0.0", "name": "" } ] } ] }, { "name": "Checkins", "description": "", "item": [ { "name": "List checkins for waivers\nList checkins for waivers", "request": { "url": { "host": "{{baseUrl}}", "path": "v4\/checkins", "query": [ { "key": "checkinId", "value": "", "description": "The specific checkin record you would like to get data from.", "disabled": true }, { "key": "waiverId", "value": "", "description": "The specific waiver you would like to get data from. A waiver can have multiple checkins if it has multiple signers", "disabled": true }, { "key": "fromDts", "value": "2018-01-01", "description": "Limit to checkins after this ISO 8601 date (Must not be within the current hour) (If not provided time will default to 00:00:00). Allowed values: Must be in ISO 8601 format", "disabled": false }, { "key": "toDts", "value": "2018-01-02", "description": "End date of checkin report (must be before current hour) (ISO in UTC)", "disabled": false }, { "key": "limit", "value": "", "description": "Limit to this number of checkins. Default value: 20 Allowed values: 1-100", "disabled": true }, { "key": "offset", "value": "", "description": "Offset to be combined with limit to page results. Default value: 0 Allowed values 0-1000", "disabled": true } ], "raw": "{{baseUrl}}\/v4\/checkins?checkinId=&waiverId=&fromDts=2018-01-01&toDts=2018-01-02&limit=&offset=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"version\": 4,\n \"id\": \"a0256461ca244278b412ab3238f5efd2\",\n \"ts\": \"2024-05-20T20:09:53+00:00\",\n \"type\": \"checkins\",\n \"checkins\": {\n \"fromDts\": \"2018-01-01\",\n \"toDts\": \"2018-01-02\",\n \"moreCheckins\": false,\n \"checkins\": [\n {\n \"checkinId\": 12345,\n \"date\": \"2018-01-01 12:32:16\",\n \"waiverId\": \"56461ca244278b412ab3\",\n \"position\": 0,\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"isMinor\": false,\n \"dateSigned\": \"2018-01-02 12:32:16\"\n \"templateId\": 12345\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 400, "body": "{\n \"version\": 4,\n \"id\": \"a0256461ca244278b412ab3238f5efd2\",\n \"ts\": \"2024-05-17T12:00:33+00:00\",\n \"type\": \"parameter_error\",\n \"message\": \"Parameter is not supported\"\n}\n", "name": "Parameter Error" }, { "header": [], "code": 402, "body": "{\n \"version\": 4,\n \"id\": \"a0256461ca244278b412ab3238f5efd2\",\n \"ts\": \"2024-05-17T12:00:33+00:00\",\n \"type\": \"data_error\",\n \"message\": \"Message explaining the invalid data entered\"\n}\n", "name": "Data Error" } ] } ] }, { "name": "Dynamic Waivers", "description": "", "item": [ { "name": "Create a dynamic template for your customer to fill out", "request": { "url": { "host": "{{baseUrl}}", "path": "v4\/dynamic\/templates", "query": [], "raw": "{{baseUrl}}\/v4\/dynamic\/templates" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"dynamic\":null,\"template\":null,\"data\":null}" }, "description": "Use this route to create a dynamic template for your customer to sign. This route is very similar to the functionality provided in our JS library here. We recommend using the JS library to create your dynamic templates.\n### Need your Smartwaiver Published Key?\nCreate Your Published Key<\/a>\nYour published key is a token that publicly identifies your account.\nTHIS IS NOT YOUR API KEY.\nNever publish your API Key to your website.\n\n### Versions\n\n- Smartwaiver JS 1.0.0 minified<\/a>\n\n### Example Usage\n\nIt's easy to get started!\nJust simply add our Javscript library to your page and then you can use the Smartwaiver object.\n\n```\n