[String, Required] username for login
\n","key":"name","type":"text","value":"{{username}}"},{"description":"[String, Required] password for login
\n","key":"password","type":"text","value":"{{password}}"}]},"url":"{{base_url}}/api/session","description":"Establishes a new session upon successful authentication of name and password.
\nGet a list of all accounts
\nGet data for a specific account
\n[Number, Optional] account status (0: created, 1: active, 2: inactive, 3: suspended, 9: deleted). If omitted defaults to 0.
\n"},{"key":"pin","value":"{{account_pin}}","type":"text","description":"[String, Optional] account PIN. If omitted defaults to '0000'.
\n"},{"key":"expiration","value":"{{account_expiration}}","type":"text","description":"[Timestamp, Optional] expiration time. if omitted defaults to 'infinity'.
\n"},{"key":"first_name","value":"{{first_name}}","type":"text","description":"[String, Required] first name.
\n"},{"key":"middle_name","value":"{{middle_name}}","type":"text","description":"[String, Optional] middle name.
\n"},{"key":"last_name","value":"{{last_name}}","type":"text","description":"[String, Required] last name.
\n"},{"key":"national_id","value":"{{national_id}}","type":"text","description":"[String, Optional] national Id. Must be unique in the system.
\n"},{"key":"email","value":"{{email}}","type":"text","description":"[String, Required] email address. Must be unique in the system.
\n"},{"key":"phone","value":"{{phone}}","type":"text","description":"[String, Optional] phone number. Must be unique in the system.
\n"},{"key":"address_1","value":"{{address_1}}","type":"text","description":"[String, Optional] address field 1.
\n"},{"key":"address_2","value":"{{address_2}}","type":"text","description":"[String, Optional] address field 2.
\n"},{"key":"city","value":"{{city}}","type":"text","description":"[String, Optional] city name.
\n"},{"key":"state","value":"{{state}}","type":"text","description":"[String, Optional] state or province.
\n"},{"key":"postal_code","value":"{{postal_code}}","type":"text","description":"[String, Optional] postal code.
\n"},{"key":"country","value":"{{country}}","type":"text","description":"[String, Optional] country name.
\n"},{"key":"device_limit","value":"{{device_limit}}","type":"text","description":"[Number, Optional]
\n"},{"key":"subscription_id","value":"{{subscription_id}}","type":"text","description":"[Number, Optional] default base subscription for this account.
\n"},{"key":"group_id","value":"{{group_id}}","type":"text","description":"[Number, Required] account group to which this account belongs.
\n"}]},"url":"{{base_url}}/api/account","description":"Create a new account
\n[Number, Optional] account status (0: created, 1: active, 2: inactive, 3: suspended, 9: deleted). If omitted defaults to 0.
\n","type":"text"},{"key":"pin","value":"{{account_pin}}","description":"[String, Optional] account PIN. If omitted defaults to '0000'.
\n","type":"text"},{"key":"expiration","value":"{{account_expiration}}","description":"[Timestamp, Optional] expiration time. if omitted defaults to 'infinity'.
\n","type":"text"},{"key":"first_name","value":"{{first_name}}","description":"[String, Required] first name.
\n","type":"text"},{"key":"middle_name","value":"{{middle_name}}","description":"[String, Optional] middle name.
\n","type":"text"},{"key":"last_name","value":"{{last_name}}","description":"[String, Required] last name.
\n","type":"text"},{"key":"national_id","value":"{{national_id}}","description":"[String, Optional] national Id. Must be unique in the system.
\n","type":"text"},{"key":"email","value":"{{email}}","description":"[String, Required] email address. Must be unique in the system.
\n","type":"text"},{"key":"phone","value":"{{phone}}","description":"[String, Optional] phone number. Must be unique in the system.
\n","type":"text"},{"key":"address_1","value":"{{address_1}}","description":"[String, Optional] address field 1.
\n","type":"text"},{"key":"address_2","value":"{{address_2}}","description":"[String, Optional] address field 2.
\n","type":"text"},{"key":"city","value":"{{city}}","description":"[String, Optional] city name.
\n","type":"text"},{"key":"state","value":"{{state}}","description":"[String, Optional] state or province.
\n","type":"text"},{"key":"postal_code","value":"{{postal_code}}","description":"[String, Optional] postal code.
\n","type":"text"},{"key":"country","value":"{{country}}","description":"[String, Optional] country name.
\n","type":"text"},{"key":"device_limit","value":"{{device_limit}}","description":"[Number, Optional]
\n","type":"text"},{"key":"subscription_id","value":"{{subscription_id}}","description":"[Number, Optional] default base subscription for this account.
\n","type":"text"},{"key":"group_id","value":"{{group_id}}","description":"[Number, Required] account group to which this account belongs.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}","description":"Update an existing account
\nDelete an account
\nGet a list of all account groups
\n[String, Required] account group name
\n","key":"name","type":"text","value":"{{account_group_name}}"}]},"url":"{{base_url}}/api/account_group","description":"Create a new account group
\n[String, Required] account group name
\n","key":"name","type":"text","value":"{{account_group_name}}"}]},"url":"{{base_url}}/api/account_group/{{account_group_id}}","description":"Update an existing account group name
\nDelete an account group
\nGet all users associated with an account
\n[String, Required] user name for authenticating user in the system.
\n","type":"text"},{"key":"password","value":"{{password}}","description":"[String, Required] password for authenticating user in the system.
\n","type":"text"},{"key":"role_id","value":"{{role_id}}","description":"[Number, Required] role_id of user.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/users","description":"Create a new user for an account. Customers use the User Name and Password to log into VectorMax applications.
\n[String, Required] user name for authenticating user in the system.
\n","type":"text"},{"key":"password","value":"{{password}}","description":"[String, Required] password for authenticating user in the system.
\n","type":"text"},{"key":"role_id","value":"{{role_id}}","description":"[Number, Required] role_id of user.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/users/{{user_id}}","description":"Update user in an account
\nRemove a user from an account
\nGet a list of all subscriptions that have been created in the system
\nRequires prior successful session call and valid session cookie
\nRequires LISTSUBSCRIPTION permission in the role used to sign on
\nCall succeeded if success=true
\nIf successful data contains array of all subscription objects
\nparent_id:null or type:0 indicates a base subscription
\nparent_id:[id] or type:1 indicates an add-on subscription associated with the base subscription parent id
\n[Number, Required] id of the subscription to add to the account.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/subscriptions","description":"Add a subscription to an account
\n[Number] id of the subscription to add to the account. [Required]
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/subscriptions/{{subscription_id}}","description":"Remove a specific subscription from an account
\nRemove all subscriptions from an account
\nRemove a specific subscription from an account
\nGet a list of all devices
\n[String, Optional] If omitted, list of all devices is returned. Possible values are:\n\"avail\" - returns list of available devices\n - returns list of devices that contain the mattern pattern in any field
\n","type":"text/plain"},"key":"filter","value":"{{filter_value}}"}],"variable":[]}},"response":[{"id":"d51ebad4-f46b-431a-a07d-1e9e8eec2348","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/api/device"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"20640"},{"key":"ETag","value":"W/\"50a0-EUSrSH6nw4TCOaEVgwHjMBfhtNo\""},{"key":"Date","value":"Thu, 06 Feb 2020 20:07:31 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"0100956617010000065\",\n \"headend_id\": {{headend_id}},\n \"mac\": null,\n \"sn\": \"0100956617010000065\",\n \"manufacturer_sn\": \"0100956617010000065\",\n \"device_type\": \"STBUHD\",\n \"device_model\": \"A12E\",\n \"sw_version\": null,\n \"last_version_check\": null,\n \"last_ip_address\": null,\n \"account_id\": 11,\n \"client_id\": 124,\n \"last_active\": \"2019-10-14T19:25:29.685Z\"\n },\n {\n \"id\": \"0321918018466\",\n \"headend_id\": {{headend_id}},\n \"mac\": null,\n \"sn\": \"0321918018466\",\n \"manufacturer_sn\": \"0321918018466\",\n \"device_type\": \"STBUHD\",\n \"device_model\": \"Shield\",\n \"sw_version\": null,\n \"last_version_check\": null,\n \"last_ip_address\": null,\n \"account_id\": 6,\n \"client_id\": 6,\n \"last_active\": \"2019-01-11T02:09:25.494Z\"\n },\n {\n \"id\": \"0322118131591\",\n \"headend_id\": {{headend_id}},\n \"mac\": null,\n \"sn\": \"0322118131591\",\n \"manufacturer_sn\": \"0322118131591\",\n \"device_type\": \"STBUHD\",\n \"device_model\": \"Shield\",\n \"sw_version\": null,\n \"last_version_check\": null,\n \"last_ip_address\": null,\n \"account_id\": 5,\n \"client_id\": 113,\n \"last_active\": \"2020-07-08T18:00:04.332Z\"\n }\n ]\n}"}],"_postman_id":"b815b8e9-172b-4ee7-ace2-4f0ffaa7b9dc"},{"name":"Get Device","id":"4b0482d8-91b9-4c2d-a820-7f81a1fdac08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/device/{{device_id}}","description":"Get data for a specific device
\n[String, Optional] id of the device. Must be unique in the system. If omitted, serial number value will be used.
\n"},{"key":"device_model","value":"{{device_model}}","type":"text","description":"[String, Optional] device model.
\n"},{"key":"device_type","value":"{{device_type}}","type":"text","description":"[String, Required] device type e.g. STBUHD, STBHD or TV.
\n"},{"key":"sn","value":"{{device_serial_number}}","type":"text","description":"[String, Required] serial number of device. Must be unique in the system.
\n"},{"key":"mac","value":"{{device_mac_address}}","type":"text","description":"[String, Optional] mac address of device.
\n"}]},"url":"{{base_url}}/api/device","description":"Create a new device
\n[String, Optional] id of the device. Must be unique in the system. If omitted, serial number value will be used.
\n","key":"id","type":"text","value":"{{device_id}}"},{"description":"[String, Optional] device model.
\n","key":"device_model","type":"text","value":"{{device_model}}"},{"description":"[String, Required] device type.
\n","key":"device_type","type":"text","value":"{{device_type}}"},{"description":"[String, Required] serial number of device. Must be unique in the system.
\n","key":"sn","type":"text","value":"{{device_serial_number}}"},{"description":"[String, Optional] mac address of device.
\n","key":"mac","type":"text","value":"{{device_mac_address}}"}]},"url":"{{base_url}}/api/device/{{device_id}}","description":"Update an existing device
\nRequires prior successful session call and valid session cookie\nRequires prior successful creation of device\nCall succeeded if success=true
\nDelete an existing device
\nRequires prior successful session call and valid session cookie\nRequires prior successful creation of device\nCall succeeded if success=true
\n[String, Optional] VMX-assigned headend. If omitted default VMX assigned headend is used.
\n","key":"headend_id","type":"text","value":"{{headend_id}}"},{"description":"[String, Optional] Device model.
\n","key":"device_model","type":"text","value":"{{device_model}}"},{"description":"[String, Required] Device type.
\n","key":"device_type","type":"text","value":"{{device_type}}"},{"description":"[Array, Required] JSON array of device data consisting of:\n[String, Optional] id: {{device_unique_id},\n[String, Required] sn: {{device_serial_number}},\n[String, Optional] manufacturer_sn: {manufacturers_serial_number}},\n[String, Optional] mac: {{device_mac_address}}
\n","key":"devices","type":"text","value":"{{device_data_array}}"}]},"url":"{{base_url}}/api/device/import","description":"Import device JSON data
\n[Number, Required] id of device to add to account.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/devices","description":"Adds a device to an account
\n[Number, Required] id of the device to deactivate on the account.
\n","type":"text"}]},"url":"{{base_url}}/api/account/{{account_id}}/devices/{{device_id}}","description":"Removes a device from an account
\nAdds a device to an account
\nGet a list of DVR Recordings for a specific account
\n