{"type":"api","title":"Get Comm Plans","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"description":"Get the list of commPlans of the account that the user belongs to(enterprise account).\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices","operationId":"getCommPlans","parameters":[{"description":"target Account Id for which we need to retrieve the list of Comm Plans.","format":"int64","in":"path","name":"targetAccountId","required":true,"type":"integer"},{"description":"the APN name that the commPlans must contain.","in":"query","name":"apnName","required":false,"type":"string"},{"default":1,"description":"The page number for which we are returning the information.","in":"query","minimum":0,"name":"pageNumber","required":false,"type":"integer"},{"default":0,"description":"The number of items to return per page.","in":"query","maximum":50,"minimum":0,"name":"pageSize","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"accountId":{"format":"int64","type":"integer"},"accountName":{"description":"account Name for which we retrieve the APNs","type":"string"},"commPlans":{"description":"List of CommPlans associated with the enterprise accountId.","items":{"properties":{"apns":{"description":"List of APNs associated with the Comm Plan","items":{"properties":{"name":{"type":"string"},"pdpId":{"format":"int64","type":"integer"}},"type":"object"},"type":"array"},"commPlanDescription":{"description":"Description of CommPlan","type":"string"},"commPlanName":{"description":"Name of Communication Plan","type":"string"},"commProfileOnStateName":{"description":"Name of the On State Communication Profile","type":"string"},"fixedIpEnabled":{"description":"Specifies whether the Comm Profile has fixed Ip Enable","type":"boolean"},"lteApns":{"description":"List of LTE APNs associated with the Comm Plan","items":{"properties":{"name":{"type":"string"},"pdnId":{"format":"int64","type":"integer"}},"type":"object"},"type":"array"},"lteEnabled":{"description":"Specifies whether the Comm Plan has LTE enabled","type":"boolean"},"smsMoEnabled":{"description":"Specifies whether SMS MO is enabled on the CommPlan","type":"boolean"},"smsMtEnabled":{"description":"Specifies whether SMS MT is enabled on the CommPlan","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object","$$ref":"#/definitions/commPlanInfo"}},"400":{"description":"Bad request","schema":{"description":"Specifies the error that occurred during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occurred in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occurred. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Unauthorized","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Not found","schema":{"example":"Resource not found","type":"string"}}},"summary":"Get CommPlans of Enterprise account.","tags":["sim management"],"__originalOperationId":"getCommPlans","security":[{"bearerAuth":[]}],"method":"get","path":"/sm/{targetAccountId}/sdocommplans"}}