Virima API Specification - CustomerService Services

The requests documented in this section are directed to CustomerService resources, which represent .

Contents

1 editCustomerDetails POST Interface
2 addHoliday POST Interface
3 getCustomerIcon GET Interface
4 addOperationalHour POST Interface
5 isProcessingJobsRunning GET Interface
6 isNetworkConnectionProcessing GET Interface
7 isVCenterHierarchyprocessing GET Interface
8 isLicenseKeyProcessing GET Interface
9 saveStorageType POST Interface
10 getGoogleAuthenticateUrl POST Interface
11 saveServiceNowCredential POST Interface
12 getServiceNowCredential GET Interface

editCustomerDetails POST Interface

Method: POST

Relative URL: customer/edit

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
customer	Customer

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITCUSTOMERDETAILS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "name":"?",
   "description":"?",
   "address":"?",
   "city":"?",
   "postalCode":"?",
   "state":"?",
   "country":"?",
   "phone":"?",
   "fax":"?",
   "url":"?",
   "email":"?",
   "logo":"?",
   "currency":"?",
   "customerId":?,
   "discoveryServerName":"?",
   "storageType":"?",
   "awsAccessKey":"?",
   "awsSecretKey":"?",
   "locationPath":"?",
   "googleClientId":"?",
   "googleClientSecret":"?",
   "dropBoxAccessToken":"?",
   "mspVendorId":?,
   "mspClientType":"?",
   "mspClientId":"?",
   "defaultLandingPage": {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      },
   "timezone":?,
   "allowUploadLogo":?,
   "isDefaultITSMNotificationEnabled":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addHoliday POST Interface

Method: POST

Relative URL: customer/holiday

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	Holiday

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDHOLIDAY 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "date":?,
   "description":"?",
   "recurring":?,
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getCustomerIcon GET Interface

Method: GET

Relative URL: customer/get-customer-icon

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addOperationalHour POST Interface

Method: POST

Relative URL: customer/op-hour

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	OperationalHourArray

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDOPERATIONALHOUR 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "list":[
      {
         "day":"?",
         "startHour":"?",
         "startMinute":"?",
         "startSecond":"?",
         "endHour":"?",
         "endMinute":"?",
         "endSecond":"?",
         "holiday":?
      }   ],
   "round":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

isProcessingJobsRunning GET Interface

Method: GET

Relative URL: customer/is-processing-jobs-running/module

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

isNetworkConnectionProcessing GET Interface

Method: GET

Relative URL: customer/is-network-connection-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

isVCenterHierarchyprocessing GET Interface

Method: GET

Relative URL: customer/is-vcenter-hierarchy-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

isLicenseKeyProcessing GET Interface

Method: GET

Relative URL: customer/is-license-key-processing

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveStorageType POST Interface

Method: POST

Relative URL: customer/save-storage-type

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	StorageTypeData

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVESTORAGETYPE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "type":"?",
   "customerId":"?",
   "accessKey":"?",
   "email":"?",
   "password":"?",
   "secretKey":"?",
   "refreshToken":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getGoogleAuthenticateUrl POST Interface

Method: POST

Relative URL: customer/get-google-authenticate-url

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	StorageTypeData

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETGOOGLEAUTHENTICATEURL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "type":"?",
   "customerId":"?",
   "accessKey":"?",
   "email":"?",
   "password":"?",
   "secretKey":"?",
   "refreshToken":"?"
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

saveServiceNowCredential POST Interface

Method: POST

Relative URL: customer/save-servicenow-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
detail	ServiceNowCredential

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

SAVESERVICENOWCREDENTIAL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "serviceNowUserName":"?",
   "serviceNowPassword":"?",
   "serviceNowDomain":"?",
   "integrationEnabled":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getServiceNowCredential GET Interface

Method: GET

Relative URL: customer/get-servicenow-credential

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	ServiceNowCredential

Example Request:

Example Response:

{
   "id":2147483647,
   "serviceNowUserName":"?",
   "serviceNowPassword":"?",
   "serviceNowDomain":"?",
   "integrationEnabled":?
}