API Documentation

Prepared by

Rohini Chandran

iBSM API

User Authentication

Sign In

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/signin

Description : This api is common for all user logins(Tenant, Company, Physician, Patient)

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

"userName":"iorbitmailer@gmail.com",

"password":"iorbit@12345"

}

Response Body :

{

  "tokenId": "Bearer eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiJzb2Z0dGVrSldUIiwic3ViIjoibmljb2pvbmVzQG1haWxpbmF0b3IuY29tIiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTcxMDIyMDk3N30.RFBtUR9wHHNQIqVz-3-DyuzfclwKSlKjNdAn9NkegjcO445_FsCF7Gm5EDje3CoIUs1pY_gSwnMn1EH97q4XXQ",

  "data": {

    "tokenid": "Bearer eyJhbGciOiJIUzUxMiJ9.eyJqdGkiOiJzb2Z0dGVrSldUIiwic3ViIjoibmljb2pvbmVzQG1haWxpbmF0b3IuY29tIiwiYXV0aG9yaXRpZXMiOlsiUk9MRV9VU0VSIl0sImlhdCI6MTcxMDIyMDk3N30.RFBtUR9wHHNQIqVz-3-DyuzfclwKSlKjNdAn9NkegjcO445_FsCF7Gm5EDje3CoIUs1pY_gSwnMn1EH97q4XXQ",

    "user": {

      "uuid": "883d3a89-e030-11ee-9821-91ca126a3d9f",

      "username": "nicojones@mailinator.com",

      "roleid": "3",

      "rolename": "Tenant",

      "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

      "adminUser": "nicojones@mailinator.com"

    }

  },

  "status": {

    "message": "Success",

    "code": "200 Ok"

  }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "404 NOT_FOUND",

        "details": "UserName  Not Found"

    }

}

{

   "status": [

       {

           "message": "Error",

           "code": "400 BAD_REQUEST",

           "details": "UserName is mandatory"

       }

   ]

}

{

 "status": {

   "message": "Error",

   "code": "500 INTERNAL_SERVER_ERROR",

   "details": ""

}

}

Get Signed In User Details

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/3/{userId}/getdettt

Description : This API is a GET Method and is used to get the details of the Signed In User

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "userSchemas": [

        {

            "firstName": "Nico",

            "lastName": "Jones",

            "userEmail": "nicojones@mailinator.com",

            "phone": "8548547854"

        }

    ],

    "status": {

        "message": "Success"

    }

}

Get Role Based Menu - Tenant User Role

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmail}/getRoleBasedMenu/3

Description : This API is a GET Method and is used to get all the configured menu with respect to the Tenant user role

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

[

    {

        "menuid": "m1",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Dashboard",

        "icon": "https://dev.iorbit.health/Icons/dashboard.png",

        "url": "/dashboard"

    },

    {

        "menuid": "m2",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Hospital",

        "icon": "https://dev.iorbit.health/Icons/customer.png",

        "url": "/managecustomer"

    },

    {

        "menuid": "m3",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Doctor",

        "icon": "https://dev.iorbit.health/Icons/physician.png",

        "url": "/managetherapist"

    },

    {

        "menuid": "m4",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Patient",

        "icon": "https://dev.iorbit.health/Icons/patient.png",

        "url": "/managepatient"

    },

    {

        "menuid": "m5",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Device Profile",

        "icon": "https://dev.iorbit.health/Icons/parameter.png",

        "url": "/deviceprofile"

    },

    {

        "menuid": "m8",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Device",

        "icon": "https://dev.iorbit.health/Icons/device.png",

        "url": "/managedevice"

    },

    {

        "menuid": "m9",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Sensor",

        "icon": "https://dev.iorbit.health/Icons/icons8-proximity-sensor-32.png",

        "url": "/managesensor"

    },

    {

        "menuid": "m10",

        "userid": "nicojones@mailinator.com",

        "roleid": 3,

        "submenu": "Manage Bed",

        "icon": "https://dev.iorbit.health/Icons/hospital-bed2.png",

        "url": "/managebeds"

    }

]

Tenant API

Register Tenant

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/tenantregister

Description : This API is a POST Method and is used to create new Tenant Details

Request Body :

{

     "firstName":"Nico",

    "lastName":"Jones",

    "userName":"nicojones@mailinator.com",

    "phone":"8548547854",

    "password":"user@12345",

    "newPassword":"user@12345",

    "gender":"Female",

    "img": "<img string>"

}

Response Body :

{

    "data": {

        "uuid": "3569ba28-e631-11ec-b8a9-7f9382bc045e"

    },

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Successfully Registered"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "409 CONFLICT",

        "details": "Already Registered"

    }

}

Wizard Configuration

Get Role List

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/getRolelist

Description : This API is a GET Method and is used to get Default Role Details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

[

    {

        "roleName": "Tenant",

        "roleId": 3

    },

    {

        "roleName": "Company",

        "roleId": 4

    },

    {

        "roleName": "Physician",

        "roleId": 6

    },

    {

        "roleName": "Patient",

        "roleId": 8

    },

    {

        "roleName": "Device",

        "roleId": 9

    }

]

Insert Selected Roles

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/insertSelectedRoles

Description : This API is a POST Method and is used to insert Selected Roles Details with Customized Role names

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

   {

       "userId": "nicojones@mailinator.com",

       "roleId": 3,

       "customRoleName": "Tenant"

   },

   {

       "userId": "nicojones@mailinator.com",

       "roleId": 4,

       "customRoleName": "Hospital"

   },

   {

       "userId": "nicojones@mailinator.com",

       "roleId": 6,

       "customRoleName": "Doctor"

   },

   {

       "userId": "nicojones@mailinator.com",

       "roleId": 8,

       "customRoleName": "Patient"

   },

   {

       "userId": "nicojones@mailinator.com",

       "roleId": 9,

       "customRoleName": "Device"

   }

]

Response Body :

{"successMessage":"RoleName changed."}

Get Master Menu List

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/getmastermenulist

Description : This API is a GET Method and is used to get Master Menu Details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

[

    {

        "masterMenuId": 1,

        "menuuuid": "m1",

        "menuText": "Dashboard",

        "menuIconURL": "https://dev.iorbit.health/Icons/dashboard.png",

        "priority": 1

    },

    {

        "masterMenuId": 2,

        "menuuuid": "m2",

        "menuText": "Manage Hospital",

        "menuIconURL": "https://dev.iorbit.health/Icons/customer.png",

        "priority": 2,

        "roleId": 4

    },

    {

        "masterMenuId": 3,

        "menuuuid": "m3",

        "menuText": "Manage Doctor",

        "menuIconURL": "https://dev.iorbit.health/Icons/physician.png",

        "priority": 3,

        "roleId": 6

    },

    {

        "masterMenuId": 4,

        "menuuuid": "m4",

        "menuText": "Manage Patient",

        "menuIconURL": "https://dev.iorbit.health/Icons/patient.png",

        "priority": 4,

        "roleId": 8

    },

    {

        "masterMenuId": 6,

        "menuuuid": "m8",

        "menuText": "Manage Device",

        "menuIconURL": "https://dev.iorbit.health/Icons/device.png",

        "priority": 6,

        "roleId": 9

    },

    {

        "masterMenuId": 10,

        "menuuuid": "m12",

        "menuText": "Manage Event",

        "menuIconURL": "https://dev.iorbit.health/Icons/parametergroup.png",

        "priority": 11

    },

    {

        "masterMenuId": 11,

        "menuuuid": "m13",

        "menuText": "Alert List",

        "menuIconURL": "https://dev.iorbit.health/Icons/parametergroup.png",

        "priority": 12

    },

    {

        "masterMenuId": 12,

        "menuuuid": "m10",

        "menuText": "Manage Bed",

        "menuIconURL": "https://dev.iorbit.health/Icons/hospital-bed2.png",

        "priority": 8

    },

    {

        "masterMenuId": 13,

        "menuuuid": "m11",

        "menuText": "Manage CMS",

        "menuIconURL": "https://dev.iorbit.health/Icons/cms2.png",

        "priority": 9

    },

    {

        "masterMenuId": 14,

        "menuuuid": "m14",

        "menuText": "Manage Producer",

        "menuIconURL": "https://dev.iorbit.health/Icons/cms2.png",

        "priority": 10

    },

    {

        "masterMenuId": 16,

        "menuuuid": "m9",

        "menuText": "Manage Sensor",

        "menuIconURL": "https://dev.iorbit.health/Icons/icons8-proximity-sensor-32.png",

        "priority": 7

    }

]

Insert Custom Menu List

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/insertCustomMenu

Description : This API is a POST Method and is used to insert all customized menu with respect to a tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m1",

    "menuText": "Dashboard",

    "priority": 1,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m2",

    "menuText": "Manage Hospital",

    "priority": 2,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com,

    "menuuuid": "m3",

    "menuText": "Manage Doctor",

    "priority": 3,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m4",

    "menuText": "Manage Patient",

    "priority": 4,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m8",

    "menuText": "Manage Device",

    "priority": 6,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m10",

    "menuText": "Manage Bed",

    "priority": 8,

    "menuicon": ""

  },

  {

    "userId": "nicojones@mailinator.com",

    "menuuuid": "m9",

    "menuText": "Manage Sensor",

    "priority": 7,

    "menuicon": ""

  }

]

Response Body :

[

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    },

    {

        "status": {

            "message": "Success",

            "code": "200 OK",

            "details": "Inserted Custom Menu Details"

        }

    }

]

Get Custom Menu List

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/getcustommenulist

Description : This API is a GET Method and is used to list all customized menu details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

[

    {

        "customMenuId": 4675,

        "menuText": "Dashboard",

        "menuIconURL": "https://dev.iorbit.health/Icons/dashboard.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m1",

        "priority": 1

    },

    {

        "customMenuId": 4676,

        "menuText": "Manage Hospital",

        "menuIconURL": "https://dev.iorbit.health/Icons/customer.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m2",

        "priority": 2

    },

    {

        "customMenuId": 4677,

        "menuText": "Manage Doctor",

        "menuIconURL": "https://dev.iorbit.health/Icons/physician.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m3",

        "priority": 3

    },

    {

        "customMenuId": 4678,

        "menuText": "Manage Patient",

        "menuIconURL": "https://dev.iorbit.health/Icons/patient.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m4",

        "priority": 4

    },

    {

        "customMenuId": 4679,

        "menuText": "Manage Device",

        "menuIconURL": "https://dev.iorbit.health/Icons/device.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m8",

        "priority": 6

    },

    {

        "customMenuId": 4680,

        "menuText": "Manage Bed",

        "menuIconURL": "https://dev.iorbit.health/Icons/hospital-bed2.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m10",

        "priority": 8

    },

    {

        "customMenuId": 4681,

        "menuText": "Manage Sensor",

        "menuIconURL": "https://dev.iorbit.health/Icons/icons8-proximity-sensor-32.png",

        "userId": "nicojones@mailinator.com",

        "menuuuid": "m9",

        "priority": 7

    }

]

Insert Role Based Menu - Tenant Role

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/Tenant/insertRoleBasedMenu

Description : This API is a POST Method and is used to insert all selected menu items with respect to a Tenant role

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m1"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m2"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m3"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m4"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m8"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m10"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Tenant",

    "menuid": "m9"

  }

]

Response Body :

{"successMessage":"insert details successfully"}

Insert Role Based Menu - Company Role

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/Hospital/insertRoleBasedMenu

Description : This API is a POST Method and is used to insert all selected menu items with respect to a Company/Hospital role

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m1"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m3"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m4"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m8"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m10"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Hospital",

    "menuid": "m9"

  }

]

Response Body :

{"successMessage":"insert details successfully"}

Insert Role Based Menu - Physician Role

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/Doctor/insertRoleBasedMenu

Description : This API is a POST Method and is used to insert all selected menu items with respect to a tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Doctor",

    "menuid": "m1"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Doctor",

    "menuid": "m4"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Doctor",

    "menuid": "m8"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Doctor",

    "menuid": "m10"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Doctor",

    "menuid": "m9"

  }

]

Response Body :

{"successMessage":"insert details successfully"}

Insert Role Based Menu - Patient Role

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/{tenantEmailId}/Patient/insertRoleBasedMenu

Description : This API is a POST Method and is used to insert all selected menu items with respect to a tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

[

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Patient",

    "menuid": "m1"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Patient",

    "menuid": "m8"

  },

  {

    "userid": "nicojones@mailinator.com",

    "rolename": "Patient",

    "menuid": "m9"

  }

]

Response Body :

{"successMessage":"insert details successfully"}

Get User Role List

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/ithings/getUserRolelist/{tenantEmailId}

Description : This API is a GET Method and is used to fetch all user roles with respect to a tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

[

    {

        "roleId": 3,

        "customRoleName": "Tenant",

        "userId": "nicojones@mailinator.com"

    },

    {

        "roleId": 4,

        "customRoleName": "Hospital",

        "userId": "nicojones@mailinator.com"

    },

    {

        "roleId": 6,

        "customRoleName": "Doctor",

        "userId": "nicojones@mailinator.com"

    },

    {

        "roleId": 8,

        "customRoleName": "Patient",

        "userId": "nicojones@mailinator.com"

    },

    {

        "roleId": 9,

        "customRoleName": "Device",

        "userId": "nicojones@mailinator.com"

    }

]

Insert Patient Privilege Details - Company Role

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/userId/{tenantEmailId}/roleId/4/accessingpatientdata

Description : This API is a POST Method and is used to insert all customized patient privilege details with respect to Company/Hospital role

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "patientInfo": true,

  "patientTrend": false,

  "patientDevice": true,

  "patientAdmission": true,

  "patientWaveform": false

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK"

    },

    "data": {

        "uuid": "a8305e5a-e033-11ee-9821-43edbb5a2544"

    }

}

Insert Patient Privilege Details - Physician Role

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/userId/{tenantEmailId}/roleId/6/accessingpatientdata

Description : This API is a POST Method and is used to insert all customized patient privilege details with respect to Physician/Doctor role

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "patientInfo": true,

  "patientTrend": true,

  "patientDevice": true,

  "patientAdmission": false,

  "patientWaveform": true

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK"

    },

    "data": {

        "uuid": "80a7dd8c-e034-11ee-9821-69527c8d3d5b"

    }

}

Company API

Register a new Company

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies

Description : This API is a POST Method and is used to register a new Company/Hospital Details

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "name": "ABC Hospital",

  "email": "abchospital1@gmail.com",

  "phone": "7685786655",

  "address": {

    "street": "",

    "postalcode": "",

    "city": "",

    "state": "",

    "country": ""

  },

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Registered Successfully"

    },

    "data": {

        "uuid": "0777790f-e036-11ee-9821-db23cb5d7096"

    }

}

Get Registered Company Names

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/getCompanyNames

Description : This API is a GET Method and is used to get names of all registered Company/Hospital under a Tenant User

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "companies": [

        {

            "companyuuid": "0",

            "name": "All"

        },

        {

            "companyuuid": "0777790f-e036-11ee-9821-db23cb5d7096",

            "name": "ABC Hospital"

        },

        {

            "companyuuid": "4c2b6043-e03a-11ee-9821-bf688162afd9",

            "name": "DEF Hospital"

        }

    ],

    "status": {

        "message": "Success"

 

Get Registered Company Details

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/0/getCompanyDetails

Description : This API is a GET Method and is used to list the details of all registered Company/Hospital under a Tenant User

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "companies": [

        {

            "companyuuid": "0777790f-e036-11ee-9821-db23cb5d7096",

            "name": "ABC Hospital",

            "image": "<img-string>",

            "phone": "7685786655",

            "email": "abchospital1@gmail.com",

            "address": {}

        },

        {

            "companyuuid": "4c2b6043-e03a-11ee-9821-bf688162afd9",

            "name": "DEF Hospital",

            "image": "<img-string>",

            "phone": "7977246117",

            "email": "defhosp@mailinator.com",

            "address": {}

        }

    ],

    "status": {

        "message": "Success"

    }

}

Get a Company Details

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/getCompanyDetails

Description : This API is a GET Method and is used to get the details of a particular Company/Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "name": "ABC Hospital",

  "email": "abchospital1@gmail.com",

  "phone": "7685786655",

  "address": {

    "country": "India"

  },

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Update Details Successfully"

    }

}

Edit Company Details

Method: PUT

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/UpdateDetails

Description : This API is a PUT Method and is used to update the details of a Company/Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "name": "ABC Hospital",

  "email": "abchospital1@gmail.com",

  "phone": "7685786655",

  "address": {

    "country": "India"

  },

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Update Details Successfully"

    }

}

Delete Company

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/deleteCompany

Description : This API is a DELETE Method and is used to delete existing Company/Hospital Details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Delete Details Successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "OrganizationId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Physician API

Register a new Physician

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/physicians

Description : This API is a POST Method and is used to register a new Physician under a Company/Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "firstName": "Daisy ",

  "lastName": "Little",

  "email": "daisylittle@mailinator.com",

  "dob": "1984-03-06",

  "gender": "Female",

  "roleId": "6",

  "phone": "7977246117",

  "address": {

    "street": "",

    "postalcode": "",

    "city": "",

    "state": "",

    "country": ""

  },

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Registered Successfully.Please check your email before proceeding."

    },

    "data": {

        "uuid": "0e0d31a1-e038-11ee-9821-07c4814f4212"

    }

}

Get Registered Physician Names

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/getphysiciannames

Description : This API is a GET Method and is used to to get names of all registered Physician/Doctor under a Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "physicians": [

        {

            "physicianuuid": "0",

            "firstName": "All",

            "lastName": "All"

        },

        {

            "physicianuuid": "0e0d31a1-e038-11ee-9821-07c4814f4212",

            "firstName": "Daisy ",

            "lastName": "Little"

        },

        {

            "physicianuuid": "7b7f6c72-e039-11ee-9821-6367f3d0d031",

            "firstName": "Henry ",

            "lastName": "Talbot"

        }

    ],

    "status": {

        "message": "Success"

    }

}

Get Registered Physician Details

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/physicians

Description : This API is a GET Method and is used to list the details of all registered Physician/Doctor under a Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "physicians": [

        {

            "physicianuuid": "0e0d31a1-e038-11ee-9821-07c4814f4212",

            "firstName": "Daisy ",

            "lastName": "Little",

            "phone": "7977246117",

            "email": "daisylittle@mailinator.com",

            "roleId": "6",

            "gender": "Female",

            "dob": "1984-03-06",

            "address": {}

        },

        {

            "physicianuuid": "7b7f6c72-e039-11ee-9821-6367f3d0d031",

            "firstName": "Henry ",

            "lastName": "Talbot",

            "phone": "7804592619",

            "email": "henrytalbot@mailinator.com",

            "roleId": "6",

            "gender": "Male",

            "dob": "1985-03-01",

            "address": {}

        }

    ],

    "status": {

        "message": "Success"

    }

}

Get a Physician Details

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/physicians/{physicianId}/getphysician

Description : This API is a GET Method and is used to get the details of a particular Physician/Doctor

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "physicians": [

        {

            "physicianuuid": "0e0d31a1-e038-11ee-9821-07c4814f4212",

            "companyId": "0777790f-e036-11ee-9821-db23cb5d7096",

            "firstName": "Daisy ",

            "lastName": "Little",

            "phone": "7977246117",

            "email": "daisylittle@mailinator.com",

            "roleId": "6",

            "gender": "Female",

            "dob": "1984-03-06",

            "address": {},

            "companies": [

                {

                    "companyuuid": "0777790f-e036-11ee-9821-db23cb5d7096",

                    "name": "ABC Hospital"

                }

            ]

        }

    ],

    "status": {

        "message": "Success"

    }

}

Edit Physician Details

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/physicians/{physicianId}/updatephysicianbyId

Description : This API is a PUT Method and is used to update the details of a Physician/Doctor

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "firstName": "Daisy ",

  "lastName": "Little",

  "email": "daisylittle@mailinator.com",

  "dob": "1984-03-06",

  "gender": "Female",

  "roleId": "6",

  "phone": "7977246117",

  "address": {

    "country": "India"

  }

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Update Details Successfully"

    }

}

Delete Patient

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/physicians/{physicianId}/deletephysician

Description : This API is a DELETE Method and is used to delete existing Physician Details

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Delete Details Successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "OrganizationId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "Physician Not Found"

    }

}

Patient API

        Register Patient

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/registerpatientsregisterpatients

Description : This API is a POST Method and is used to register a new Patient Details

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "companyId": "0777790f-e036-11ee-9821-db23cb5d7096",

  "physicianId": "0",

  "patientId": "ABC001",

  "firstName": "Henry ",

  "lastName": "P",

  "email": "henryp@mailinator.com",

  "dob": "1991-12-06",

  "gender": "Male",

  "roleId": "6",

  "phone": "7977246117",

  "address": {

    "street": "",

    "postalcode": "",

    "city": "",

    "state": "",

    "country": ""

  },

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Patient Registered Successfully"

    },

    "data": {

        "uuid": "ce4f7848-e03f-11ee-9821-516bb6cd7c22"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "Patient Already Registered"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "PhysicianId Not Found"

    }

}

Assign Physician to Patient

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/assignphysiciansregisterpatients

Description : This API is a POST Method and is used to assign a Physician to the newly registered patient

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "companyId": "0777790f-e036-11ee-9821-db23cb5d7096",

  "physicians": [

    {

      "physicianuuid": "0e0d31a1-e038-11ee-9821-07c4814f4212"

    }

  ],

  "patientuuid": "ce4f7848-e03f-11ee-9821-516bb6cd7c22",

  "firstName": "Henry ",

  "lastName": "P",

  "email": "henryp@mailinator.com",

  "gender": "Male",

  "dob": "1991-12-06",

  "roleId": "4",

  "phone": "7977246117",

  "image": "<img-string>"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Patient Registered Successfully"

    },

    "data": {

        "uuid": "0f1e59e9-e040-11ee-9821-6dac4cabbb77"

    }

}

Get Registered Patients Details

 

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/companies/{companyId}/physicians/{physicianId}/patients

Description : This API is a GET Method and is used to get all Patient’s details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "patient": [

        {

            "patientuuid": "ce4f7848-e03f-11ee-9821-516bb6cd7c22",

            "firstName": "Henry ",

            "lastName": "P",

            "phone": "7977246117",

            "email": "henryp@mailinator.com",

            "gender": "Male",

            "dob": "1991-12-06 00:00:00",

            "address": {}

        },

        {

            "patientuuid": "b8d5ec0a-e040-11ee-9821-ed4f4ac68684",

            "firstName": "Lucas",

            "lastName": "M",

            "phone": "7994492658",

            "email": "lucas@mailinator.com",

            "gender": "Male",

            "dob": "1989-08-10 00:00:00",

            "address": {}

        }

    ],

    "status": {

        "message": "Success"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "OrganizationId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "PhysicianId Not Found"

    }

}

Get a Patient Details

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/getpatient/{patientId}/patients

Description : This API is a GETMethod and is used to get a Patient’s details

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "patient": [

        {

            "patientuuid": "ce4f7848-e03f-11ee-9821-516bb6cd7c22",

            "firstName": "Henry ",

            "lastName": "P",

            "phone": "7977246117",

            "email": "henryp@mailinator.com",

            "gender": "Male",

            "dob": "1991-12-06",

            "address": {}

        }

    ],

    "status": {

        "message": "Success"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "Patient Not Found"

    }

}

Edit Patient Details

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/patients/{patientId}/updatePatient

Description : This API is a PUT Method and is used to update the details of a Patient

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "tenantId": "883d3a89-e030-11ee-9821-91ca126a3d9f",

  "companyId": "",

  "physicianId": "0",

  "firstName": "Henry ",

  "lastName": "P",

  "email": "henryp@mailinator.com",

  "dob": "1991-12-06",

  "gender": "Male",

  "roleId": "6",

  "phone": "7977246117",

  "address": {

    "country": "India"

  }

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Update Details Successfully"

    }

}

Delete Patient

Method: DELETE

URL : https://www.iorbit-tech.com:8443/api/v1/organizations/0/tenants/{tenantId}/patients/{patientId}/deletepatient

Description : This API is a DELETE Method and is used to delete existing Patient Details

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Delete Details Successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "OrganizationId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "Patient Not Found"

    }

}

Device Profile API

Get All Device Profiles

        

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/tenants/{tenantId}/companies/0/physicians/0/devicemodels

Description : This API is a GET Method and is used to display all device profiles created.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "statusDetails": {

        "message": "Success"

    },

    "deviceMode": [

        {

            "modelName": "iBSM",

            "modelTags": "#iBSM",

            "parameter": [

                {

                    "groupId": "041bd9f0-e055-11ee-9821-1b8728da60a2",

                    "groupName": "iBSM",

                    "parameters": [

                        {

                            "paramId": "20001",

                            "name": "ECG Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20002",

                            "name": "HR Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20004",

                            "name": "RR",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20006",

                            "name": "SPO2",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

                            "name": "Moisture",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20005",

                            "name": "PPG",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20001",

                            "name": "ECG Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20002",

                            "name": "HR Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20004",

                            "name": "RR",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20006",

                            "name": "SPO2",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

                            "name": "Moisture",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20005",

                            "name": "PPG",

                            "typeName": "measurement"

                        }

                    ]

                }

            ],

            "deviceUUid": "3a421601-e057-11ee-9821-a7e593821379",

            "modelNumber": "iBSM",

            "devImage": "null"

        }

    ]

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Items Found"

    }

}

Get Default Parameters

        

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/getdefaultParameters

Description : This API is a GET Method and is used to display default parameters created for IoMT.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "parameters": [

        {

            "paramId": "2d4c7t5u-8e41-58er-ou79-4d76ca72c05e",

            "name": "BP",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "9c391caa-141f-4dc9-8bfb-84793bb92d56",

            "name": "BPM",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "2d4c0dc6-8e41-11ec-aa90-4d76ca72c05e",

            "name": "diastolic",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20001",

            "name": "ECG Lead",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20002",

            "name": "HR Lead",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "10001",

            "name": "HR-ZON",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "c086669e-8e3f-11ec-aa90-cd114ec91ea0",

            "name": "Humidity",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

            "name": "Moisture",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "fbd5b342-8e40-11ec-aa90-63ca57ad7eb3",

            "name": "oxygen_level",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20005",

            "name": "PPG",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20003",

            "name": "Resp",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "10005",

            "name": "RESPVal-ZON",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "10004",

            "name": "RespWave-ZON",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20004",

            "name": "RR",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "20006",

            "name": "SPO2",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "10003",

            "name": "SPO2Val-ZON",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "10002",

            "name": "SPO2Wave-ZON",

            "typeName": "measurement",

            "measuretypeName": "stream"

        },

        {

            "paramId": "20007",

            "name": "Temp_Body",

            "typeName": "measurement",

            "measuretypeName": "value"

        },

        {

            "paramId": "20008",

            "name": "Temp_Skin",

            "typeName": "measurement",

            "measuretypeName": "value"

        }

    ],

    "status": {

        "message": "Success"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Found"

    }

}

Display Newly Added Parameters

        

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/0/getnewParameters

Description : This API is a GET Method and is used to display newly added parameters by users.

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

Response Body :

      {

        "parameters": [

            {

                "paramId": "5615d7f7-d4f9-11ec-aea9-03c90ce274f3",

                "name": "ADC1"

            },

            {

                "paramId": "66877039-d4f9-11ec-aea9-7177f6c2f39d",

                "name": "ADC2"

            },

            {

                "paramId": "8c702e4b-d4f9-11ec-aea9-e551e2150507",

                "name": "PWM1"

            },

            {

                "paramId": "9b468d1d-d4f9-11ec-aea9-7b975fd76e0f",

                "name": "PWM2"

            },

            {

                "paramId": "d2f6132f-d4f9-11ec-aea9-3725a2bb3316",

                "name": "DAC1"

            },

            {

                "paramId": "dcf7b871-d4f9-11ec-aea9-433bf18e9008",

                "name": "DAC2"

            },

            {

                "paramId": "2ffc5083-d4fa-11ec-aea9-650bf8f3f6a9",

                "name": "RELAY1"

            },

            {

                "paramId": "43a4d0d5-d4fa-11ec-aea9-1b6fabc14988",

                "name": "RELAY2"

            },

            {

                "paramId": "6396c387-d4fa-11ec-aea9-0b3c7bae1fd2",

                "name": "OUT1"

            },

            {

                "paramId": "96ed76c9-d4fa-11ec-aea9-cfe06764f045",

                "name": "OUT2"

            },

            {

                "paramId": "bc5a9c3b-d4fa-11ec-aea9-51980a0af67e",

                "name": "IN1"

            },

            {

                "paramId": "db23512d-d4fa-11ec-aea9-fb2cde4d0adf",

                "name": "IN2"

            }

        ],

        "status": {

            "message": "Success"

        }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Found"

    }

}

Adding a new Parameter

                

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/0/parameters

Description : This API is a POST Method and is used to add new parameters..

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "name": "Oxygen Level",

  "type": 1,

  "measureType": 1,

  "frequency": "",

  "valueType": "1",

  "unit": "none",

  "typical": "",

  "tags": "none",

  "range": [

    {

      "rangeName": "",

      "rangeType": "",

      "min": "",

      "max": "",

      "thresholdhigh": "",

      "thresholdlow": ""

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Parameter added successfully"

    },

    "data": {

        "uuid": "7307592e-e054-11ee-9821-0b733c2c4f17"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "409 CONFLICT",

        "details": "Parameter already exist"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Get a Parameters Details

        

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/parameter/{parameterId}

Description : This API is a GET Method and is used to display details of a parameter created for IoMT.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "parameters": [

        {

            "name": "Oxygen Level",

            "type": 1,

            "measureType": 1,

            "valueType": 1,

            "unit": "none",

            "tags": "none",

            "range": [

                {}

            ]

        }

    ]

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Found"

    }

}

Edit Parameter

                

Method: PUT

URL :  https://www.iorbit-tech.com:8443/api/v1/parameters/{parameterId}

Description : This API is a PUT Method and is used to edit details of a parameter.

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "name": "Oxygen Level",

  "type": 1,

  "measureType": 1,

  "frequency": "",

  "valueType": "1",

  "unit": "none",

  "typical": "",

  "tags": "none",

  "range": [

    {

      "rangeName": "",

      "rangeType": "",

      "min": "",

      "max": "",

      "thresholdhigh": "",

      "thresholdlow": ""

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Parameter added successfully"

    },

    "data": {

        "uuid": "7307592e-e054-11ee-9821-0b733c2c4f17"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Found"

    }

}

Delete Parameter

                

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/parameters/{parameterId}

Description : This API is a DELETE Method and is used to delete existing parameters.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Delete Details Successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Found"

    }

}

Grouping Parameters

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/Tenant/{tenantId}/company/0/parametergroup

Description : This API is a POST Method and is used to group similar parameters together..

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "groupName": "iBSM",

  "type": "1",

  "tags": null,

  "parameters": [

    {

      "paramId": "20001"

    },

    {

      "paramId": "20002"

    },

    {

      "paramId": "20004"

    },

    {

      "paramId": "20006"

    },

    {

      "paramId": "026076b0-8e40-11ec-aa90-795332df2921"

    },

    {

      "paramId": "20005"

    },

    {

      "paramId": "7307592e-e054-11ee-9821-0b733c2c4f17"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Parameter Group Added successfully"

    },

    "data": {

        "uuid": "041bd9f0-e055-11ee-9821-1b8728da60a2"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "409 CONFLICT",

        "details": "Already Existing Parameter Group"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Display all parameter groups under a device profile

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/0/physician/0/parametergroup

Description : This API is a GET Method and is used to display all parameters groups under a device profile.

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

Response Body :

{

  "parametergroup": [

    {

      "groupId": "041bd9f0-e055-11ee-9821-1b8728da60a2",

      "groupName": "iBSM",

      "type": "1",

      "parameters": [

        {

          "paramId": "20001",

          "name": "ECG Lead",

          "typeName": "measurement"

        },

        {

          "paramId": "20002",

          "name": "HR Lead",

          "typeName": "measurement"

        },

        {

          "paramId": "20004",

          "name": "RR",

          "typeName": "measurement"

        },

        {

          "paramId": "20006",

          "name": "SPO2",

          "typeName": "measurement"

        },

        {

          "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

          "name": "Moisture",

          "typeName": "measurement"

        },

        {

          "paramId": "20005",

          "name": "PPG",

          "typeName": "measurement"

        },

        {

          "paramId": "7307592e-e054-11ee-9821-0b733c2c4f17",

          "name": "Oxygen Level",

          "typeName": "measurement"

        }

      ]

    }

  ],

  "status": {

    "message": "Success"

  }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Parameter Group Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Edit Parameter Group

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/model/{modelId}/groups/041bd9f0-e055-11ee-9821-1b8728da60a2

Description : This API is a PUT Method and is used to edit the details of a Parameter Group

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "groupName": "iBSM",

  "type": "1",

  "tags": "ibsm",

  "parameters": [

    {

      "paramId": "20001"

    },

    {

      "paramId": "20002"

    },

    {

      "paramId": "20004"

    },

    {

      "paramId": "20006"

    },

    {

      "paramId": "026076b0-8e40-11ec-aa90-795332df2921"

    },

    {

      "paramId": "20005"

    },

    {

      "paramId": "7307592e-e054-11ee-9821-0b733c2c4f17"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Parameter Group Updated Successfully"

    }

}

Adding a device profile

Method: POST

URL :  https://www.iorbit-tech.com:8443/api/v1/Tenant/{tenantId}/company/0/addmodel

Description : This API is a GET Method and is used to add  a new device profile.

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "modelNumber": "iBSM",

  "modelName": "iBSM",

  "modelmanufacturer": "",

  "modelTags": "#iBSM",

  "versionNumber": "",

  "devImage": "null",

  "qrEnabled": ""

}

Response Body :

{

    "modelstatus": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Model added successfully"

    },

    "modelData": {

        "uuid": "3a421601-e057-11ee-9821-a7e593821379"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "409 CONFLICT",

        "details": "Already existing Device Model"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Mapping Parameter Group with Device Profile

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/{companyId}/parametergroup/{modelId}

Description : This API is a POST Method and is used to map the Parameter group with the Device Profile

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "groupName": "iBSM",

  "type": "1",

  "parameters": [

    {

      "paramId": "20001",

      "name": "ECG Lead"

    },

    {

      "paramId": "20002",

      "name": "HR Lead"

    },

    {

      "paramId": "20004",

      "name": "RR"

    },

    {

      "paramId": "20006",

      "name": "SPO2"

    },

    {

      "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

      "name": "Moisture"

    },

    {

      "paramId": "20005",

      "name": "PPG"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Parameter Group Mapped successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "code": "409 CONFLICT",

        "details": "Already existing Device Model"

    }

}

{

    "status": {

        "message": "Error",

        "details": "TenantId Not Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "CompanyId Not Found"

    }

}

Get a Device Profile Details

        

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/getdevicemodelsbyid/{modelId}

Description : This API is a GET Method and is used to display details of a  device profile created.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "statusDetails": {

        "message": "Success"

    },

    "deviceMode": [

        {

            "modelName": "iBSM",

            "modelTags": "#iBSM",

            "qrEnabled": "false",

            "parameter": [

                {

                    "groupId": "041bd9f0-e055-11ee-9821-1b8728da60a2",

                    "groupName": "iBSM",

                    "parameters": [

                        {

                            "paramId": "20001",

                            "name": "ECG Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20002",

                            "name": "HR Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20004",

                            "name": "RR",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20006",

                            "name": "SPO2",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

                            "name": "Moisture",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20005",

                            "name": "PPG",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20001",

                            "name": "ECG Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20002",

                            "name": "HR Lead",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20004",

                            "name": "RR",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20006",

                            "name": "SPO2",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "026076b0-8e40-11ec-aa90-795332df2921",

                            "name": "Moisture",

                            "typeName": "measurement"

                        },

                        {

                            "paramId": "20005",

                            "name": "PPG",

                            "typeName": "measurement"

                        }

                    ]

                }

            ],

            "deviceUUid": "3a421601-e057-11ee-9821-a7e593821379",

            "modelNumber": "iBSM",

            "devImage": "null"

        }

    ]

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "No Items Found"

    }

}

Edit Device Profile

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/model/{modelId}/groups/{groupId}

Description : This API is a PUT Method and is used to edit details of a Parameter Group

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "modelNumber": "iBSM",

  "modelName": "iBSM",

  "modelTags": "#iBSM",

  "versionNumber": "1.0",

  "devImage": "null",

  "qrEnabled": ""

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Model updated successfully"

    }

}

Delete Device Profile

                

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/deleteModel/{modelId}

Description : This API is a DELETE Method and is used to delete existing device profile details.

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

  "message": "Success",

  "code": "200 OK",

  "details": "Details Deleted Successfully"

}

Device API

API Calls from iBSM Server

Check for an Existing Device        

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/device/{devicemacId}/checkForExistingDevices

Description : This API is a GET Method and is used to check whether a Device with the same macId is already registered

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

  "message": "false",

  "details": "New Device"

}

Register a new iBSM Device

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/registeribsmdevice

Description : This API is a POST Method and is used to register a new iBSM device

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "devicename": "Xiaomi Redmi Note 9 Pro Max",

  "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

  "devmacid": "d6dadd3640d548c8",

  "osversion": "12",

  "tenantid": "489b8835-cee1-11ee-943b-81ec99853929"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Registered Successfully"

    },

    "data": {

        "uuid": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b"

    }

}

Get all Device Details

                

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/PhysicianId/{tenantId}/company/0/showdevice

Description : This API is a GET Method and is used to get the details of all registered devices

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "device": [

        {

            "deviceuuid": "57ce1d74-df99-11ee-9821-edadfaea7224",

            "devicename": "Xiaomi Redmi Note 9 Pro Max",

            "measTimeStamp": "1710154565200",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "d6dadd3640d548c8"

        },

        {

            "deviceuuid": "7b4f7ee7-dc6c-11ee-9dab-e5b8ef42cfb3",

            "devicename": "samsung SM-T570-BMJO",

            "measTimeStamp": "1709805286934",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "634461ecea602cb8"

        },

        {

            "deviceuuid": "407e1df4-daef-11ee-8e30-1748f724990c",

            "devicename": "BP Monitor",

            "measTimeStamp": "1709617881301",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "5dfbc2465116",

            "deviceimageName": "null"

        },

        {

            "deviceuuid": "7324d52c-db7e-11ee-8e30-ff0de1875775",

            "devicename": "BP",

            "measTimeStamp": "1709617881301",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "fdaa3fa72316",

            "deviceimageName": "null"

        },

        {

            "deviceuuid": "e625cb70-da1c-11ee-9b1c-bf9fc3d772db",

            "devicename": "samsung SM-T570",

            "measTimeStamp": "1709535445064",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "4d6c108b9015b766"

        },

        {

            "deviceuuid": "0925102f-d6e6-11ee-934f-137146ded650",

            "devicename": "Pune Tab 2",

            "measTimeStamp": "1709185219299",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "f75bacb1a8b5991e"

        },

        {

            "deviceuuid": "31d7f78b-d214-11ee-b2b9-11a8eadf78ea",

            "devicename": "iBSM Tab 1",

            "measTimeStamp": "1708664185322",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "da81dfc907657233"

        },

        {

            "deviceuuid": "5566622c-d225-11ee-b2b9-e3af02c20821",

            "patientnames": "Ratnakar R",

            "devicename": "samsung SM-A125F",

            "measTimeStamp": "1708664185322",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "4d687babeb3cdbfe"

        },

        {

            "deviceuuid": "88d8162e-cfe4-11ee-8c82-cdaddaf80ada",

            "devicename": "samsung SM-T570",

            "measTimeStamp": "1708413379589",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "63210e58113f8be2"

        },

        {

            "deviceuuid": "9b558b82-cef8-11ee-b7d8-2b091ac3f2ec",

            "devicename": "Advantech Demo",

            "measTimeStamp": "1708318950772",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "modelSchema": [

                {

                    "modelName": "iBSM"

                }

            ],

            "decmacid": "3545bc82f02090ba"

        }

    ],

    "status": {

        "message": "Success"

    }

}

Get a Device Detail

                

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/device/{devicemacId}/viewdevice

Description : This API is a GET Method and is used to get the details of a registered device

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "modelId": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

    "modelName": "iBSM",

    "devmacid": "d6dadd3640d548c8",

    "deviceid": "57ce1d74-df99-11ee-9821-edadfaea7224",

    "devicename": "Xiaomi Redmi Note 9 Pro Max"

}

Edit Device

Method: PUT

URL :  https://www.iorbit-tech.com:8443/api/v1/devmacid/{devmacId}/updatedevicebymacid

Description : This API is a PUT Method and is used to edit the details of a device

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "devicename": "Xiaomi Redmi Note 9 Pro Max-TVM",

  "modelName": "iBSM",

  "bleid": "",

  "devmacid": "d6dadd3640d548c8"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Instance Updated Successfully"

    },

    "data": {

        "uuid": "57ce1d74-df99-11ee-9821-edadfaea7224"

    }

}

Check for Bed Connection

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/device/{deviceUUId}/checkForConnectedBeds

Description : This API is a GET Method and is used to check whether the device has an active Bed connection or not

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

true/false

Delete a Device

Method: DELETE

URL : https://www.iorbit-tech.com:8443/api/v1/deletedevices/{deviceUUId}

Description : This API is a DELETE Method and is used to delete the details of an existing device

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Deleted Successfully"

    }

}

Check for QR Authentication

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/modelid/{modelId}/checkauthenticationenabled

Description : This API is a GET Method and is used to check whether the selected Device Profile has enabled QR Authentication or not

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Deleted Successfully"

    }

}

Get Details for Showing QR Code for Device Enrolment

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/modelid/{modelId}/getdetailsforqrcode

Description : This API is a GET Method and is used to get the details for displaying the QR Code for Device Enrolment

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "qrtoken": "MzE0N2I2NzYtY2VlNS0xMWVlLWI3ZDgtZjNkODUxNmY2NjY5XzQ4OWI4ODM1LWNlZTEtMTFlreZS05NDNiLTgxZWM5OTg1MzkyOQ=="

}

Check for Device Authentication

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/devicemacid/{devicemacId}/companyId/{companyId}/checkforauthentication

Description : This API is a GET Method and is used to check whether the Device is ready for Authentication

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

   "device": [

       {

           "devcompstatus": "Success"

       }

   ]

}

Check for Scanned Device’s Temporary Details

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/checkfortempscan

Description : This API is a GET Method and is used to fetch the details of currently scanning devices that are stored temporarily

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Deleted Successfully"

    }

}

API Calls from iBSM Device

Get the Access Token

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/deviceid/{devicemacId}/getthetoken

Description : This API is a GET Method and is used to get the access token for the corresponding device

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "accesstoken": "eWEyOS5jLmMwQVlfVnBaamo5RFZmcThNVm9MNFZqZkphdks4QmNBUU5pOTZVSHluN2toMXFvWWJfeU1jZnBaZWpXQ2xpNzczcFlaY2tkNXliY21Zc0d0dl9maUs5LUhGSGYycXcyMFU1WEZJMTd3QVRFYnRBUjZwejcwRG92OVlMOXNQTDNwS0wyeXhOZ1V3SFVyb0pTQkVxTHplcUFCX3NKMnJKaVBYV0JYN3JZaU4xSklFVEN2ZTU4alMxMUtKdVMwR1RuN3RQdUIzUHMwX29fZ2pXY3ozM3pCRGpTb0RKOXluSktoSG1BVklISWlfblYzNVBIX25DX1c2eGlHTUFRQVJRYm1zbnV5YUJBTkpGTmprOVBUcTRpMmFuM09EWWZvanJLVTdjbmpfRnFBZ2xlSzJrbHlPaU5BWXhpMUp4blZOUnI4ZmVaRU5lZTFhUF83QjB0dkVLMFk3aTdOX2ZIalF1dE4ySkk2X0RfWUVxVXZKZ3J6MlIyalJPOGNxVFQzODVLLWlfNVYxLWJ2NVVoNW8zT3I5OGVVb3UyNGpxX2FGWFlCZHVPY1g0WWlKWHgta25lZjYtUXJid2pibzZGaHl0NWdNNl9XTWt0MTQtY2pfNnM4NGNqSW1kd1lpRlo5MlNyd1NCcFg0NXRYNlFfNXFCWHpnYi1SbmlpV2xabmZ4c1VXSV9pY1Y2aWlfNkY5cm1uMHNTMjhJWWtoNGRycVdheGZibmlzWlhKWVExaVgwUV9pTzVNYms1MFJYMXJ1ZGJsYWtpZWUyUmx2cV9Pb1lxOFU2cWc0cEJYX0ZvWG5aVndvWnJqamlveTBhZ2NJc3lYYzA3cmxmZWRGUmYwY2VRd3g0WjR3LU93N24za1FaUVJZWmhpZXR5bVppaGpXdlhzVkJNMXdkWWo0OEowanBXeHhSbXdZaDl2Mm1XODI5bWZ0Vk82NXEwOXpjZlVSODhuOGNTbGdsdWVSbHduanNnQnpYOElYMEJNRk91aGZPV1dCWXE0QlM1aVFZbkJ0Z3haNVV4TVpldFo4UXh2OWloV2dCVjQxeG42YzFWMU01MElNcnhvVy1fTTgzT29uWGF3MVlPRmRpcm1mQm1VVy1KSVNqWEpWdVdZeElaWGtqbjVkNHI5cDUxU3NyZ0I5aDUxMWl3WTdjaHB3T1Nlb3NzWEpJTVNtajJ4WGRvYnh0dmFzU2Q5Slh6eTg4cHNGbGMwMXFYNHVjRmE4WXhsaDFuU3Q2UjhfVjg5UWVGeTJjOFZWRjRsT0JWdTh1dkZaYWdJSl9CNHVrcm40Y1hPMm5rRlNjU2oyaXhZeUZyWS01bnE5YlZsSUY3bFV0VzhsUUpSdGJvdTY3cjlZYS1jb21wLTZjZjE4YzQ0LWNiMjItMTFlZS05NjllLWYxZTgyMmYyZGJiYy1kZXYtZjYzMzI0MjAwNDQ0ODk5ZC1qd3QtQmVhcmVyIEJlYXJlciBleUpoYkdjaU9pSklVelV4TWlKOS5leUpxZEdraU9pSnpiMlowZEdWclNsZFVJaXdpYzNWaUlqb2lhbVZ1Ym1sbVpYSkFiV0ZwYkdsdVlYUnZjaTVqYjIwaUxDSmhkWFJvYjNKcGRHbGxjeUk2V3lKU1QweEZYMVZUUlZJaVhTd2lhV0YwSWpveE5qZ3pOVEk0T1RZeGZRLm9kdUZlaHgtWGY5N1pWUmJVSDhQN2pzcl9vSTlCQ1Vsd0plQjdIc1BTdTdGbVE2d3hrbnZweVZSM2NjdWx5aDhNZ0dlbWFBVlY1bDZsRDRmZlgtWVZn"

}

Authenticate Device

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/deviceId/{devicemacId}/qrtoken/{qrtoken}/authenticatedevice

Description : This API is a GET Method and is used to Authenticate the device with respect to the qr token showing in the iBSM server

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

true

Map Device to Company

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/devicess/{devmacid}/tenant/{tenantId}/companies/{companyId}

Description : This API is a POST Method and is used to map the Device to the corresponding Company/Hospital

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Successfully linked Device to Company",

        "accesstoken": "eWEyOS5jLmMwQVlfVnBaaE1kaXdNUWZUVHg0NWN0bndOOFF6MUxfZDJDUVJsQ2RmQ0FtME1QZmpVQ3ZNRWpjZ3NhZWpJOGp3SnltREdKSDZKMlJqSFJDSXpMNkdya2h0aGZHNno0VFAyVVdSVmk1d1E3V09WVkUtRzFHZmZMSXFnS3JoaWI4RC1xc0d3YzhzLXRoX2FIRUk1LVRycGx4R3NseWR6eklIVlNpMkFvaHo5Q0twWms1YXEzSldacDBnNG5mbnIzbUdFTXpURzVXUTlrYkptMWRlTEZHblVHaWZ2WjMtdGlQYUM4V0VETnFsb0hYclJVUUNEbTZxZl80VFNjdHE5XzFtZDQxbEdodHNsUFV6M2dWUWlTengycjd4UnUtUkZaeUFUM1RaTGtvZDN3R05qYkF3ckw5a3ZZUTNmT3ZiVUR4X1VSMDdfLXF0em02NzVlN3hHZjVid3hILUpwMHREQ19rS0dlSnliN191eV9oMEgzU3ZZRUhYdmNOTU4zODVQcFFWbnVkV2RGWTd6TWloUjF2aldKaU9ubFM3ajJ3c1dYaU1sMVh3MFpybFFVeDFxX1hlQmJTUkI3OFlaT1h6U2V3Vl82Wk9GMlZjUms5Wllvb3pNTTVmMTF5OUZwNndRYXVabEZ6dE1mNzM3WGFneGxwNzktNjVaWXRkUzF0dW5TWHBWbHd5V1M1aTRoM2VtandwYVZzaDYzcWEyczU3RnBVOFN5cjVkMjFGdnMyNFZkM2dvMHJkbGlmb3ktMUY3VnVCT1NqeXo5aDh0Nm5zY3JpaXNaUUZsNGFNdnpJSlNNZk1sYmhyY0IweHJZT1NrMjZKdVM1dDJiOEZqalV2NWJyMDdralpmeHo0MVgxcnd2TzBGY2dtNzVZSm1Ka3V2NjFaZDZJRmpxOU1mQkZSc011QnFoYzlVVWNpOS02YzZnUTVmeTExYmN1YjY0ZGVvXzRkUjdiSlFKUlM2Smw1N0pGUVpsYXFwQngwY3FTazhqamRra2RseDVzWW83VVpTa3FRNWRiZmFzMDBSejlKQmRtNzgwVXZVeTM5ZDdzVXFYWFNjOXVwUlpaZjhnaXkyLXFWUkY1TVJVZHRyUTZTOTVseWp6ZzVsMTkzZ2ZkWnNXdEltYlNValU0T3RSVlZWejlyNFJ4MTQ1YkJqLTJYYlpJSnMtY3EzZTIwdlh0UVFjMWEwa3VCOW8ydjVzdkJTdk04OHFtVmNWT2lYSTYxNzQxY3hiSU9zUXpTbElaSTA4cnRtSUp6Rm9YNWt6U1hhVzBPYnhyUWU5Vk82UXRVMVhVbFl6b1pfVnotUXpfSjlPUm5NaWxKTWloU1FKbWxZMTVYbmVuZnk5Mi1jb21wLTkwODExY2UxLWNlZTQtMTFlZS1iN2Q4LTc1MTcwNTQ1NmZlZC1kZXYtZDZkYWRkMzY0MGQ1NDhjOC1qd3QtQmVhcmVyIEJlYXJlciBleUpoYkdjaU9pSklVelV4TWlKOS5leUpxZEdraU9pSnpiMlowZEdWclNsZFVJaXdpYzNWaUlqb2lhbVZ1Ym1sbVpYSkFiV0ZwYkdsdVlYUnZjaTVqYjIwaUxDSmhkWFJvYjNKcGRHbGxjeUk2V3lKU1QweEZYMVZUUlZJaVhTd2lhV0YwSWpveE5qZ3pOVEk0T1RZeGZRLm9kdUZlaHgtWGY5N1pWUmJVSDhQN2pzcl9vSTlCQ1Vsd0plQjdIc1BTdTdGbVE2d3hrbnZweVZSM2NjdWx5aDhNZ0dlbWFBVlY1bDZsRDRmZlgtWVZn"

    }

}

Sensor API

API Calls from iBSM Server

Get all Sensor Details

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/tenantid/{tenantId}/listallsensors

Description : This API is a GET Method and is used to get the details of all registered sensors under a Tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "sensor": [

        {

            "sensorImg": "",

            "sensorId": "116",

            "sensorName": "CJ5059",

            "sensormacid": "EA:B7:75:A5:AB:E7",

            "sensoruuId": "70a5c100-92c7-4d6e-9085-dc450260ce75",

            "sensorType": "Chest",

            "createdOn": "2024-02-19 07:09:39",

            "modifiedOn": "2024-02-19 07:09:39"

        },

        {

            "sensorImg": "",

            "sensorId": "122",

            "sensorName": "CJ6147",

            "sensormacid": "D2:CC:B9:3B:45:C0",

            "sensoruuId": "0cdf9898-02d2-4704-8ec4-276361191f58",

            "sensorType": "Chest",

            "createdOn": "2024-02-19 09:28:04",

            "modifiedOn": "2024-02-19 09:28:04"

        },

        {

            "sensorImg": "",

            "sensorId": "129",

            "sensorName": "L3862",

            "sensormacid": "DC:70:95:23:FD:9D",

            "sensoruuId": "232a8234-ac37-40a4-8b19-12b708042006",

            "sensorType": "Limb",

            "createdOn": "2024-02-28 06:11:29",

            "modifiedOn": "2024-02-28 06:11:29"

        }

    ],

    "status": {

        "code": "200 OK"

    }

}

Add a new Sensor

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/savesensordetails

Description : This API is a POST Method and is used to register a new sensor under a Tenant user

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "sensorName": "CJ6062",

  "sensormacid": "C2:46:62:14:12:6B",

  "sensorType": "Chest",

  "sensorImg": "",

  "tenantid": "489b8835-cee1-11ee-943b-81ec99853929"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Sensors details added successfully"

    },

    "data": {

        "uuid": "1162523d-e06c-11ee-bda6-dd8250deb60e"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "Sensors Already Registered"

    },

    "data": {}

}

Get a Sensor

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/sensor/{sensorUUId}/getsensordetails

Description : This API is a GET Method and is used to get details of a registered Sensor

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "sensor": [

        {

            "sensorImg": "",

            "sensorId": "118",

            "sensorName": "CJ6062",

            "sensormacid": "C2:46:62:14:12:6B",

            "sensoruuId": "15dc8ab6-b50f-4456-a0c5-5c5095ee5687",

            "sensorType": "Chest",

            "createdOn": "2024-02-19 07:13:55",

            "modifiedOn": "2024-02-19 07:13:55"

        }

    ],

    "status": {

        "code": "200 OK"

    }

}

Edit Sensor

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/sensor/{sensorUUId}/editsensordetails

Description : This API is a PUT Method and is used to update the details of a registered Sensor

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "sensorName": "CJ60621",

  "sensormacid": "C2:46:62:14:12:6B",

  "sensorType": "Chest",

  "sensorImg": ""

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Sensors details has been updated"

    },

    "data": {

        "uuid": "b7d3c4a6-e06d-11ee-bda6-dfd2e25334b6"

    }

}

Delete Sensor

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/sensor/{sensorUUId}/deletesensor

Description : This API is a DELETE Method and is used to delete the details of an existing Sensor

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Sensor Details Deleted Successfully"

    }

}

Check Sensor Connection

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/sensor/{sensorId}/isSensorConnected

Description : This API is a GET Method and is used to check whether a sensor is currently connected or not

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

true/false

API Calls from iBSM Device

Map Sensor to Device

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/device/{devicemacId}/sensor/{sensorName}/{sensormacId}

Description : This API is a POST Method and is used to map a sensor with the iBSM Device while connecting

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Sensor Mapped with Device Successfully"

    }

}

Error Message :

{

    "status": {

        "message": "Error",

        "details": "Already Mapped"

    }

}

{

    "status": {

        "message": "Error",

        "details": "No DeviceId Found"

    }

}

{

    "status": {

        "message": "Error",

        "details": "No SensorId Found"

    }

}

Unmap Sensor from Device

Method: PUT

URL : https://www.iorbit-tech.com:8443/api/v1/device/{devicemacId}/sensor/{sensorName}/{sensormacId}

Description : This API is a PUT Method and is used to unmap a sensor from the iBSM Device while disconnecting

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Sensor Disconnected Successfully"

    }

}

Bed API

Get all Bed Details

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/{companyId}/bedstatus

Description : This API is a GET Method and is used to get the details of all registered Beds with patient status

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "beds": [

        {

            "bedId": "08bc46da-cef5-11ee-b7d8-1fc9c05b27cc",

            "bedNo": "001",

            "wardNo": "A Block",

            "mapStatus": "Active",

            "patientId": "881ee72b-cef5-11ee-b7d8-d949f100c423"

        },

        {

            "bedId": "096b27b5-cef9-11ee-b7d8-4bf72c1b9630",

            "bedNo": "002",

            "wardNo": "B Block",

            "mapStatus": "Active",

            "patientId": "f441fad3-cef8-11ee-b7d8-ff36a9d6d5ed"

        },

        {

            "bedId": "253fe9af-cefc-11ee-b7d8-4b859545bb53",

            "bedNo": "003",

            "wardNo": "C Block",

            "mapStatus": "Active",

            "patientId": "831e7b07-cefb-11ee-b7d8-edde2a4030ce"

        },

        {

            "bedId": "eaa048b0-d230-11ee-b2b9-a14531c738fa",

            "bedNo": "002",

            "wardNo": "A Block",

            "mapStatus": "Active",

            "patientId": "ce6124ce-d230-11ee-b2b9-bf8362c8d38e"

        },

        {

            "bedId": "4b1d9667-d589-11ee-a905-bd418b87d809",

            "bedNo": "009",

            "wardNo": "E block",

            "mapStatus": "Vacant",

            "patientId": ""

        },

        {

            "bedId": "38e37298-dc6d-11ee-9dab-3bf1a6eb9d3e",

            "bedNo": "BED200",

            "wardNo": "Cardiac",

            "mapStatus": "Active",

            "patientId": "940b3899-cee5-11ee-b7d8-356420b8e4e6"

        }

    ],

    "status": {

        "message": "Success",

        "code": "200 OK"

    }

}

Add a new Bed

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/tenant/{tenantId}/company/{companyId}/beds

Description : This API is a POST Method and is used to get the details of all registered Beds with patient status

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "wardNo": "ICU",

  "bedNo": "111",

  "devices": [

    {

      "deviceuuid": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Bed added & Device Assigned Successfully"

    },

    "data": {

        "uuid": "f9032058-e06e-11ee-bda6-6d7705be61b0"

    }

}

Get a Bed

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/bedById

Description : This API is a GET Method and is used to get the details of a Bed

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "beds": [

        {

            "bedId": "f9032058-e06e-11ee-bda6-6d7705be61b0",

            "bedNo": "110",

            "wardNo": "ICU"

        }

    ],

    "status": {

        "message": "Success",

        "code": "200 OK"

    }

}

Edit Bed

Method: PUT

URL :  https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/updatebed

Description : This API is a PUT Method and is used to update the details of a Bed

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "wardNo": "ICU",

  "bedNo": "110"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Bed Details Updated Successfully"

    },

    "data": {}

}

Delete a Bed

Method: DELETE

URL :  https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/deletebed

Description : This API is a DELETE Method and is used to delete the details of an existing bed

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Bed Details Deleted Successfully"

    },

    "data": {}

}

Admit a Patient to Bed

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/patient/assign

Description : This API is a POST Method and is used to admit a patient to an existing bed

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

  "wardNo": "ICU",

  "bedNo": "111"

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Bed Successfully Assigned to Patient"

    },

    "data": {}

}

Add a Device to Bed

Method: POST

URL : https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/device/assign

Description : This API is a POST Method and is used to add a device to a bed

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "devices": [

    {

      "deviceuuid": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

      "devmacId": "d6dadd3640d548c8"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Device Successfully Assigned To The Bed"

    },

    "data": {}

}

Get Devices assigned to Bed

Method: GET

URL :  https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/getdeviceassigned

Description : This API is a GET Method and is used to get the details of devices assigned to a bed

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "device": [

        {

            "deviceuuid": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "modelName": "iBSM",

            "modelNumber": "iBSM",

            "devicename": "Xiaomi Redmi Note 9 Pro Max",

            "modelid": "3147b676-cee5-11ee-b7d8-f3d8516f6669",

            "decmacid": "d6dadd3640d548c8"

        }

    ],

    "status": {

        "message": "Success",

        "code": "200 OK"

    }

}

Get Patient Admitted to Bed

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/getpatient/{patientId}/patients

Description : This API is a GET Method and is used to get the details of Patient admitted to the Bed

Headers : Authorization :: "Bearer + <TokenId>"

Request Body :

{

  "wardNo": "ICU",

  "bedNo": "111",

  "devices": [

    {

      "deviceuuid": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b"

    }

  ]

}

Response Body :

{

    "status": {

        "message": "Success",

        "code": "200 OK",

        "details": "Bed added & Device Assigned Successfully"

    },

    "data": {

        "uuid": "f9032058-e06e-11ee-bda6-6d7705be61b0"

    }

}

Get All Device Parameters connected to Bed

Method: GET

URL : https://www.iorbit-tech.com:8443/api/v1/bed/{bedId}/getmeasurementparameter

Description : This API is a GET Method and is used to get the details of all parameters of the device connected to Bed

Headers : Authorization :: "Bearer + <TokenId>"

Response Body :

{

    "beds": [

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20001",

            "paramName": "ECG Lead",

            "measureTypename": "stream",

            "minValue": "60",

            "maxValue": "120",

            "streamParamId": "20001"

        },

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20002",

            "paramName": "HR Lead",

            "measureTypename": "value",

            "minValue": "60",

            "maxValue": "120",

            "streamParamId": "20002"

        },

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20005",

            "paramName": "PPG",

            "measureTypename": "stream",

            "minValue": "60",

            "maxValue": "100",

            "streamParamId": "20005"

        },

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20006",

            "paramName": "SPO2",

            "measureTypename": "value",

            "minValue": "60",

            "maxValue": "100",

            "streamParamId": "20006"

        },

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20003",

            "paramName": "Resp",

            "measureTypename": "stream",

            "minValue": "6",

            "maxValue": "30",

            "streamParamId": "20003"

        },

        {

            "bedId": "e133eeda-e070-11ee-bda6-7b2fdec4d621",

            "patientId": "cb2694fc-cee5-11ee-b7d8-ef9adb3a38e7",

            "devMacId": "d6dadd3640d548c8",

            "deviceId": "3fccd0cf-e065-11ee-af9a-d1321ac8eb8b",

            "deviceName": "Xiaomi Redmi Note 9 Pro Max",

            "paramId": "20004",

            "paramName": "RR",

            "measureTypename": "value",

            "minValue": "6",

            "maxValue": "30",

            "streamParamId": "20004"

        }

    ],

    "status": {

        "message": "Success"

    }

}

Server Urls

        API Base URL =         https://www.iorbit-tech.com:8443/

        WebSocket URL =         wss://stream.iorbit.health:4567/source

                                       wss://stream.iorbit.health:4567/consumer