{"items":[{"type":"link","label":"Devices API","link":"/reference/devices.v1","routeSlug":"/reference/devices.v1","content":{"contentType":"overview","meta":{"name":"Devices API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"devices.v1.json","url":"/_bundle/reference/devices.v1.json?download"},{"kind":"download","label":"devices.v1.yaml","url":"/_bundle/reference/devices.v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.tidepool.org/","url":"https://www.tidepool.org/"},{"kind":"email","title":"Tidepool","email":"support@tidepool.org","label":"support@tidepool.org","withCopyButton":true,"copyContent":"support@tidepool.org"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"BSD-2-Clause","url":"https://github.com/tidepool-org/devices/blob/master/LICENSE"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://developer.tidepool.org/terms-of-use"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Devices API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/quick-start"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"sectionId":"/reference/devices.v1"}],"sectionId":"/reference/devices.v1"}]}]}},{"type":"group","label":"Devices","link":"/reference/devices.v1/devices","routeSlug":"/reference/devices.v1/devices","items":[{"label":"List Pumps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/listpumps","routeSlug":"/reference/devices.v1/devices/listpumps","metadata":{"seo":{"title":"List Pumps","description":"List all Tidepool supported insulin pumps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPumps","name":"List Pumps","isWebhook":false,"pointer":"/paths/~1v1~1devices~1pumps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Pumps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Tidepool supported insulin pumps."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/devices/pumps","servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","500"],"pointer":"/v1/devices/pumps","href":"devices/listpumps","openApiOperationId":"ListPumps","summary":"List Pumps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of insulin pumps","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pumplist.v1"}},"schemaId":"components/schemas/pumplist.v1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"}],"pointer":"/paths/~1v1~1devices~1pumps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/pumplist.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pumplist.v1"}}},{"code":"500","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/listpumps"}],"panels":[]}]},"httpPath":"/v1/devices/pumps"},{"label":"Get Pump by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/getpumpbyid","routeSlug":"/reference/devices.v1/devices/getpumpbyid","metadata":{"seo":{"title":"Get Pump by ID","description":"Get a Tidepool supported insulin pump by its unique device identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPumpById","name":"Get Pump by ID","isWebhook":false,"pointer":"/paths/~1v1~1devices~1pumps~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pump by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Tidepool supported insulin pump by its unique device identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_158","description":"Device ID","required":true}],"pointer":"/paths/~1v1~1devices~1pumps~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/devices/pumps/{id}","servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"b9468a76-4afc-4c33-8d1d-1f08324d9160","schemaId":"components/schemas/guid.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404","500"],"pointer":"/v1/devices/pumps/{id}","href":"devices/getpumpbyid","openApiOperationId":"GetPumpById","summary":"Get Pump by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Insulin pump","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"}],"pointer":"/paths/~1v1~1devices~1pumps~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"404","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}},{"code":"500","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/getpumpbyid"}],"panels":[]}]},"httpPath":"/v1/devices/pumps/{id}"},{"label":"List CGMs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/listcgms","routeSlug":"/reference/devices.v1/devices/listcgms","metadata":{"seo":{"title":"List CGMs","description":"List all Tidepool supported continuous glucose monitors (CGMs)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListCgms","name":"List CGMs","isWebhook":false,"pointer":"/paths/~1v1~1devices~1cgms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List CGMs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all Tidepool supported continuous glucose monitors (CGMs)."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/devices/cgms","servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","500"],"pointer":"/v1/devices/cgms","href":"devices/listcgms","openApiOperationId":"ListCgms","summary":"List CGMs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of continuous glucose monitors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cgmlist.v1"}},"schemaId":"components/schemas/cgmlist.v1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"}],"pointer":"/paths/~1v1~1devices~1cgms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cgmlist.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cgmlist.v1"}}},{"code":"500","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/listcgms"}],"panels":[]}]},"httpPath":"/v1/devices/cgms"},{"label":"Get CGM by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/getcgmbyid","routeSlug":"/reference/devices.v1/devices/getcgmbyid","metadata":{"seo":{"title":"Get CGM by ID","description":"Get a Tidepool supported continuous glucose monitor (CGM) by its unique device identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCgmById","name":"Get CGM by ID","isWebhook":false,"pointer":"/paths/~1v1~1devices~1cgms~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get CGM by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Tidepool supported continuous glucose monitor (CGM) by its unique device identifier."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_158","description":"Device ID","required":true}],"pointer":"/paths/~1v1~1devices~1cgms~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/devices/cgms/{id}","servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"b9468a76-4afc-4c33-8d1d-1f08324d9160","schemaId":"components/schemas/guid.v1"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404","500"],"pointer":"/v1/devices/cgms/{id}","href":"devices/getcgmbyid","openApiOperationId":"GetCgmById","summary":"Get CGM by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/devices.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Continuous glucose monitor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}},"schemaId":"components/schemas/error.v1"}],"pointer":"/paths/~1v1~1devices~1cgms~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"404","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}},{"code":"500","schemaId":"components/schemas/error.v1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error.v1"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/getcgmbyid"}],"panels":[]}]},"httpPath":"/v1/devices/cgms/{id}"}],"content":{"contentType":"group","meta":{"name":"Devices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Devices","showPageActions":true},{"nodeType":"markdoc","content":"List and retrieve information about Tidepool supported devices, such as insulin pumps and continuous glucose monitors (CGMs), including the guard rails used to validate device settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/devices/pumps","summary":"List Pumps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/listpumps","deprecated":false},{"title":"/v1/devices/pumps/{id}","summary":"Get Pump by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/getpumpbyid","deprecated":false},{"title":"/v1/devices/cgms","summary":"List CGMs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/listcgms","deprecated":false},{"title":"/v1/devices/cgms/{id}","summary":"Get CGM by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/getcgmbyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/guid.v1":{"id":"components/schemas/guid.v1","kind":"json-schema","title":"GUID","data":{"title":"GUID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4 as defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.ietf.org/rfc/rfc4122.txt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 4122"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","format":"uuid","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$","example":"b9468a76-4afc-4c33-8d1d-1f08324d9160","x-go-type":"string"}},"components/schemas/bloodglucoseunits.v1":{"id":"components/schemas/bloodglucoseunits.v1","kind":"json-schema","title":"Blood Glucose Units","data":{"title":"Blood Glucose Units","description":"Blood glucose units","type":"string","enum":["MilligramsPerDeciliter"],"default":"MilligramsPerDeciliter"}},"components/schemas/fixeddecimal.v1":{"id":"components/schemas/fixeddecimal.v1","kind":"json-schema","title":"Fixed Decimal","data":{"title":"Fixed Decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fixed precision decimal number, expressed as whole units and nano (10^-9) units. For example, the value 5.75 is represented as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"units"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 5 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nanos"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 750000000."},"children":[]}]}]}],"type":"object","properties":{"units":{"description":"The whole units of the amount","type":"integer","format":"int32","example":5},"nanos":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of nano (10^-9) units of the amount"},"children":[]}]}]}],"type":"integer","format":"int32","example":750000000}}}},"components/schemas/recommendedbounds.v1":{"id":"components/schemas/recommendedbounds.v1","kind":"json-schema","title":"Recommended Bounds","data":{"title":"Recommended Bounds","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tidepool recommended closed range of values. May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there are no recommended bounds for the setting."},"children":[]}]}]}],"type":"object","nullable":true,"properties":{"minimum":{"$ref":"#/components/schemas/fixeddecimal.v1"},"maximum":{"$ref":"#/components/schemas/fixeddecimal.v1"}}}},"components/schemas/absolutebounds.v1":{"id":"components/schemas/absolutebounds.v1","kind":"json-schema","title":"Absolute Bounds","data":{"title":"Absolute Bounds","description":"Device specific closed range of allowed values","type":"object","properties":{"minimum":{"$ref":"#/components/schemas/fixeddecimal.v1"},"maximum":{"$ref":"#/components/schemas/fixeddecimal.v1"},"increment":{"$ref":"#/components/schemas/fixeddecimal.v1"}}}},"components/schemas/glucosesafetylimitguardrail.v1":{"id":"components/schemas/glucosesafetylimitguardrail.v1","kind":"json-schema","title":"Glucose Safety Limit Guard Rail","data":{"title":"Glucose Safety Limit Guard Rail","description":"Guard rail for the glucose safety limit setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/bloodglucoseunits.v1"},"recommendedBounds":{"$ref":"#/components/schemas/recommendedbounds.v1"},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"}}}},"components/schemas/maxsegments.v1":{"id":"components/schemas/maxsegments.v1","kind":"json-schema","title":"Maximum Segments","data":{"title":"Maximum Segments","description":"Maximum number of time segments","type":"integer","format":"int32","example":48}},"components/schemas/insulinsensitivityguardrail.v1":{"id":"components/schemas/insulinsensitivityguardrail.v1","kind":"json-schema","title":"Insulin Sensitivity Guard Rail","data":{"title":"Insulin Sensitivity Guard Rail","description":"Guard rail for the insulin sensitivity setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/bloodglucoseunits.v1"},"recommendedBounds":{"$ref":"#/components/schemas/recommendedbounds.v1"},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"},"maxSegments":{"$ref":"#/components/schemas/maxsegments.v1"}}}},"components/schemas/basalrateunits.v1":{"id":"components/schemas/basalrateunits.v1","kind":"json-schema","title":"Basal Rate Units","data":{"title":"Basal Rate Units","description":"Basal rate units","type":"string","enum":["UnitsPerHour"],"default":"UnitsPerHour"}},"components/schemas/basalratesguardrail.v1":{"id":"components/schemas/basalratesguardrail.v1","kind":"json-schema","title":"Basal Rates Guard Rail","data":{"title":"Basal Rates Guard Rail","description":"Guard rail for the basal rate schedule setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/basalrateunits.v1"},"defaultValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value. May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the device has no default value for the setting."},"children":[]}]}]}],"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/fixeddecimal.v1"}]},"absoluteBounds":{"description":"Device specific absolute bounds. Some pumps might have different increments for different ranges.","type":"array","items":{"$ref":"#/components/schemas/absolutebounds.v1"}},"maxSegments":{"$ref":"#/components/schemas/maxsegments.v1"}}}},"components/schemas/carbohydrateratiounits.v1":{"id":"components/schemas/carbohydrateratiounits.v1","kind":"json-schema","title":"Carbohydrate Ratio Units","data":{"title":"Carbohydrate Ratio Units","description":"Carbohydrate ratio units","type":"string","enum":["GramsPerUnit"],"default":"GramsPerUnit"}},"components/schemas/carbohydrateratioguardrail.v1":{"id":"components/schemas/carbohydrateratioguardrail.v1","kind":"json-schema","title":"Carbohydrate Ratio Guard Rail","data":{"title":"Carbohydrate Ratio Guard Rail","description":"Guard rail for the carbohydrate ratio setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/carbohydrateratiounits.v1"},"recommendedBounds":{"$ref":"#/components/schemas/recommendedbounds.v1"},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"},"maxSegments":{"$ref":"#/components/schemas/maxsegments.v1"}}}},"components/schemas/basalratemaximumguardrail.v1":{"id":"components/schemas/basalratemaximumguardrail.v1","kind":"json-schema","title":"Basal Rate Maximum Guard Rail","data":{"title":"Basal Rate Maximum Guard Rail","description":"Guard rail for the maximum basal rate setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/basalrateunits.v1"},"defaultValue":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default value. May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the device has no default value for the setting."},"children":[]}]}]}],"type":"object","nullable":true,"allOf":[{"$ref":"#/components/schemas/fixeddecimal.v1"}]},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"}}}},"components/schemas/bolusunits.v1":{"id":"components/schemas/bolusunits.v1","kind":"json-schema","title":"Bolus Units","data":{"title":"Bolus Units","description":"Bolus amount units","type":"string","enum":["Units"],"default":"Units"}},"components/schemas/bolusamountmaximumguardrail.v1":{"id":"components/schemas/bolusamountmaximumguardrail.v1","kind":"json-schema","title":"Bolus Amount Maximum Guard Rail","data":{"title":"Bolus Amount Maximum Guard Rail","description":"Guard rail for the maximum bolus amount setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/bolusunits.v1"},"recommendedBounds":{"$ref":"#/components/schemas/recommendedbounds.v1"},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"}}}},"components/schemas/correctionrangeguardrail.v1":{"id":"components/schemas/correctionrangeguardrail.v1","kind":"json-schema","title":"Correction Range Guard Rail","data":{"title":"Correction Range Guard Rail","description":"Guard rail for a correction range setting","type":"object","properties":{"units":{"$ref":"#/components/schemas/bloodglucoseunits.v1"},"recommendedBounds":{"$ref":"#/components/schemas/recommendedbounds.v1"},"absoluteBounds":{"$ref":"#/components/schemas/absolutebounds.v1"},"maxSegments":{"$ref":"#/components/schemas/maxsegments.v1"}}}},"components/schemas/guardrails.v1":{"id":"components/schemas/guardrails.v1","kind":"json-schema","title":"Guard Rails","data":{"title":"Guard Rails","description":"Guard rails used to validate therapy settings for the device","type":"object","properties":{"glucoseSafetyLimit":{"$ref":"#/components/schemas/glucosesafetylimitguardrail.v1"},"insulinSensitivity":{"$ref":"#/components/schemas/insulinsensitivityguardrail.v1"},"basalRates":{"$ref":"#/components/schemas/basalratesguardrail.v1"},"carbohydrateRatio":{"$ref":"#/components/schemas/carbohydrateratioguardrail.v1"},"basalRateMaximum":{"$ref":"#/components/schemas/basalratemaximumguardrail.v1"},"bolusAmountMaximum":{"$ref":"#/components/schemas/bolusamountmaximumguardrail.v1"},"correctionRange":{"$ref":"#/components/schemas/correctionrangeguardrail.v1"},"preprandialCorrectionRange":{"$ref":"#/components/schemas/correctionrangeguardrail.v1"},"workoutCorrectionRange":{"$ref":"#/components/schemas/correctionrangeguardrail.v1"}}}},"components/schemas/pump.v1":{"id":"components/schemas/pump.v1","kind":"json-schema","title":"Pump","data":{"title":"Pump","description":"A Tidepool supported insulin pump","type":"object","properties":{"id":{"$ref":"#/components/schemas/guid.v1"},"displayName":{"description":"Device display name","type":"string","example":"Omnipod 5"},"manufacturers":{"description":"Device manufacturers","type":"array","items":{"type":"string"},"example":["Insulet"]},"model":{"description":"Device model","type":"string","example":"Omnipod 5"},"guardRails":{"$ref":"#/components/schemas/guardrails.v1"}}}},"components/schemas/pumplist.v1":{"id":"components/schemas/pumplist.v1","kind":"json-schema","title":"List Pumps Response","data":{"title":"List Pumps Response","description":"List of Tidepool supported insulin pumps","type":"object","properties":{"pumps":{"type":"array","items":{"$ref":"#/components/schemas/pump.v1"}}}}},"components/schemas/error.v1":{"id":"components/schemas/error.v1","kind":"json-schema","title":"Devices Error","data":{"title":"Devices Error","description":"Error returned by the Devices API, in the gRPC-Gateway error format.","type":"object","properties":{"code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://grpc.io/docs/guides/status-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gRPC status code"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"integer","format":"int32","example":5},"message":{"description":"Human readable error message","type":"string","example":"pump not found"},"details":{"description":"Additional error details","type":"array","items":{"type":"object"}}},"required":["code","message"]}},"components/schemas/cgm.v1":{"id":"components/schemas/cgm.v1","kind":"json-schema","title":"CGM","data":{"title":"CGM","description":"A Tidepool supported continuous glucose monitor","type":"object","properties":{"id":{"$ref":"#/components/schemas/guid.v1"},"displayName":{"description":"Device display name","type":"string","example":"Dexcom G6"},"manufacturers":{"description":"Device manufacturers","type":"array","items":{"type":"string"},"example":["Dexcom"]},"model":{"description":"Device model","type":"string","example":"G6"}}}},"components/schemas/cgmlist.v1":{"id":"components/schemas/cgmlist.v1","kind":"json-schema","title":"List CGMs Response","data":{"title":"List CGMs Response","description":"List of Tidepool supported continuous glucose monitors","type":"object","properties":{"cgms":{"type":"array","items":{"$ref":"#/components/schemas/cgm.v1"}}}}},"schema_158":{"kind":"json-schema","data":{"$ref":"#/components/schemas/guid.v1"},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"title":"Get Pump by ID Response","type":"object","properties":{"pump":{"$ref":"#/components/schemas/pump.v1"}}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"title":"Get CGM by ID Response","type":"object","properties":{"cgm":{"$ref":"#/components/schemas/cgm.v1"}}},"id":"schema_160"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"/_mock/reference/devices.v1","isMockServer":true,"description":"Mock server"},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}]},"options":{"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/reference/devices.v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/devices.v1.json?download"},{"url":"/_bundle/reference/devices.v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Devices API","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.\n\nFor more information, see the [Getting Started](../docs/quick-start.md) section."}},"baseSlug":"/reference/devices.v1","routesMapping":{}}