REST API

Add Service Calls by REST API

OVERVIEW

By the QW_Add_Object API, the user can add the Service Call directly into the system for the related customer.

Method: Post

Input: 

Authorization: Basic Auth token in the Request Headers 

Post body:

Mandatory Fields of this API which is necessary to mention: 

Parameter Value Mandatory Description
Project_ID String Yes Service Center Project ID
Major_Version Int Yes The major version view number as appears in Orcanos
Minor_Version Int Yes The Minor version view number appears in Orcanos.
Object_Name String Yes The Service Call Name which the user wants to put
Object_Type String Yes Service Call
Description String No Service Call description in plain text/HTML format
Customer_ID String Yes Enter the customer id where the user wants to add Service calls
Site_ID String No Enter the site id if available for the customer 

Output:

Orcanos Output class:

{
    "IsSuccess": true,
    "Data": 14226,
    "Message": "Object created successfully.",
     "HttpCode": 200
}

IsSuccess: if successful then true else false

Data: Updated or Newly created object id

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

Related Articles