SoM Remote Office


This API lists all the remote offices and their details

  • Functionality
  • Retrieve the remote office list.
  • HTTP Method
  • GET
  • API URI
  • api/1.3/som/remoteoffice
  • Response Parameters
  • compression_type:

    1 - Best
    0 - Fast

    colorquality_type:

    24 - True color
    16 - High
    8   - Medium
    4   - Low

    ds_status:

    21 - Yet to install
    22 - Agent installed
    23 - Agent uninstalled

Response Data


{
"message_response": {
"total": 3,
"limit": 25,
"remoteoffice": [
{
"ds_status": "--",
"error_code_kb_url": "--",
"remarks": "--",
"colorquality_type": 16,
"agent_arc_loc": "--",
"updated_time": "--",
"has_masteragent": false,
"ds_port": "--",
"is_https": "--",
"proxy_username": "--",
"polling_int": "--",
"last_contact_time": "--",
"is_proxy": "--",
"branch_office_id": "--",
"agent_comm_branch_office_id": "--",
"ds_dns_name": "--",
"ds_https_port": "--",
"branch_office_customer_id": 1,
"proxy_port_number": "--",
"proxy_details_branch_office_id": "--",
"error_kb_url": "--",
"customer_name": "DC_CUSTOMER",
"compression_type": 0,
"error_code": "--",
"ds_version": "--",
"managed_computers": 5,
"proxy_server_name": "--",
"branch_office_name": "Local Office",
"ds_sync_status": "--",
"data_transfer_rate": "--",
"resource_id": "--",
"ds_ipaddress": "--",
"branch_office_desc": "--",
"resource_name": "--",
"customer_id": 1
},
{
"ds_status": 22,
"error_code_kb_url": "--",
"remarks": "dc.db.ds.replication.status.incomplete",
"colorquality_type": 16,
"agent_arc_loc": "",
"updated_time": 1449563303959,
"has_masteragent": true,
"ds_port": "8021",
"is_https": false,
"proxy_username": "",
"polling_int": "2",
"last_contact_time": 1450769259658,
"is_proxy": false,
"branch_office_id": 301,
"agent_comm_branch_office_id": 301,
"ds_dns_name": "",
"ds_https_port": "8384",
"branch_office_customer_id": 1,
"proxy_port_number": 80,
"proxy_details_branch_office_id": 301,
"error_kb_url": "--",
"customer_name": "DC_CUSTOMER",
"compression_type": 1,
"error_code": 10002,
"ds_version": "9.1.95",
"managed_computers": 1,
"proxy_server_name": "",
"branch_office_name": "Intern Ds Remote",
"ds_sync_status": 102,
"data_transfer_rate": 0,
"resource_id": 310,
"ds_ipaddress": "172.21.170.252",
"branch_office_desc": "--",
"resource_name": "REC-INTERN1",
"customer_id": 1
},
{
"ds_status": "--",
"error_code_kb_url": "--",
"remarks": "--",
"colorquality_type": 16,
"agent_arc_loc": "",
"updated_time": "--",
"has_masteragent": false,
"ds_port": "--",
"is_https": false,
"proxy_username": "",
"polling_int": "2",
"last_contact_time": "--",
"is_proxy": false,
"branch_office_id": "--",
"agent_comm_branch_office_id": 601,
"ds_dns_name": "--",
"ds_https_port": "--",
"branch_office_customer_id": 1,
"proxy_port_number": 80,
"proxy_details_branch_office_id": 601,
"error_kb_url": "--",
"customer_name": "DC_CUSTOMER",
"compression_type": 1,
"error_code": "--",
"ds_version": "--",
"managed_computers": "--",
"proxy_server_name": "",
"branch_office_name": "Direct Comm",
"ds_sync_status": "--",
"data_transfer_rate": 0,
"resource_id": "--",
"ds_ipaddress": "--",
"branch_office_desc": "--",
"resource_name": "--",
"customer_id": 1
}
],
"page": 1
},
"status": "success",
"message_version": "1.0",
"message_type": "remoteoffice"
}