{"docs":{"name":"GdReportsApi","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/apipie/1.0","api_url":"/api","resources":{"auth_tokens":{"doc_url":"/apipie/1.0/auth_tokens","id":"auth_tokens","api_url":"/api","name":"Auth_tokens","short_description":"Authentication Tokens","full_description":"\n\u003cp\u003eAuthorization tokens are used to access all other resources in the api (with the exception of Api keys themselves). In order to access any of the authorization token end points you must include your api key as an HTTP_AUTHORIZATION header token. Failure to do so will result in a 401 unauthorized response code.\u003c/p\u003e\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apipie/1.0/auth_tokens/index","name":"index","apis":[{"api_url":"/auth_tokens","http_method":"GET","short_description":"Returns all AuthTokens both current and expired","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/auth_tokens/show","name":"show","apis":[{"api_url":"/auth_tokens/:value","http_method":"GET","short_description":"Return the authorization token resource","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /auth_tokens/sg25447a2d2f44a78f7ac13c1476ac22\n200\n{\n  \"authToken\": {\n    \"value\": \"auth_token_17\",\n    \"expiredAt\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/auth_tokens/create","name":"create","apis":[{"api_url":"/auth_tokens","http_method":"POST","short_description":"Create a new authorization token","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["POST /auth_tokens\n201\n{\n  \"authToken\": {\n    \"value\": \"ad25777a2d2f44a98f7bd53f1476ac34\",\n    \"expiredAt\": null\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/auth_tokens/destroy","name":"destroy","apis":[{"api_url":"/auth_tokens/:value","http_method":"DELETE","short_description":"Expire an authorization token","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["DELETE /auth_tokens/ad25777a2d2f44a98f7bd53f1476ac34\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"genetic_profiles":{"doc_url":"/apipie/1.0/genetic_profiles","id":"genetic_profiles","api_url":"/api","name":"Genetic_profiles","short_description":"Genetic Profiles","full_description":"\n\u003cp\u003eEach Genetic Profile created will result in a Genetic Report.\u003c/p\u003e\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apipie/1.0/genetic_profiles/create","name":"create","apis":[{"api_url":"/genetic_profiles","http_method":"POST","short_description":"Create a Genetic Profile with Genetic Data","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[{"name":"geneticReportTemplateId","full_name":"geneticReportTemplateId","description":"\n\u003cp\u003eThe type of report you would like generated\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"data","full_name":"data","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"type","full_name":"data[type]","description":"\n\u003cp\u003eThis value should be set to \u0026#39;GeneticData\u0026#39;\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"attributes","full_name":"data[attributes]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"dateOfBirth","full_name":"data[attributes][dateOfBirth]","description":"\n\u003cp\u003eDate of birth of person in the following format YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"gender","full_name":"data[attributes][gender]","description":"\n\u003cp\u003eGender of person \u0026#39;male\u0026#39; or \u0026#39;female\u0026#39;\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"heightFeet","full_name":"data[attributes][heightFeet]","description":"\n\u003cp\u003eNumber of feet tall person is\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"heightInches","full_name":"data[attributes][heightInches]","description":"\n\u003cp\u003eNumber of additional inches a person is\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"weightInLbs","full_name":"data[attributes][weightInLbs]","description":"\n\u003cp\u003eWeight in pounds of person\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"exerciseMins","full_name":"data[attributes][exerciseMins]","description":"\n\u003cp\u003eValid inputs yes1 or no1\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"strengthDays","full_name":"data[attributes][strengthDays]","description":"\n\u003cp\u003eValid inputs days0, days1-3, days4+\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"enduranceDays","full_name":"data[attributes][enduranceDays]","description":"\n\u003cp\u003eValid inputs days0, days1-3, days4+\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sourceId","full_name":"data[attributes][sourceId]","description":"\n\u003cp\u003eThe id associated with this profile in application of record\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"relationships","full_name":"data[relationships]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"geneticDatum","full_name":"data[relationships][geneticDatum]","description":"\n\u003cp\u003eAn array of hashes containing type, SNPs and Calls\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"returns":[],"examples":["POST /genetic_profiles\n{\n  \"data\": {\n    \"type\": \"GeneticProfile\",\n    \"attributes\": {\n      \"dateOfBirth\": \"1980-03-11\",\n      \"gender\": \"M\",\n      \"heightFeet\": 6,\n      \"heightInches\": 1,\n      \"weightInLbs\": 185,\n      \"exerciseMins\": \"yes1\",\n      \"strengthDays\": \"days4+\",\n      \"enduranceDays\": \"days1-3\",\n      \"sourceId\": \"my_sys_identifer_3\"\n    },\n    \"relationships\": {\n      \"geneticDatum\": [\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12345\",\n          \"call\": \"AT\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12346\",\n          \"call\": \"GA\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12347\",\n          \"call\": \"GA\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12348\",\n          \"call\": \"GA\"\n        }\n      ]\n    }\n  },\n  \"geneticReportTemplateId\": 319\n}\n201\n{\n  \"geneticProfile\": {\n    \"id\": 433,\n    \"dateOfBirth\": \"1980-03-11\",\n    \"gender\": \"M\",\n    \"heightFeet\": 6,\n    \"heightInches\": 1,\n    \"weightInLbs\": 185,\n    \"exerciseMins\": \"yes1\",\n    \"strengthDays\": \"days4+\",\n    \"enduranceDays\": \"days1-3\",\n    \"sourceId\": \"my_sys_identifer_3\",\n    \"geneticDatum\": [\n      {\n        \"snp\": \"rs12345\",\n        \"call\": \"AT\"\n      },\n      {\n        \"snp\": \"rs12346\",\n        \"call\": \"GA\"\n      },\n      {\n        \"snp\": \"rs12347\",\n        \"call\": \"GA\"\n      },\n      {\n        \"snp\": \"rs12348\",\n        \"call\": \"GA\"\n      }\n    ],\n    \"geneticReportDetails\": []\n  }\n}","POST /genetic_profiles\n{\n  \"data\": {\n    \"type\": \"GeneticProfile\",\n    \"attributes\": {\n      \"dateOfBirth\": \"1980-03-11\",\n      \"gender\": \"M\",\n      \"heightFeet\": 6,\n      \"heightInches\": 1,\n      \"weightInLbs\": 185,\n      \"exerciseMins\": \"yes1\",\n      \"strengthDays\": \"days4+\",\n      \"enduranceDays\": \"days1-3\",\n      \"sourceId\": \"my_sys_identifer_3\"\n    },\n    \"relationships\": {\n      \"geneticDatum\": [\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12345\",\n          \"call\": \"AT\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12346\",\n          \"call\": \"GA\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12347\",\n          \"call\": \"GA\"\n        },\n        {\n          \"type\": \"GeneticData\",\n          \"location\": \"rs12348\",\n          \"call\": \"GA\"\n        }\n      ]\n    }\n  },\n  \"geneticReportTemplateId\": 50\n}\n422\n{\n  \"geneticReportTemplateId\": [\n    \"is not valid\"\n  ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/apipie/1.0/genetic_profiles/show","name":"show","apis":[{"api_url":"/genetic_profiles/:id","http_method":"GET","short_description":"GET a Genetic Profile","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /genetic_profiles/433\n200\n{\n  \"geneticProfile\": {\n    \"id\": 433,\n    \"dateOfBirth\": \"1980-03-11\",\n    \"gender\": \"M\",\n    \"heightFeet\": 6,\n    \"heightInches\": 1,\n    \"weightInLbs\": 185,\n    \"exerciseMins\": \"yes1\",\n    \"strengthDays\": \"days4+\",\n    \"enduranceDays\": \"days1-3\",\n    \"sourceId\": \"my_sys_identifer_3\",\n    \"geneticDatum\": [\n      {\n        \"snp\": \"rs12345\",\n        \"call\": \"AT\"\n      },\n      {\n        \"snp\": \"rs12346\",\n        \"call\": \"GA\"\n      },\n      {\n        \"snp\": \"rs12347\",\n        \"call\": \"GA\"\n      },\n      {\n        \"snp\": \"rs12348\",\n        \"call\": \"GA\"\n      }\n    ],\n    \"geneticReportDetails\": [\n      {\n        \"order\": 1,\n        \"sectionKey\": \"vitamin_b12_tendency\",\n        \"categoryKey\": \"nutrients\",\n        \"ratingKey\": \"low\"\n      },\n      {\n        \"order\": 2,\n        \"sectionKey\": \"protein_utilization\",\n        \"categoryKey\": \"nutrients\",\n        \"ratingKey\": \"slightly_enhanced\"\n      }\n    ]\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"organizations":{"doc_url":"/apipie/1.0/organizations","id":"organizations","api_url":"/api","name":"Organizations","short_description":"Organizations","full_description":"\n\u003cp\u003eOrganizations own api keys. Api keys are used to create authorization tokens. In order to access any of the api key end points you must include your api key as an HTTP_AUTHORIZATION header token. Failure to do so will result in a 401 unauthorized response code.\u003c/p\u003e\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/apipie/1.0/organizations/show","name":"show","apis":[{"api_url":"/organization","http_method":"GET","short_description":"Return the api key resource","deprecated":null}],"formats":["json"],"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /organization\n200\n{\n  \"organization\": {\n    \"name\": \"Test Organization\",\n    \"apiKey\": \"ad25777a2d2f44a98f7bd53f1476ac34\"\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}