{"type":"api","title":"Onboard Sensor","meta":{"id":"/apps/pubhub/media/cisco-iot-suite/fbcd3c11dd48e274ddaa7139d3a3ed24e2e107e0/5c66b3aa-a761-3029-b823-c160b9ed90db","swagger":"2.0","info":{"contact":{"email":"asset-tracking-team@cisco.com"},"description":"This service exposes APIs for managing AssetTypes, Assets, Sensors, Gateways deployed in the network.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"http://swagger.io/terms/","title":"Industrial Asset Vision","version":"1.0.0"},"host":"us.ciscoiot.com","basePath":"/at/nbapi/v1","schemes":["https"],"externalDocs":{"description":"Find out more about Industrial Asset Vision","url":"https://www.cisco.com/c/en/us/products/cloud-systems-management/industrial-asset-vision/index.html"},"securityDefinitions":{"BearerToken":{"in":"header","name":"Authorization","type":"apiKey"}},"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"serverConfig":true,"meta":{"useProxy":true}}},"spec":{"consumes":["application/json"],"description":"Onboard Sensor","operationId":"onboardSensor","parameters":[{"description":"Sensor Id","format":"uuid","in":"path","name":"sensorId","required":true,"type":"string"},{"description":"Sensor details required for Onboarding","in":"body","name":"body","required":true,"schema":{"example":{"location":{"address":"Bangalore","latitude":77.087786,"longitude":12.12345678}},"properties":{"assetId":{"description":"Asset Id","format":"uuid","type":"string"},"location":{"description":"Location details","properties":{"address":{"description":"Address","type":"string"},"latitude":{"description":"Latitude","format":"double","type":"number"},"longitude":{"description":"Longitude","format":"double","type":"number"}},"type":"object","$$ref":"#/definitions/Location"},"sensorName":{"description":"Sensor Name","type":"string"}},"type":"object","$$ref":"#/definitions/OnboardSensorRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"example":{"appServerStatus":true,"loraServerStatus":true,"sensorId":"41d87103-ec31-4e46-a670-a8347fd26b5b","sensorName":"OysterSensor"},"properties":{"appServerStatus":{"description":"Server Onboarding Status (false-fail, true-success)","type":"boolean"},"loraServerStatus":{"description":"Lorawan Onboarding Status (false-fail, true-success)","type":"boolean"},"sensorId":{"description":"Sensor Id","type":"string"},"sensorName":{"description":"Sensor Name","type":"string"}},"type":"object","$$ref":"#/definitions/OnboardSensorResponse"}},"400":{"description":"Bad Request","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"401":{"description":"Unauthorized","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"403":{"description":"Forbidden","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"404":{"description":"Not Found","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"500":{"description":"Internal Server Error","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}}},"security":[{"BearerToken":[]}],"summary":"Onboard Sensor","tags":["Sensors"],"__originalOperationId":"onboardSensor","method":"post","path":"/sensors/{sensorId}/onboard"}}