Subscription key which provides access to this API. Found in your apideveloper.connectedanalytics.com Profile.
\n","type":"text"},{"key":"Ocp-Apim-Trace","value":"false","type":"text"},{"key":"apikey","value":"{{apikey}}","description":"Base64 encoded key:secret
\n","type":"text"}],"url":"{{api_server_host}}/api/account/login","description":"Retrieve a Bearer Token from the SIMetric API Service.
\n","urlObject":{"path":["api","account","login"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"089d137b-63a9-43dc-b2e9-22724340c0a8"}],"id":"acf1f51c-cf45-4eda-a42a-c2f148ad46a5","description":"Do this first. Login returns a bearer token which must be used to execute other API actions.
\n","_postman_id":"acf1f51c-cf45-4eda-a42a-c2f148ad46a5"},{"name":"Carrier Account management","item":[{"name":"Get Carrier Accounts Bulk","id":"baa8ddf6-1c17-4bc9-95ab-9e3e137f05a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/ds/carrieraccounts?pageIndex=0&pageSize=10","description":"Retrieve GUID & other information related to a specific carrier.
\n","urlObject":{"path":["api","ds","carrieraccounts"],"host":["{{api_server_host}}"],"query":[{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[],"_postman_id":"baa8ddf6-1c17-4bc9-95ab-9e3e137f05a1"}],"id":"d28d7723-4477-4661-a96f-d01f262c5774","description":"This collection of APIs returns information about the each carrier related to a set of devices.
\n","_postman_id":"d28d7723-4477-4661-a96f-d01f262c5774"},{"name":"Device Lifecyle Management","item":[{"name":"Activate Devices","id":"86f6eee6-6f15-4454-b792-4f53a2f9a120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"carrierAccountGuid","value":"{{carrier_guid}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"[{\r\n\"iccid\": \"89148000005354236812\",\r\n\"ZipCode\": \"94568\"\r\n}]","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/activate","description":"For AT&T Accounts, only ICCID is required. Verizon requires both ICCID & ZipCode. IMEI/SKU is handled via configuration within Simetric.
\n","urlObject":{"path":["api","ds","activate"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"86f6eee6-6f15-4454-b792-4f53a2f9a120"},{"name":"Restore Devices","id":"8f45ae6c-6cbb-4222-a8fe-32ff5d1bc365","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CarrierAccountGuid\": \"7b212763-b025-416d-8834-4e2cd8e9397c\",\r\n\t\"Devices\": [\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272017484319\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272017484327\",\r\n\t\t\t\"msisdn\": \"882350201748432\"\r\n\t\t},\r\n {\r\n \"iccid\": \"80940758958901170327\"\r\n },\r\n {\r\n \"iccid\": \"99808012272009582773\"\r\n },\r\n {\r\n \"iccid\": \"99808012272009582856\"\r\n },\r\n {\r\n \"iccid\": \"99808012272009582880\"\r\n }\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/restore","description":"Restore Devices applies only to suspended devices. Restoring a deactivated or activated device will fail.
\n","urlObject":{"path":["api","ds","restore"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f45ae6c-6cbb-4222-a8fe-32ff5d1bc365"},{"name":"Suspend Devices","id":"61a03203-5cd5-4f2f-aba7-765e6aa7fdfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CarrierAccountGuid\": \"651fbee5-5c03-4333-b9b9-17d7123444f2\",\r\n\t\"Devices\": [\r\n\t\t{\r\n\t\t\t\"iccid\": \"9867884589867884538\",\r\n\t\t\t\"msisdn\": \"882350200649200\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/suspend","description":"Suspend Devices. Currently only Verizon is supported. Devices can only be suspended for 180 days.
\n","urlObject":{"path":["api","ds","suspend"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61a03203-5cd5-4f2f-aba7-765e6aa7fdfb"},{"name":"Kill Devices","id":"0c129fb2-40b8-4a63-b091-2597cc781d92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"CarrierAccountGuid\": \"123456789\",\r\n\t\"Devices\": [\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272006491960\",\r\n\t\t\t\"msisdn\": \"882350200649197\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272006491978\",\r\n\t\t\t\"msisdn\": \"882350200649197\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272006491986\",\r\n\t\t\t\"msisdn\": \"882350200649198\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272006491994\",\r\n\t\t\t\"msisdn\": \"882350200649199\"\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"iccid\": \"89011702272006492000\",\r\n\t\t\t\"msisdn\": \"882350200649200\"\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/kill","description":"Deactivate devices. Without manual intervention, this action is typically permanent.
\n","urlObject":{"path":["api","ds","kill"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c129fb2-40b8-4a63-b091-2597cc781d92"},{"name":"Send SMS V2","id":"57b0f7de-c77a-4c87-8b9c-aca6ca156884","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CarrierAccountGuid\": \"7b212763-b025-416d-8834-4e2cd8e9397c\",\r\n \"SMSRequest\": [\r\n {\r\n \"Iccid\": \"89010304300059322446\",\r\n \"Msisdn\": \"5263053022\",\r\n \"Message\": \"Test\",\r\n \"Language\": \"ENGL\",\r\n \"ServiceGrade\": \"853\"\r\n },\r\n {\r\n \"Iccid\": \"89010304300059322412\",\r\n \"Msisdn\": \"5263061516\",\r\n \"Message\": \"Test\",\r\n \"Language\": \"ENGL\",\r\n \"ServiceGrade\": \"853\"\r\n },\r\n {\r\n \"Iccid\": \"89011702272036891056\",\r\n \"Msisdn\": \"882350203689105\",\r\n \"Message\": \"!R3,1,7\",\r\n \"Language\": \"ENGL\",\r\n \"ServiceGrade\": \"853\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/sendsms","description":"Send SMS to a target device.
\n","urlObject":{"path":["api","ds","sendsms"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"57b0f7de-c77a-4c87-8b9c-aca6ca156884"}],"id":"75f5d40d-5a8d-40ae-9e29-1d93092dd211","description":"Modify device status. Statuses are not stateless and precedent status must be considered when executing these actions.
\n","_postman_id":"75f5d40d-5a8d-40ae-9e29-1d93092dd211"},{"name":"Device Inquiry","item":[{"name":"Get Device (Atomic)","id":"7095af8b-f904-4102-a7d0-a6642ef646b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/ds/Devices/{{lookup_type}}/{{lookup_value}}","description":"Lookup device by ID. ID type of ICCID and MSISDN are supported.
\n","urlObject":{"path":["api","ds","Devices","{{lookup_type}}","{{lookup_value}}"],"host":["{{api_server_host}}"],"query":[{"disabled":true,"key":"lookup_type","value":""}],"variable":[]}},"response":[],"_postman_id":"7095af8b-f904-4102-a7d0-a6642ef646b6"},{"name":"Get Devices Bulk (Generic)","id":"77223183-be59-43bc-abd7-12549f244d23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/ds/devices?deviceStatus={{status}}&pageSize=50&pageIndex=0","description":"Retrieve Device Details in Batch. Max supported batch is 5000
\n","urlObject":{"path":["api","ds","devices"],"host":["{{api_server_host}}"],"query":[{"key":"deviceStatus","value":"{{status}}"},{"key":"pageSize","value":"50"},{"key":"pageIndex","value":"0"}],"variable":[]}},"response":[],"_postman_id":"77223183-be59-43bc-abd7-12549f244d23"},{"name":"Get Devices Bulk (Advanced)","id":"71f286c9-9d07-4753-beab-ff0a00ff2d2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"Key\": \"Carrier\",\r\n \"Operator\": \"IN\",\r\n \"Items\": [\r\n \"AT&T\"\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/devices?pageIndex=0&pageSize=2","description":"Retrieve Device Details in Batch. Max supported batch is 5000.
\nSpecial operator IN can be used to search for specific Devices (1 value), between two values (inclusive, 2 values), and within a list (3 or more values).
\n","urlObject":{"path":["api","ds","devices"],"host":["{{api_server_host}}"],"query":[{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"2"}],"variable":[]}},"response":[],"_postman_id":"71f286c9-9d07-4753-beab-ff0a00ff2d2c"},{"name":"Get Device Usage History (Atomic)","id":"ffa54b5b-f5b0-403a-97c4-29569719a3c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/ds/usagehistory/{{lookup_type}}/{{lookup_value}}?pageIndex=0&pageSize=10","description":"Retrieve Device Usage History for a single device.
\n","urlObject":{"path":["api","ds","usagehistory","{{lookup_type}}","{{lookup_value}}"],"host":["{{api_server_host}}"],"query":[{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[],"_postman_id":"ffa54b5b-f5b0-403a-97c4-29569719a3c1"},{"name":"Get Device Usage History Bulk (Advanced)","id":"f98e46c0-1780-41d6-a0c1-3be44720da8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"Key\": \"DeviceStatus\",\r\n \"Operator\": \"IN\",\r\n \"Items\": [\r\n \"Activated\"\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/usagehistory?pageIndex=0&pageSize=10","description":"Retrieve Device Usage History for a set of devices.
\nSpecial operator IN can be used to search for specific Devices (1 value), between two values (inclusive, 2 values), and within a list (3 or more values).
\n","urlObject":{"path":["api","ds","usagehistory"],"host":["{{api_server_host}}"],"query":[{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"10"}],"variable":[]}},"response":[],"_postman_id":"f98e46c0-1780-41d6-a0c1-3be44720da8c"},{"name":"Get Device Change History (Atomic)","id":"e234c326-bf48-443d-b996-1d731ecff9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/ds/changehistory/{{lookup_type}}/{{lookup_value}}","description":"If supported by carrier, returns device change history for a specific device.
\n","urlObject":{"path":["api","ds","changehistory","{{lookup_type}}","{{lookup_value}}"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e234c326-bf48-443d-b996-1d731ecff9fd"},{"name":"Device Change History Bulk (Advanced)","id":"b37b8de5-7eb7-448f-b419-7fcf96dbe7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"Key\": \"CarrierAccountNbr\",\r\n \"Operator\": \"IN\",\r\n \"Items\": [\r\n \"123456789\"\r\n \r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{api_server_host}}/api/ds/changehistory?pageIndex=0&pageSize=2","description":"If supported by carrier, returns device change history for a set of devices.
\nSpecial operator IN can be used to search for specific Devices (1 value), between two values (inclusive, 2 values), and within a list (3 or more values).
\n","urlObject":{"path":["api","ds","changehistory"],"host":["{{api_server_host}}"],"query":[{"key":"pageIndex","value":"0"},{"key":"pageSize","value":"2"}],"variable":[]}},"response":[],"_postman_id":"b37b8de5-7eb7-448f-b419-7fcf96dbe7a7"}],"id":"0b94edd3-508c-4185-a59c-e2f4c16fe112","_postman_id":"0b94edd3-508c-4185-a59c-e2f4c16fe112","description":""},{"name":"Transaction Management","item":[{"name":"Get Transaction Details V2","id":"1ef08de1-bd6f-4c07-a02b-4547f73463c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Ocp-Apim-Subscription-Key","value":"{{apim_token}}","type":"text"}],"url":"{{api_server_host}}/api/v2/transactions/{{transaction_id}}","description":"Returns status for a transaction submitted to the simetric API.
\n","urlObject":{"path":["api","v2","transactions","{{transaction_id}}"],"host":["{{api_server_host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ef08de1-bd6f-4c07-a02b-4547f73463c8"}],"id":"d04ad8f7-b6fd-44fd-9010-d5207c81c1ad","description":"For some POST API calls, Transaction IDs are returned (i.e. Suspend Devices). This transaction ID can be polled for status of the group of transactions submitted in the API action. Latency of underlying carrier system varies, which impacts how long it takes to update status.
\n","_postman_id":"d04ad8f7-b6fd-44fd-9010-d5207c81c1ad"}]}