This reference guide is intended for developers creating an interface with the Naverisk system. This is a technical document showing how to use the Naverisk API. The API uses SOAP and this document provides information required to make the SOAP requests and process the responses correctly. This document also includes examples of each call.

It is recommended to use Json.NET from http://james.newtonking.com/json which is a free third party dll to convert the response to object. It has great examples and clear documentation which can be found at:

http://james.newtonking.com/json/help/index.html?topic=html/T_Newtonsoft_Json_JsonConvert.htm# 

1.0 Authentication

1.1 Login

This operation logs in a user by passing the username and the password. This request will return a session GUID used to identify all further requests.

1.1.1 API URL

Here is the list of the API Web Services:

  • AuthenticationService.asmx
  • ClientService.asmx
  • DeviceService.asmx
  • TicketService.asmx

https://NaveriskWebsiteAddress/API/servicename

Sample Request URL:

https://cloud1.naverisk.com/API/AuthenticationService.asmx

You can use POSTMAN extension on Chrome or Firefox to access it.

  1. Enter the service URL
  2. Select request type to "POST"
  3. Click on "Headers" button, then add the following header:
    -      Header: content-type
    -      Value:text/xml; charset=utf-8
  4. For request payload, select "raw", and then select "XML"
  5. Enter the soap request xml
  6. Click "Send" button

Below is a screenshot of how the SOAP request should be structured, including the below Sample Request and response:

NOTE: If you try to access this extension from a browser as you would a regular html page, you will get a ‘file not found error’. This does not indicate that the file is inaccessible, as this file is designed to be accessible by integration applications only. 

Use URL: https://NaveriskWebsiteAddress/API/AuthenticationService.asmx

Sample Request
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<username> Username </username>
<password> Password </password>
</login>
</s:Body>
</s:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action S\s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/Login</Action>
</s:Header>

*Please remember to insert a Username and Password for your Naverisk instance into the 'Username' and 'Password' fields*

  • Parameters
  • Sample Response

{

"AuthenticationType":0,

"DateDisplayFormat":1, 

"SystemURL":"http://192.168.99.179", 

"Username":"root",

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"7bea8e3c-cddf-4a0b-8d45-8f45e10ea61e",

"LastRequestDateTime":"635102155242549563"

}

  • Properties

1.2 Logoff

This operation indicates that this session GUID is no longer required and is to be logged off.

Use URL: https://NaveriskWebsiteAddress/API/AuthenticationService.asmx

Sample Request
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Body>
<Logoff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>37177525-d2a1-43c6-87a7-5c66960fd9de>
</Logoff>
</s:Body>
</s:Envelope>
As for user who are using other Soap agent, you might need to add the below just after “” in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/Logoff</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"", 

"LastRequestDateTime":"635102158577251565"

}

  • Properties

2.0 Client Service

2.1 GetClientList

This operation gets the list of clients that the current user is allowed to see.

Use URL: https://NaveriskWebsiteAddress/API/ClientService.asmx

Sample Request
<:sEnvelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Body>
<GetClientsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
</GetClientList>
</s:Body>
</s:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetClientsList
</s:Header>

  • Parameters
  • Sample Response

{

"Keys":["1"], 

"Values":["NAV05WS2008R2"], 

“tag”:”null”,

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"d6190035-3784-4c10-8727-022386d55fba", 

"LastRequestDateTime":"635102161564407471"

}

  • Properties

2.2 GetClientDetailedList
This operation gets the detailed list of clients that the current user is allowed to see.

Use URL: https://NaveriskWebsiteAddress/API/ClientService.asmx

Sample Request

<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetClientDetailedList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
</GetClientDetailedList>
</s:Body>
</s:Envelope>

As for users who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetClientDetailedList</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"List":[{

"LicenseType":"Standard", 

"ClientTypeID":1, 

"ParentID":"", 

"Name":"NAV05WS2008R2", 

"DisplayName":"NAV05WS2008R2", 

"CombinedID":"1", 

"PrimaryIdentifier":1

}], 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"d6190035-3784-4c10-8727-022386d55fba", 

"LastRequestDateTime":"635102162981268801"

}

  • Properties

2.3 GetChildClientsList

This operation gets all the child clients of a given client.

Use URL: https://NaveriskWebsiteAddress/API/ClientService.asmx

Sample Request
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Body>
<GetChildClientsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
<clientID>1</clientID>
</GetChildClientList>
</s:Body>
</s:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetChildClientsList</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"Keys":[“2”, “3”], 

"Values":[“ClientName2”, “ClientName3”], 

"tag":null,

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"d6190035-3784-4c10-8727-022386d55fba", 

"LastRequestDateTime":"635102163800993292"

}

  • Properties

2.4 GetParentAndChildClientsList

This operation gets the parent client and all the child client of a given client.

Use URL: https://NaveriskWebsiteAddress/API/ClientService.asmx

Sample Request
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">
<s:Body>
<GetParentAndChildClientsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
<clientID>1</clientID>
<GetParentAndChildClientsList>
</s:Body>
</s:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetParentAndChildClientsList</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"Keys":["1", “4”, “5”], 

"Values":["NAV05WS2008R2", “ClientName4”, “ClientName5”], 

"tag":null,

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"d6190035-3784-4c10-8727-022386d55fba", 

"LastRequestDateTime":"635102164382854732"

}

  • Properties

3.0 Device Service

3.1 GetDeviceList

This operation gets the list of devices that the given client is allowed to see.

Use URL: https://NaveriskWebsiteAddress/API/DeviceService.asmx

Sample Request
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetDeviceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
<clientID>1</clientID>
</GetDeviceList>
</s:Body>
</s:Envelope>

As for users who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetDeviceList</Action>
</s:Header>

  • Parameters

{

"Keys":["1_1"], 

"Values":["Site Controller Agent"], 

"tag":null,

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"ab49eaea-5b5d-4ad8-ad4c-52d535cc7f5e", 

"LastRequestDateTime":"635102182541879992"

}

  • Properties

3.2 GetClientDeviceList

This operation gets the list of device objects owned by the client with option to only include devices with agent and/or include SNMP devices.

Use URL: https://NaveriskWebsiteAddress/API/DeviceService.asmx

Sample Request
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetClientDeviceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>b8f4c2fb-6fb2-4ad5-a75a-673bb8838273</sessionGuid>
<clientID>4</clientID>
<DeviceWithAgent>true</DeviceWithAgent>
<includeSNMPDevice>true</includesSNMPDevice>
</GetClientDeviceList>
</s:Body>
</s:Envelope>

As for users who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetClientDeviceList</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"List":[

{"DeviceID":100, 

"SNMPScanning":false, 

"SNMPScanStartTime":null,

"ClientID":4, 

"RCUser":"", 

"LastUserName":"terryhuang",

"ThirdPartyRCLink":"", 

"RCInfo":"<RCInfo SConnectGuid="54e4051b-2c6a-494f-886a-e789002abd33" TVClientID="" />",

"RCConnectGUID":"54e4051b-2c6a-494f-886a-e789002abd33",

"RCTVClientID":"",

"AlertProfileCombinedID":"", 

"AlertProfileName":"", 

"Agent":{

"AgentID":67, 

"ClientID":4, 

"FullAgentStatusMessage":"Standard Agent Disconnected",

"AgentVersion":"1.0.0.0",

"IsNetworkControllerAgent":false,

"FeatureLevel":0, 

"ScreenWidth":1,

"ScreenHeight":1, 

"UpTime":114,

"NeedsReboot":false, 

"IsVNCInUse":false, 

"IsVNCInstalling":false, 

"AllowedRCMethods":0,

"UpTimeSetTime":1405374789588,

"FQDN":"WIN-CSJTDBIP1N9", 

"HostName":"WIN-CSJTDBIP1N9"

, "LastConnected":1400477686000, 

"CreatedOn":1400213293000,

"IsLicensed":true, 

"PreferredRCViewer":"RDPN", 

"NetworkControllerCombinedID":"1_1", 

"PreferredNetworkControllerCombinedID":"1_1",

"AgentType":1,

"SecondaryIdentifier":4,

"IsNew":false, 

"CombinedID":"67_4",

"PrimaryIdentifier":67},

"Snmp":null, 

"AgreementInherited":null, 

"AgreementName":"", 

"AgreementNameInherited":"", 

"AgreementID":"", 

"AgreementIDInherited":"",

"IPAddress":"192.168.226.128", 

"ExtIPAddress":"192.168.99.93",

"MacAddress":"00-0C-29-3F-6D-23", 

"ActiveMACAddress":"",

"SerialNumber":"VMware-56 4d 3e 7a 2a 0e c4 ce-0f dd 30 93 a0 13 75 0c",

"Name":"WIN-CSJTDBIP1N9", 

"Description":"", 

"ShortNotes":"",

"OperatingSystem":"Microsoft Windows 7 Professional",

"IsMaintenanceMode":false, 

"MaintenanceMode":0, 

"Model":"VMware Virtual Platform", 

"Remarks":"<Hardware><CPU><Processor>AMD A8-6600K APU with Radeon(tm) HD Graphics</Processor></CPU><Memory></Memory><HDD></HDD><HDD></HDD><OSInfo></OSInfo></Hardware>",

"DeviceReference":"", 

"LogonUserName":"", 

"LogonPassword":"",

"SecurityDetail":"",

"SecurityEnabled":false,

"ClientName":"def new name2", 

"DeviceTypeName":"Servers / Windows", 

"LocationName":"", 

"AgentStatusMessage":"Disconnected", 

"FullAgentStatusMessage":"Standard Agent Disconnected",

"AgentStatusID":4, 

"DeviceRCViewer":"RDPN",

"PatchingTicketID":0, 

"SecondaryIdentifier":4,

"IsNew":false,

"CombinedID":"100_4", 

"PrimaryIdentifier":100},

{"DeviceID":96, 

"ClientID":4, 

"RCUser":"", 

"LastUserName":"terryhuang", 

"ThirdPartyRCLink":"", 

"AlertProfileCombinedID":"",

"AlertProfileName":"", 

"Agent":{

"AgentID":64, 

"ClientID":4,

 "FullAgentStatusMessage":"Standard Agent Disconnected", 

"AgentVersion":"1.0.6.0",

 "IsNetworkControllerAgent":false,

 "FeatureLevel":0, 

"ScreenWidth":1024, 

"ScreenHeight":768,

 "UpTime":136, 

"NeedsReboot":false, 

"UpTimeSetTime":1405374789588, 

"FQDN":"WIN-NG5QRKILD34", 

"HostName":"WIN-NG5QRKILD34", 

"LastConnected":1390517561000,

 "CreatedOn":1389229247000,

 "IsLicensed":true,

 "PreferredRCViewer":"RDPN",

 "NetworkControllerCombinedID":"1_1",

 "PreferredNetworkControllerCombinedID":"1_1",

 "AgentType":1, 

"SecondaryIdentifier":4,

 "IsNew":false,

 "CombinedID":"64_4", 

"PrimaryIdentifier":64},

 "Snmp":null,

 "AgreementInherited":null,

 "AgreementName":"",

 "AgreementNameInherited":"", 

"AgreementID":"",

 "AgreementIDInherited":"",

 "IPAddress":"192.168.149.129", 

"ExtIPAddress":"192.168.99.58", 

"MacAddress":"00-0C-29-84-8B-4C",

"SerialNumber":"VMware-56 4d 3e 7a 2a 0e c4 ce-0f dd 30 93 a0 13 75 0c",

 "Name":"WIN-NG5QRKILD34", 

"Description":"", 

"OperatingSystem":"",

 "IsMaintenanceMode":false, 

"MaintenanceMode":0, "Model":"",

 "Remarks":"",

 "DeviceReference":"",

 "LogonUserName":"",

 "LogonPassword":"",

 "ClientName":"def new name2",

 "DeviceTypeName":"Servers / Windows",

 "LocationName":"",

 "AgentStatusMessage":"Disconnected",

 "FullAgentStatusMessage":"Standard Agent Disconnected",

 "AgentStatusID":4,

 "DeviceRCViewer":"RDPN", 

"PatchingTicketID":0,

 "SecondaryIdentifier":4, 

"IsNew":false,

 "CombinedID":"96_4", 

"PrimaryIdentifier":96}],

 "PrimaryIdentifier":0,

 "Error":"", 

"Success":true, 

"ClientID":1,

 "SessionGuid":"ec0d5a47-9c50-4320-a75c-750d2f7401ac",

 "LastRequestDateTime":"635410173555950422"

}

  • Properties

3.3 GetDeviceDetails

This operation gets the particular device that the user is requesting.

Use URL: https://NaveriskWebsiteAddress/API/DeviceService.asmx

Sample Request

<s:Envelope xlms:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetDeviceDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="htpp://Iris.net">
<clientID>1</clientID>
<deviceID>1</deviceID>
</GetDeviceDetails>
</s:Body>
</s:Envelope>

As for users who are using other Soap agent, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetDeviceDetails</Action>
</s:Header>

  • Parameters
  • Response

Sample Response

{"NetworkControllers":[

{"Key":"1_1", 

"Value":"Global NC"}], 

"CannedTextReplacers":[

"Agent installed on the Site Controller", "Device.Description",

 "Site Controller Agent", "Device.Name",

"Site Controller Agent", "DeviceName",

"Servers / Windows / Server 2008 R2", "DeviceTypeName", 

"agreement 10","Agreement", 

"agreement 10", "AgreementInherited",

 "", "BusinessSystemNames",

 "192.168.99.93, 192.168.159.1, 192.168.226.1", "Device.IPAddress", 

"74-D4-35-92-73-53, 00-50-56-C0-00-01, 00-50-56-C0-00-08", "Device.MacAddress",

 "N/A (Disconnected)", "Device.CurrentUser",

 "1/7/2014 12:00:00 AM", "Device.PurchaseDate",

 "1/7/2015 12:00:00 AM", "Device.WarrantyExpiry",

 "2/13/2016 12:00:00 AM", "Device.LeaseExpiry", 

"None", "Device.ServiceTag", 

"VMware-56 4d 3e 7a 2a 0e c4 ce-0f dd 30 93 a0 13 75 0c","Device.SerialNumber",

 "", "Device.Notes",

 "Microsoft Windows 7 Professional", "Device.OperatingSystem",

 "VMware Virtual Platform", "Device.Model",

 "<Hardware><CPU><Processor>AMD A8-6600K APU with Radeon(tm) HD Graphics</Processor></CPU><Memory></Memory><Memory></Memory><HDD></HDD><OSInfo></OSInfo></Hardware>", "Device.Remarks",

 "No", "Device.IsMaintenanceMode",

 "", "Device.WarrantyType", 

"", "Device.Supplier",

"", "Device.Location",

 "", "Device.LifeCycleState",

 "", "Device.DeviceClassName", 

"Dell", "Device.Vendor", 

"1", "OwnerClient.ClientTypeID", 

"x64-2008R2", "OwnerClient.Name",

 "x64-2008R2", "OwnerClient.Description",

 "", "OwnerClient.Industry",

 "New Zealand Standard Time;720;(UTC+12:00) Auckland, Wellington;New Zealand Standard Time;New Zealand DaylightTime;[01:01:0001;12:31:2006;60;[0;02:00:00;10;1;0;];[0;03:00:00;3;3;0;];][01:01:2007;12:31:2007;60;[0;02:00:00;9;5;0;];[0;03:00:00;3;3;0;];][01:01:2008;12:31:9999;60;[0;02:00:00;9;5;0;];[0;03:00:00;4;1;0;];];", "OwnerClient.TimeZoneOffset", 

"No", "OwnerClient.IsMaintenanceMode",

 "-2147483648", "OwnerClient.SecurityWarningDelay",

 "-2147483648", "OwnerClient.SecurityThreatDelay",

 "-2147483648", "OwnerClient.SecurityFailureDelay",

 "CAPICOM; Critical Updates; Definition Updates; Drivers; Feature Packs; Update Rollups; Updates;", "OwnerClient.PatchCategoryExceptions", 

"Drivers; Feature Packs; Service Packs;", "OwnerClient.PatchCategoryAuthorisations",

 "Standard", "OwnerClient.LicenseType",

 "aaa bbb", "OwnerClient.PrimaryContact.DisplayName",

 "abgdfeg@naverisk.com", "OwnerClient.PrimaryContact.Email",

 "6 Arawa st, Grafton, Auckland", "OwnerClient.BillingAddress",

 "1234", "OwnerClient.PrimaryContact.Phone",

 "567834", "OwnerClient.PrimaryContact.Mobile", 

"Developer", "OwnerClient.PrimaryContact.Role"],  "Object":{

"Snmp":null, 

"SNMPScanning":false, 

"IsProbe":false,

"SNMPScanStartTime":null,

"NetworkControllerID":1,

"NetworkControllerClientID":1,

"NetworkControllerCombinedID":"1_1",

"NetworkControllerName":"Global NC",

"NetworkControllerStatusID":3,

"PreferredNetworkControllerName":"", 

"PreferredNetworkControllerID":0, 

"PreferredNetworkControllerClientID":0,

"PreferredNetworkControllerCombinedID":"",

"IsLicensed":true,

"Name":"Site Controller Agent",

"Description":"Agent installed on the Site Controller",

 "ThirdPartyRCLink":"", 

"RCInfo":"",

"AgentID":1, 

"AgentFeatureLevel":3, 

"AgentType":1,

 "DeviceRCViewer":"", 

"DeviceStatus":"The Device has one or more Threat SLA Tickets",

 "DeviceStatusID":5,

 "PatchingTicketID":0,

 "Location":"",

 "LocationID":0, 

"DeviceType":"Servers / Windows / Server 2008 R2",

 "DeviceTypeID":7,

 "Agreement":"agreement 10",

 "AgreementID":"15_1", 

"AgreementNameInherited":"agreement 10",

 "AgreementIDInherited":"15_1",

"AgreementIDClientInherited":"",

 "AgreementNameClientInherited":"",

"AgreementAlertState":1,

 "Vendor":"Dell", 

"VendorID":5, 

"BusinessSystemNames":"", 

"RoleNames":"",

 "OwnerID":0, 

"Owner":"", 

"LifeCycleStateID":0,

 "LifeCycleState":"",

 "SupplierID":0, 

"Supplier":"",

 "WarrantyTypeID":0,

 "WarrantyType":"", 

"IPAddress":"192.168.99.93, 192.168.159.1, 192.168.226.1",

 "ExtIPAddress":"127.0.0.1",

 "MacAddress":"74-D4-35-92-73-53, 00-50-56-C0-00-01, 00-50-56-C0-00-08",

 "HostName":"NAVPC17",

 "LogonUserName":"",

 "LogonPassword":"",

 "AgentStatusID":4,

 "AgentStatusMessage":"Agent Disconnected ",

 "FullAgentStatusMessage":"Advanced Agent Disconnected", 

"DeviceClassID":0, 

"DeviceClassName":"", 

"Version":"1.0.0.0",

 "IsNetworkControllerAgent":true, 

"DeviceUpTime":"19 Hours, 54 Minutes", 

"DeviceUpTimeLive":"21 Hours, 38 Minutes",

 "DeviceUpTimeInt":779240559715,

 "AgentLastConnected":"20 Days, 21 Hours, 17 Minutes", 

"AgentLastConnectedDate":1403576375000, 

"FQDN":"NAVPC17.Crest.local",

 "CurrentUser":"N/A (Disconnected)", 

"PurchaseDate":1389006000000, 

"PurchaseDateString":"Jan 7 2014 00:00:00", "

PurchaseDateStringSeparateByComa":"2014,1,7,0,0,0", 

"WarrantyExpiry":1420542000000, 

"WarrantyExpiryString":"Jan 7 2015 00:00:00", 

"WarrantyExpiryStringSeparateByComa":"2015,1,7,0,0,0",

 "LeaseExpiry":1455274800000,

 "LeaseExpiryString":"Feb 13 2016 00:00:00",

 "LeaseExpiryStringSeparateByComa":"2016,2,13,0,0,0", 

"ServiceTag":"None",

 "SerialNumber":"VMware-56 4d 3e 7a 2a 0e c4 ce-0f dd 30 93 a0 13 75 0c",

 "Notes":"",

 "Model":"VMware Virtual Platform", 

"IsMaintenanceMode":false,

 "MaintenanceMode":0,

 "NeedsReboot":false,

"IsClientUsingGlobalPassword":true,

 "ClientID":1, 

"ClientName":"x64-2008R2",

 "ClientInMaintenanceMode":false, 

"IsGlobalRCPasswordSet":true, 

"VNCState":{

"AgentID":1,

 "ClientID":1, 

"DeviceID":1, 

"AgentStatusID":4,

 "IsAgentLicensed":true,

 "HasVNCInstalled":true, 

"IsVNCInUse":false, 

"IsRemoteControlInstalling":false,

 "CanInstallVNC":true, 

"AllowedMethodsWithWarnings":2, 

"RCOptionList":

[

{"Code":"RDPN", "DisplayName":"Native RDP", "SLAClass":0}, 

{"Code":"RDPNA", "DisplayName":"Native RDP (Admin)", "SLAClass":0}, 

{"Code":"VNCN", "DisplayName":"Native VNC", "SLAClass":0},

{"Code":"TVRC", "DisplayName":"Team Viewer", "SLAClass":3}, 

{"Code":"EXT", "DisplayName":"External Remote Control", "SLAClass":3},

{"Code":"VNC", "DisplayName":"Java Interactive VNC", "SLAClass":0}

], 

"CanVNC":true, 

"CanRDP":true, 

"AgentCanRDP":true, 

"AgentCanVNC":true, 

"AgentCanSConnect":false, 

"AgentCanTViewer":false,

"AgentCanSplashtop":false,

"SecondaryIdentifier":1,

 "TertiaryIdentifier":1, 

"CombinedID":"1_1_1", 

"PrimaryIdentifier":1},

 "RCUser":"",

"RCOptionList":

[

{"Code":"RDPN", "DisplayName":"Native RDP", "SLAClass":0}, 

{"Code":"RDPNA", "DisplayName":"Native RDP (Admin)", "SLAClass":0}, 

{"Code":"VNCN", "DisplayName":"Native VNC", "SLAClass":0},

{"Code":"TVRC", "DisplayName":"Team Viewer", "SLAClass":3},

{"Code":"EXT", "DisplayName":"External Remote Control", "SLAClass":3}, 

{"Code":"VNC", "DisplayName":"Java Interactive VNC", "SLAClass":0}],

"CanVNC":true, 

"CanRDP":true, 

"ActiveMAC":"00-18-8B-80-19-98",

"ScreenConnectURL":"/Host#All%20Machines///Join",

"AlertProfileCombinedID":"",

"AlertProfileName":"",

"LastUserName":"terryhuang",

"SecurityDetail":"",

"SecurityEnabled":false,

"SecurityUpdated":false,

"SoftwareListShort":"Igor Pavlov / 7-Zip 9.20 (x64 edition) / 9.20.00.0\nAdvanced Micro Devices, Inc. / AMD Catalyst Inst",

"SecondaryIdentifier":1,

"IsNew":false,

"CombinedID":"1_1",

"PrimaryIdentifier":1},

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"b3703cf2-df7e-43b3-b802-91e77f527b04",

"LastRequestDateTime":"635410210269360747"}

  • Properties

3.4 ChangeDeviceMaintenanceMode

This operation sets the device(s) in and out of maintenance mode.

Use URL: https://NaveriskWebsiteAddress/API/DeviceService.asmx

Sample Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ChangeDeviceMaintenanceMode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
<clientID>1</clientID>
<DeviceListEnable>2_1,3_1</DeviceListEnable>
<DeviceListDisable>4_1,5_1</DeviceListDisable>
<DeviceListPerformance>6_1,7_1</DeviceListPerformance>
</ChangeDeviceMaintenanceMode>
</s:Body>
</s:Envelope>

As for user who are using other Soap agents, you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetAgentDeviceList</Action>
<s:Header>

  • Parameters
  • Sample Response

{

"Error":"", 

"Success":true,

"ClientID":1,

"SessionGuid":"9cbc37ba-fc01-4cb3-a686-cf0c59cd53e9",

"LastRequestDateTime":"635519932920214660"

}

  • Properties

3.5 GetAgentDeviceList

This operation gets the list of devices that have agents attached, that the current user is allowed to see.

Use URL: https://NaveriskWebsiteAddress/API/DeviceService.asmx

Sample Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetAgentDeviceList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://Iris.net">
<sessionGuid>d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
<clientID>1</clientID>
</GetAgentDeviceList>
</s:Body>
</s:Envelope>

As for users who are using other Soap Agent. you might need to add the below just after "<s:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetAgentDeviceList</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"Keys":["1_1"], 

"Values":["Site Controller Agent"], 

"tag":null,

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"ab49eaea-5b5d-4ad8-ad4c-52d535cc7f5e", 

"LastRequestDateTime":"635102183085398996"

}

  • Properties

4.0 Ticket Service

4.1 GetTicketList

This operation gets the list of tickets that the current user is allowed to see.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTicketList xmlns="http://Iris.net">
<itemCount>25</itemCount>
<start>0</start>
<sort>2</sort>
<sortColumn>212</sortColumn>
<includeStates>1,2</includeStates>
<userSpecific>false</userSpecific>
<monitorList>true</monitorList>
<clientIDFilter>1</clientIDFilter>
<UserIDFilter>2</UserIDFilter>
<agreementIDFilter>Managed</AgreementIDFilter>
<SourceIDFilter>Monitoring Alert</SourceIDFilter>
<PriorityIDFilter>High</PriorityIDFilter>
<JobTypeIDFilter>Account management</JobTypeIDFilter>
<CategoryIDFilter>LAN</CategoryIDFilter>
<StatusIDFilter>In Progress</StatusIDFilter>
<DeviceTypeIDFilter>Server / WIndows /Server 2008 R2</DeviceTypeIDFilter>
<SLAClassIDFilter>1</SLAClassIDFilter>
<SubSourceIDFilter>3</SubSourceIDFilter>
<isBillableFilter>2</IsBiliableFilter>
<LocationFilter></LocationFilter>
<TicketNumber></TicketNumber>
<TriggerFilter></TriggerFilter>
<PersonFilter></PersonFilter>
<ScheduledFilter>100</ScheduledFilter>
<DeviceNameFilter></DeviceNameFilter>
<consoleType>0</consoleType>
<clearPreviousMonitors>true</clearPreviousMonitors>
<sessionGuid> d6190035-3784-4c10-8727-022386d55fba</sessionGuid>
</GetTicketList>
</soap:Body>
</soap:Envelope>

As for user who are using other Soap agents, you might need to add the below just after "<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetTicketList </Action>
</s:Header>

  • Parameters
  • Sample Response
  • Properties

4.2 CloseTicketList

This operation closes the ticket with the current user as the User who actioned the close.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request:
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CloseTicketList xmlns:xsi="http://Iris.net">
<eventIDList>1_1</eventIDList>
<notes>some notes</notes>
<sessionGuid>841d7ae3-bd36-4052-9f32-1dcd513d3d5</sessionGuid>
</loseTicketList>
</soap:Body>
</soap:Envelope>


as for users who are using other Soap agent, you  might need to add the below just after "<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/

CloseTicketList
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":-1, 

"CombinedID":"", 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"841d7ae3-bd36-4052-9f32-1dcd513d3d5c",

"LastRequestDateTime":"635108407550359153"

}

  • Properties

4.3 CreateSalesTicket

This operation creates a Sales Ticket.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request

<soap:Envelope xmlns="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>

<CreateSalesTickets xmlns="http://Iris.net">
<clientID>1</clientID>
<incidentCombinedID>9_1</incidentCombinedID>
<slaStatusID>5</slaStatusID>
<description>some description</description>
<from>sender@someCompany.com</from>
<to>receiver@someCompany.com</to>
<emailSubject>subject</emailBody>
<sendEmail>true</sendEmail>
<sessionGuid>841d7ae3-bd36-4052-9f32-1dcd513d3d5c</sessionGuid>
</CreateSalesTicket>
</soap:Body>
</soap:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing.none">http://Iris.net/CreateSalesTicket
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":3394, 

"CombinedID":”3394_1", 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"841d7ae3-bd36-4052-9f32-1dcd513d3d5c", 

"LastRequestDateTime":"635108419917051738"

}

  • Properties

4.4 CreateManualTicket

This operation creates a manual ticket.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateManualTicket xmlns="http://Iris.net">
<incidentID>0</incidentID>
<clientID>1</clientID>
<deviceID>1_1</deviceID>
<slaClassID>1</slaClassID>
<slaStatusID>5<slaStatusID>
<trigger>trigger</trigger>
<TicketIncidentStateID>1</TicketIncidentStateID>,
<description>description</description>

As for user who are using other Soap agent, you might need to add the below just after "<soap:Body>" in the request.

<s:header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/CreateManualTicket
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":, 

"CombinedID":"9_1", 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"841d7ae3-bd36-4052-9f32-1dcd513d3d5c",

 "LastRequestDateTime":"635108416513374184"

}

  • Properties

4.5 CreateManualTicketForDevices

This operation creates a manual ticket for given devices

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateManualTicketForDevices xmlns="http://Iris.net">

As for user who are using other Soap agent, you might need to add the below just after"<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/CreateManualTicketForDevices>
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":-1, 

"CombinedID":"", 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"58b520c7-622d-4cc2-853e-1a18e763c3d3", 

"LastRequestDateTime":"635110201262940297"

}

  • Properties

4.6 AddNoteToTicketList

This operation adds notes to an existing Ticket.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schema.xmlsoap.org/soap/envelope/">
<soap:Body>
<AddNoteToTicketsList xmlns="http://Iris.net">
<eventIDList>3_1</eventIDlist>
<notes>add notes ticket from API</notes>
<sessionGuid>bd6873c1-d2fd-42f1-a79e-02640a172dcd</sessionGuid>
</AddNoteToTicketList>
</soap:Body>
</soap:Envelope>

As for user who are using the Soap agent, you might need to add the below just after "<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/AddNoteToTicketList
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":8, 

"CombinedID":"8_1_3_1", 

"Error":"", 

"Success":true, 

"ClientID":1, 

"SessionGuid":"bd6873c1-d2fd-42f1-a79e-02640a172dcd", 

"LastRequestDateTime":"635313799225676618"

}

  • Properties

4.7 AddHistoryNoteToTicket

This operation adds Time/Expense notes to existing Ticket.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlcosp.org/soap/envelope/">
<soap:Body>
<addHistoryNotesToTicket xmlns="http://Iris.net">
<incidentCombinedID>3_1</incidentCombinedID>
<noteType>3</noteType>
<notes>add notes ticket from API</notes>
<isBillable>true</isBillable>
<duration>24</duration>
<startDateTime>2014-03-25</startDateTime>
<agreementCombinedID></agreementCombinedID>
<costPerHour>5</costPerHour>
<technicianCombinedID>1_1</technicianCobinedID>
<expenseAmount>0</expenseAmount>
<sessionGuid>bd6873c1-d2fd-42f1-a79e-02640a172dcd</sessionGuid>
</AddHistoryNotesToTicket>
</soap:Body>
</soap:Envelope>

As for user who are using other Soap agent, you might need to add the below just after "<soap:Body>" in the request.

<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://Iris.net/AddHistoryNotesToTicket </Action>
</s:Header>

  • Parameters
  • Sample Response

{

"PrimaryIdentifier":2,

 "CombinedID":"2_1_3_3", 

"Error":"", 

"Success":true,

 "ClientID":1, 

"SessionGuid":"bd6873c1-d2fd-42f1-a79e-02640a172dcd", 

"LastRequestDateTime":"635313798222998897"

  • Properties

4.8 GetTicketHistories

This operation gets the history list of the ticket.

Use URL: https://NaveriskWebsiteAddress/API/TicketService.asmx

Sample Request
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetTicketHistory xmlns="http://Iris.net">
<incidentID>3319</incidentID>
<iClientid>1</iClientid>
<sessionGuid>bd6873c1-d2fd-42f1-a79e-02640a172dcd</sessionGuid>
</GetTicketHistory>
</soap:Body>
</soap:Envelope>

As for user who are using other Soap agent, you might nee to add the below just after "<soap:Body>" in the request.

<S:Header>
<Action s:mustUnderstand="1" xmlns="http://microsoft.com/ws/2005/05/addressing/none">http://Iris.net/GetTicketHistory
</Action>
</s:Header>

  • Parameters
  • Sample Response

{

"List":[

{"ClientID":1, 

"FileIDs":"",

 "FileCount":0,

 "IncidentID":3319, 

"IncidentCombinedID":"3319_1",

 "HistoryTypeID":1,

 "HistoryTypeName":"History",

 "Username":"root",

 "TechnicianName":"", 

"TechnicianCombinedID":"",

"IncidentStateName":"Unassigned",

 "IncidentStateID":1, 

"SeverityName":"Failure",

 "SeverityID":3, 

"Action":"This field has been modified: SLA Status (before: "Information").", "WhenActioned":1417141772000, 

"WhenActionedString":"Nov 28 2014 15:29:32",

 "IsBillable":null,

 "Duration":null, 

"DurationString":"",

 "StartDateTime":null, 

"StartDateTimeString":"",

 "Agreement":null,

 "CostPerHour":null, 

"TimeAmount":0, 

"ExpenseAmount":null,

 "Expense":null,

 "ShortSummary":"This field has been modified: SLA Status (before: "Information").", 

"IsPublic":true,

"InvoiceID":null,

 "SecondaryIdentifier":1, 

"TertiaryIdentifier":3319, 

"QuaternaryIdentifier":1, 

"CombinedID":"10280_1_3319_1",

 "PrimaryIdentifier":10280}, 

{"ClientID":1, 

"FileIDs":"",

 "FileCount":0, 

"IncidentID":3319,

 "IncidentCombinedID":"3319_1", 

"HistoryTypeID":1, 

"HistoryTypeName":"History",

 "Username":"root", 

"TechnicianName":"", 

"IncidentStateName":"Unassigned", 

"IncidentStateID":1,

 "SeverityName":"Information",

 "SeverityID":5,

 "Action":"mmsp failure ticket with 5 minutes reminder timer desc", 

"WhenActioned":1417141538000, 

"WhenActionedString":"Nov 28 2014 15:25:38", 

"IsBillable":null, 

"Duration":null, 

"DurationString":"", 

"StartDateTime":null, 

"StartDateTimeString":"",

 "Agreement":null, 

"CostPerHour":null,

 "TimeAmount":0,

 "ExpenseAmount":null,

 "Expense":null, 

"ShortSummary":"mmsp failure ticket with 5 minutes reminder timer desc",

 "IsPublic":true, 

"SecondaryIdentifier":1, 

"TertiaryIdentifier":3319, 

"QuaternaryIdentifier":1, 

"CombinedID":"10278_1_3319_1", 

"PrimaryIdentifier":10278}],

 "Error":"",

 "Success":true, 

"ClientID":1, 

"SessionGuid":"fe98675a-14eb-4693-b75d-145a40df19f0",

 "LastRequestDateTime":"635543407779075096"

}

  • Properties

5.0 API Call Test Application

We have a simple tool that can test the API requests, please download this tool from the link below:

http://docs.naverisk.com/Resources/NavFiles/APIcall.zip

This tool has 2 API methods (Login and GetTicketList) implemented which will give you an idea as a developer on how to interact with Naverisk in order to get data from the database.

In order to utilise this tool:

  1. You will need to have Naverisk install (Onsite or Cloud), so the web methods are running and able to be consumed by the tool.
  2. Have the correct credentials so it can get the Logged in session GUID in order to get the list of tickets.
  3. Extract the downloaded zip file to a location or your choosing.
  4. Navigate to API call/Bin/Debug and execute API call.exe

5. Once API call.exe has been executed you will be presented with the below screen:

6. In the Authentication WS filed you will need to insert your own web service address along with your own Username Password that you use to access you Naverisk website.
7. The Ticket WS field is where you will insert your TicketService.asmx that corresponds with your own Naverisk web service.


Below is an example of a correctly filled ticket request and result:

If you encounter issues, please ensure that when inserting your own URL that is the correct format and the correct login credentials as per the above screenshot.

https://qatest.naverisk.com/API/AuthenticationService.asmx

https://qatest.naverisk.com/API/TicketService.asmx
This excludes the unnecessary 'WebSite' that is initially included when you execute the APIcall.exe

Did this answer your question?