Returns a filtered & ordered list of all plans defined for a clinic
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "required", "name": "filter[clinic_ids][]", "type": "array", "description": "", "schema": [], "itemType": "integer", "customType": "integer[]" }, { "kind": "optional", "name": "filter[name]", "type": "string", "description": "" }, { "kind": "optional", "name": "filter[status]", "type": "string", "description": "", "enum": [ "active", "inactive" ] }, { "kind": "optional", "name": "filter[is_public]", "type": "boolean", "description": "" }, { "kind": "optional", "name": "include", "type": "string", "description": "Include related resources: subscriptionsCount,activeSubscriptionsCount,benefits,benefits.benefitable,benefitsExclusions,printableFiles,taxRates
" }, { "kind": "optional", "name": "page", "type": "integer", "description": "", "default": 1 }, { "kind": "optional", "name": "per_page", "type": "integer", "description": "", "default": 10 }, { "kind": "optional", "name": "sort", "type": "string", "description": "Sort by a column. Possible values (comma separated): name, status, id, created_at, updated_at
", "default": "name" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1plans~1%7Bid%7D/put/responses/200/content/application~1json/schema/properties/data", "customType": "data[]", "schema": [] }, { "name": "links", "kind": "optional", "type": "array", "description": "", "example": "[{\"url\":null,\"label\":\"« Previous\",\"active\":false},{\"url\":\"https://digitail.test/api/v1/entities?page=1\",\"label\":\"1\",\"active\":true},{\"url\":\"https://digitail.test/api/v1/entities?page=2\",\"label\":\"Next »\",\"active\":true}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "url", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "« Previous" } ] }, { "name": "meta", "kind": "optional", "type": "object", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta", "customType": "meta", "schema": [] } ], "isExpanded": true } ] }, { "statusCode": "422", "description": "This response is sent when a request fails validation. The format is identical on all endpoints.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "message", "kind": "optional", "type": "string", "description": "", "example": "The name field is required. (and 1 more error)" }, { "name": "errors", "kind": "optional", "type": "object", "description": "", "example": "{\"name\":[\"The name field is required.\"],\"email\":[\"The email field is required.\",\"The email field must be a valid email address.\"]}", "schema": [ { "name": "field1", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "field2", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "2WwmAg7RxexIEZdpmk01P", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://developer.digitail.io/api/v1/plans?filter[clinic_ids][]=array&page=1&per_page=10&sort=name' \\\n --header 'accept: application/json'" }, { "id": "iDVsdQqt4zfcfuQzarJ5p", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/plans?filter[clinic_ids][]=array&page=1&per_page=10&sort=name\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WKGQI4Yz7NgiOPi91AxdI", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/plans?filter[clinic_ids][]=array&page=1&per_page=10&sort=name\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "oKIj7Ro3spUWjyC5-pqzI", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/plans?filter[clinic_ids][]=array&page=1&per_page=10&sort=name\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "2WwmAg7RxexIEZdpmk01P" }, "results": { "languages": [ { "id": "4fEXCFCpg3DdaLeb1vU7i", "language": "200", "code": "// successful operation\n{\n \"data\": [\n \"\"\n ],\n \"links\": [\n {\n \"url\": \"« Previous\"\n }\n ],\n \"meta\": {}\n}" }, { "id": "Ir_LNxZMV4ywcQjYP1u-Z", "language": "422", "code": "// This response is sent when a request fails validation. The format is identical on all endpoints.\n{\n \"message\": \"The name field is required. (and 1 more error)\",\n \"errors\": {\n \"field1\": [\n \"\"\n ],\n \"field2\": [\n \"\"\n ]\n }\n}" } ], "selectedLanguageId": "4fEXCFCpg3DdaLeb1vU7i" } }, "children": [ { "text": "" } ] }