API Endpoints Documentation

List Upcoming Events

Summary: API endpoint provides a list of upcoming events in QuickHelp

Call Name: listUpcomingEvents

Endpoint URL: /Events/Upcoming

Consumes

Produces

In Parameters

Responses

N/A

application/json

[

   {

     "eventId" :  0 ,

     "thumbnail" :  "string" ,

     "title" :  "string" ,

     "description" :  "string" ,

     "sessionDate" :  "string" ,

     "duration" :  "string" ,

     "url" :  "string"

   }

]

From Date

  • in: located in URL
  • name: fromDate
  • type: string Format - date-time (as date-time in RFC3339) 
  • description: Parameter responsible for filtering data by time range start in format "mm/dd/yyyy".
  • required: optional
  • rules
    • IF From Date has not date-time format THEN validation is shown.
    • IF From Date is not set THEN From Date = Current Date.
    • IF From Date > To Date THEN validation is shown.
  1. The possible responses that the service can return.
    • description: A short description of when this response happens.
    • schema: A definition of the response object (see next section for details).
    • (HTTP Status Code): You first specify the HTTP Status Code (e.g. 200).



To Date

  • in: located in URL
  • name: toDate
  • type: string Format - date-time (as date-time in RFC3339) 
  • description: Parameter responsible for filtering data by time range end in format "mm/dd/yyyy".
  • required: optional
  • rules
    • IF To Date has not date-time format THEN validation is shown.
    • IF To Date < From Date THEN validation is shown.

Customer ID

  • in: located in URL
  • name: customerId
  • type: integer Format - int32.
  • description: Parameter available for BSI or Partner and responsible for filtering data per specific customer.
  • required: optional
  • rules
    • IF Customer ID is not integer THEN validation is shown.
    • IF Customer ID = ID that does not exist THEN validation is shown.
    • IF Customer ID = Template ID THEN validation is shown.
    • IF requester is Partner OR BSI THEN Customer ID is required.
    • IF requester is Partner THEN Customer ID = Child Customer ID.

Create Customer Account (Requires account type "Partner" or above)

Summary: The API endpoint can be used to create customer accounts

Call Name: createCustomerAccount

Endpoint URL: /Account/Create

Consumes

Produces

In Parameters

Responses

application/json

{

   "companyName" :  "string" ,

   "eula" :  0 ,

   "templateId" :  0 ,

   "accountType" :  0 ,

   "contractStatus" :  0 ,

   "routeURL" :  "string" ,

   "domains" : [

     "string"

   ],

   "primaryContact" : {

     "name" :  "string" ,

     "email" :  "string" ,

     "phone" :  "string"

   },

   "expirationDate" :  "string" ,

   "licenses" :  0 ,

   "timeZone" :  0 ,

   "supportInfo" : {

     "website" :  "string" ,

     "email" :  "string" ,

     "phone" :  "string"

   },

   "partnerId" :  0 ,

   "ae" :  0 ,

   "csm" :  0 ,

   "suppressUserCreation" :  true ,

   "isEulaAccepted" :  true

}

 

application/json

{

   "companyName" :  "string" ,

   "eula" :  0 ,

   "templateId" :  0 ,

   "accountType" :  0 ,

   "contractStatus" :  0 ,

   "routeURL" :  "string" ,

   "domains" : [

     "string"

   ],

   "primaryContact" : {

     "name" :  "string" ,

     "email" :  "string" ,

     "phone" :  "string"

   },

   "expirationDate" :  "string" ,

   "licenses" :  0 ,

   "timeZone" :  0 ,

   "supportInfo" : {

     "website" :  "string" ,

     "email" :  "string" ,

     "phone" :  "string"

   },

   "partnerId" :  0 ,

   "ae" :  0 ,

   "csm" :  0 ,

   "suppressUserCreation" :  true ,

   "isEulaAccepted" :  true

}

Company Name

  • in: body
  • name: companyName
  • type: string 
  • description: Parameter responsible for providing name of the company.
  • required: required
  • rules
    • IF Company Name is empty THEN validation is shown.
    • IF Company Name = Already Existing Company Name THEN validation is shown.
    • IF Company Name length > 64 characters THEN validation is shown.
    • Special characters and foreign letters are allowed.
  1. The possible responses that the service can return.
    • description: A short description of when this response happens.
    • schema: A definition of the response object (see next section for details).
    • (HTTP Status Code): You first specify the HTTP Status Code (e.g. 200).



EULA

  • in: body
  • name: eula
  • type: integer  Format - int32.
  • description: Parameter responsible for linking new customer with End-User License Agreement file.
  • required: required
  • rules
    • IF EULA is empty THEN validation is shown.
    • IF Partner has NOT accepted EULA THEN Partner is not able to create child customer (validation: Partner without accepted EULA can not be used).
    • IF EULA = ID that does not exist THEN validation message is shown.
    • IF EULA = NOT integer THEN validation message is shown.
    • IF EULA is inactive THEN it is not possible to link it to new customer.
    • IF Account Type = 45-Day Trial Customer OR Account Type = Partner Customer THEN EULA is inherited from Partner Customer AND Partner Admin shall set Partners EULA ID.

isEULAAccepted

  • in: body
  • name: isEULAAccepted
  • type: boolean
  • description: Parameter responsible for new customer End-User License Agreement status (Accepted = True; Not Accepted = False).
  • required: required
  • rules
    • The default value for "IsEULAAccepted" is FALSE.
    • IF isEULAAccepted = NOT boolean THEN validation message is shown.
    • IF BSI Admin set isEULAAccepted = TRUE AND Customer Type !Child Customer or Customer Type != 45-Day Trial Customer THEN validation is shown "EULA can be accepted only for child customers".

Account Type

  • in: body
  • name: accountType
  • type: integer Format - int32.

·        description: Parameter responsible for assigning customer type for new customer. Possible values:

Id  Name   

1     Customer Account   

2     BQP Customer   

3     Demo Account   

4     Partner Customer   

5     45 -Day Trial Customer  

6     Internal Use   

7     Child Customer 

11    CIE Bootcamp   

12    BSI Trial Customer 

13    SMC Sandbox

For more Info Account Type.

  • required: required
  • rules
    • IF Account Type  is empty THEN validation is shown.
    • IF Account Type  = NOT integer THEN validation is shown.
    • IF Account Type < 1 THEN validation is shown.
    • IF Account Type > 7 AND Account Type < 11  THEN validation is shown (Template cannot be created. Invalid input data for Account Type).
    • IF Account Type > 13 THEN validation is shown.
    • IF BSI Admin THEN next Account Types are available:
      • Customer Account; 
      • BQP Customer; 
      • Demo Account; 
      • Partner Customer;
      • Internal Use;
      • CIE Bootcamp;
      • BSI Trial Customer;
      • SMC Sandbox.
    • IF Partner Admin THEN next Account Types are available:
      • 45-Day Trial Customer
      • Child Customer.

Route URL

  • in: body
  • name: routeURL
  • type: string
  • description: Parameter responsible for settings url for new customer. Example: https://app.quickhelp.com/bsi/
  • required: required
  • rules
    • IF Route URL  is empty THEN validation is shown.
    • IF Route URL  contains space THEN validation is shown.
    • IF Route URL  = Already Existing Route URL THEN validation is shown (Customer with this Route URL already exists).
    • IF Route URL length  > 32 characters THEN validation is shown (Please enter no more than 32 characters.).
    • IF Route URL  = 'api' OR Route URL  = ' breeze' OR Route URL  = 'data' THEN validation is shown (These words are reserved: {words}.).
    • IF Route URL DOES NOT MATCH Latin letters and numbers ONLY OR Latin Letters and numbers with dash/dot inside ONLY THEN  validation is shown 

Domains

  • in: body
  • name: domains
  • type: string array
  • descriptionAn array that may contain multiple domains that new customer is linked to. E.g. ["string", "string1", "string2"].