API Endpoints Documentation

API endpoint provides details of all assets that are available in QuickHelp.

getAssets

/Content/Assets

Type ID

• in: located in URL
• name: typeId 
• type: nteger Format - int32
• description: Parameter responsible for filtering Assets by type:
  • Video = 1;
  • HTML = 2;
  • Poll Assessment = 3;
  • PDF = 4;
  • Graded Assessment = 5;
  • Embedded Video = 10.
• required: optional
• rules
  • IF Type ID include invalid data THEN validation is shown.
  • IF Type ID is not set THEN assets of all types shall be returned.
  • IF Type ID < 1 OR Type ID > 5 AND ID !=10 THEN validation is shown. (Not implemented)

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).

Topic ID

• in: located in URL
• name: topicId
• type: nteger Format - int64
• description: Parameter responsible for filtering Assets by Topic.
• required: optional
• rules
  • IF Topic ID include invalid data THEN validation is shown.
  • IF Topic ID is not set THEN assets from all topics shall be returned.
  • IF Topic ID = ID that does not belong to any Topic THEN validation is shown. (Not Implemented)

Category ID

• in: located in URL
• name: categoryId
• type: nteger Format - int64
• description: Parameter responsible for filtering Assets by Category.
• required: optional
• rules
  • IF Category ID include invalid data THEN validation is shown.
  • IF Category ID is not set THEN assets from all categories shall be returned.
  • IF Category ID = ID that does not belong to any Topic THEN validation is shown. (Not Implemented)

Publisher

• in: located in URL
• name: publisher
• type: string
• description: Parameter responsible for filtering Assets by Publisher.
• required: optional
• rules
  • IF  (TBD)

Visibility

• in: located in URL
• name: 
• type: 
• description: Parameter responsible for filtering Assets by Visibility.
• required: optional
• rules
  • IF (TBD)

Customer ID

• in: located in URL
• name: 
• type: nteger Format - int32
• description: Parameter is available for BSI or Partner and responsible for filtering Assets by 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 THEN Customer ID shall be Child Customer ID.

Get a list of users that have attended events.

getAttendedEvents

/Events/Attended

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 > 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 attended Events visible for the 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.

API endpoint to update the details of a customer account.

.

/Account/Update

application/json

{
  "customerId": 0,
  "companyName": "string",
  "eula": 0,
  "isEulaAccepted": true,
  "accountType": 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"
  },
  "ae": 0,
  "csm": 0,
  "contractStatus": 0
}

Company Name

• in: body
• name: companyName
• type: string 
• description: Parameter responsible for updating 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 customer with new End-User License Agreement file.
• required: required
• rules
  • IF EULA is empty THEN validation is shown.
  • 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 EULA was already accepted AND we try to assign new THEN validation is shown ("EULA cannot be updated because EULA is already accepted by a customer. Please reset EULA by entering IsEULAAccepted= FALSE parameter.").
  • IF Partner Admin AND Account Type = 45-Day Trial Customer OR Account Type = Child Customer THEN validation is shown ("Only BSI Administrator can change EULA").
  • IF BSI Admin AND Account Type = 45-Day Trial Customer OR Account Type = Child Customer THEN it is possible to update EULA.

isEULAAccepted

• in: body
• name: isEULAAccepted
• type: boolean
• description: Parameter responsible for customer End-User License Agreement status (Accepted = True; Not Accepted = False).
• required: required
• rules
  • IF EULA was accepted THEN isEULAAccepted = TRUE.
  • IF EULA was not accepted THEN isEULAAccepted = FALSE.
  • IF Partner Admin THEN validation is shown ("Only BSI Administrator can change isEULAAccepted").
  • To change EULA customer has to enter two parameters EULA= EULA ID and IsEULAAccepted = FALSE
  • IF isEULAAccepted = TRUE THEN not possible to set new EULA.
  • 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 ("Invalid isEulaAccepted.").
  • IF IsEULAAccepted = FALSE AND EULA = ID that is inactive AND Admin try to update any field for customer THEN varning message is shown.

Route URL

• in: body
• name: routeURL
• type: string
• description: Parameter responsible for updating  url for  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}.).

Domains

• in: body
• name: domains
• type: string array
• description: An array that may contain multiple domains that new customer is linked to. E.g. ["string", "string1", "string2"].
• required: required
• rules
  • IF Domains is empty THEN validation is shown.
  • IF Domains  = Already Existing Domains THEN validation is shown (Customer with <domain_name> domain already exists).
  • IF Domains contains spaces THEN validation is shown.
  • IF Domains length  > 128 characters THEN validation is shown.
  • IF Domains   array contains two OR more same domains THEN validation is shown.
  • IF Domains   array contains special characters THEN validation is shown.
  • IF Updete/delete Domain that already in use by user's emails THEN validation message is shown.
  • IF delete all domains THEN validation is shown
  • IF Domain include dot THEN this is valid domain.

Primary Contact 

• in: body
• name: primaryContact
• type: associative array
• description: An associative array that contains Name, Email and Phone of contact person from customer.
• required: required
• rules
  • IF Name OR Email OR Phone is empty THEN validation is shown Primary Contact  Name.
  • Foreign language characters, special characters are allowed.
  • IF Primary Contact  Name > 256 characters THEN validation is shown.
  • IF Primary Contact  Name include spaces THEN shall be separated to First and Last Name.
  • IF Primary Contact  Email length > 64 characters THEN validation is shown.

• • IF  Primary Contact  Email does not fit email pattern THEN validation is shown.
  • IF Primary Contact  Phone length > 21 characters THEN validation is shown.
  • IF Primary Contact  Phone length < 10 characters THEN validation is shown.
  • IF Primary Contact  Phone contains   letters OR other symbols except '.' AND '-' THEN validation is shown.

Expiration Date

• in: body
• name: expirationDate
• type: string Format - date-time (as date-time in RFC3339) 
• description: Parameter responsible for update  expiration date for customer. This parameter available only for BSI.
• required: required
• rules
  • IF Expiration Date is not set THEN validation is shown.
  • IF Expiration Date has not valid date format THEN validation is shown (Invalid date format (mm/dd/yyyy))
  • IF Expiration Date <= Current Date THEN validation is shown.
  • IF Customer Type = 45-Day Trial Customer AND Partner Admin THEN validation message is shown.
  • IF Customer Type = Child Customer THEN  Expiration Date is prohibited AND warning message is shown.

Licenses

• in: body
• name: licenses
• type: integer  Format - int32.
• description: Parameter responsible for update number of licenses for customer.
• required: required
• rules
  • IF Licenses is not set THEN validation is shown.
  • IF Licenses is NOT integer THEN validation is shown.
  • IF Licenses < 0 OR Licenses > 99999999 THEN validation is shown.

Time Zone

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

• description: Parameter responsible for update Time Zone for customer. 

• required: optional
• rules
  • IF Time Zone is not set THEN validation is shown.
  • IF Time Zone include invalid data THEN validation is shown.
  • IF Time Zone is not integer THEN validation is shown.

Support Information

• in: body
• name: supportInfo
• type: string array
• description: An associative array responsible for update contact information as phone, email, and website.
• required: optional
• rules
  • IF Phone length > 21 characters THEN validation is shown.
  • IF Phone length < 10 characters THEN validation is shown.
  • IF Phone contains   letters OR other symbols except '.' AND '-' THEN validation is shown.
  • IF Email length > 64 characters THEN validation is shown.
  • IF Email does not fit email pattern THEN validation is shown.
  • IF Website does not fit url pattern THEN validation message is shown.
  • IF Website length > 256 characters THEN validation message is shown.

AE

• in: body
• name: ae
• type: integer Format - int32.
• description: Parameter available only for BSI and responsible for assigning Account Executive from BrainStorm to customer.

Adding Roles Tab

• required: required
• rules
  • IF BSI Admin leave AE empty AND Account Types one from:
    • Customer Account; 
    • BQP Customer; 
    • Demo Account; 
    • Partner Customer;
    • Internal Use;
    • CIE Bootcamp;
    • BSI Trial Customer;
    • SMC Sandbox.

THEN validation is shown.

• • IF BSI Admin AND  Account Types one from:
    • 45-Day Trial Customer
    • Child Customer

THEN for Customer AE is inherited from Partner AND it is not possible to update.

• • IF AE = ID that does not belong to Brainstorm AEs THEN validation is shown.
  • IF AE = ID AND this ID is invalid OR not existing THEN validation is shown.
  • Partner is not able to assign AE.

CSM

• in: body
• name: csm
• type: integer Format - int32.
• description: Parameter available only for BSI and responsible for assigning Client Success Manager from BrainStorm to customer.

Adding Roles Tab

• required: required
• rules
  • IF BSI Admin leave CSM empty AND Account Types one from:
    • • • Customer Account; 
        • BQP Customer; 
        • Demo Account; 
        • Partner Customer;
        • Internal Use;
        • CIE Bootcamp;
        • BSI Trial Customer;
        • SMC Sandbox.

THEN validation is shown.

• • IF BSI Admin AND Partner ID = ID of some partner AND  Account Types one from:
    • 45-Day Trial Customer
    • Child Customer

THEN for new Customer CSM is inherited from Partner AND it is not possible to update.

• •  IF CSM = ID that does not belong to Brainstorm CSMs THEN validation is shown.
  • IF CSM = ID AND this ID is invalid OR not existing THEN validation is shown.
  • Partner is not able to assign CSM.

Contract Status

• in: body
• name: contractStatus
• type: integer Format - int32.
• description: Parameter responsible for Partner Customer contract status. Option for this parameter include: Signed = 1 and Unsigned = 2
• required: required
• rules
  • IF BSI Admin AND Account Type = Partner Customer THEN Contract Status is required.
  • IF Contract Status include invalid data OR is not integer THEN validation is shown.
  • IF Contract Status < 1 AND Contract Status > 2 THEN validation is shown.

API endpoint provides details of all child customers under a partner account.

/Account/Details

Customer ID

• in: located in URL
• name: customerId
• type: integer Format - int32
• description: Parameter responsible for filtering customer's details by Customer ID.
• required: optional
• rules
  • IF BSI Admin AND Customer ID is not set THEN details for all customers shall be returned.
  • IF Partner Admin AND Customer ID is not set THEN details for all child customers shall be returned.
  • 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 THEN Customer ID shall be Child Customer ID.

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).

API endpoint to update the details of a user account.

/User/Update

application/json

{
  "userId": 0,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "department": "string",
  "jobTitle": "string",
  "customerId": 0,
  "licensed": true,
  "confirmed": true,
  "bypassSso": true,
  "roles": [
    "00000000-0000-0000-
0000-000000000000"
  ]
}

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).

User ID

• in: body
• name: userId
• type: integer Format - int32
• description: Parameter responsible for identifying user by ID.
• required: required
• rules
  • IF User ID is not integer THEN validation is shown.
  • IF User ID = ID that does not exist THEN validation is shown.
  • IF User ID is not set THEN validation is shown.

First Name

• in: body
• name: firstName
• type: string
• description: Parameter responsible for updating First Name for the user.
• required: optional
• rules
  • IF First Name > 256 characters THEN validation is shown.
  • IF First Name contain  =+:;",<>OR only one letter THEN validation is shown.
  • Is allowed to add foreign characters.

Last Name

• in: body
• name: lastName
• type: string
• description: Parameter responsible for updating Last Name for the user.
• required: optional
• rules
  • IF Last Name > 256 characters THEN validation is shown.
  • IF Last Name contain  =+:;",<>OR only one letter THEN validation is shown.
  • Is allowed to add foreign characters.

Email

• in: body
• name: email
• type: string
• description: Parameter responsible for updating Email for the user.
• required: optional
• rules
  • IF  Email length > 256 characters THEN validation is shown.
  • IF  Email does not fit email pattern THEN validation is shown.
  • IF Email include domain that does not belong to current customer  THEN validation is shown.
  • IF EMAIL = Already exiting Email THEN validation is shown.

Departments

• in: body
• name: department
• type: string
• description: Parameter responsible for updating Department for the user.
• required: optional
• rules
  • IF  Department length > 256 characters THEN validation is shown.
  • Is allowed to add all special characters.
  • Is allowed to add foreign characters.

Job Title

• in: body
• name: jobTitle
• type: string
• description: Parameter responsible for updating Job Title for the user.
• required: optional
• rules
  • IF Job Title  length > 256 characters THEN validation is shown.
  • Is allowed to add all special characters.
  • Is allowed to add foreign characters.

Issue License

• in: body
• name: licensed
• type: boolean
• description: Parameter responsible for issuing or removing license of user.
• required: optional
• rules
  • IF Issue License is not boolean THEN validation is shown.

Confirmed

• in: body
• name: confirmed
• type: boolean
• description: Parameter responsible for confirmation of user.
• required: optional
• rules
  • IF Confirmed is not boolean THEN validation is shown.

Bypass SSO

• in: body
• name: bypassSso
• type: boolean
• description: Parameter determines whether user SSO should be bypassed.
• required: optional
• rules
  • IF bypassSso is not boolean THEN validation is shown.

Roles

• in: body
• name: roles
• type: 
• description:Parameter responsible for updating roles assigned to user.
• required: optional
• rules
  • Сannot add simultaneously BrainStorm and non-BrainStorm roles: "Either only BrainStorm or non BrainStorm roles can be added for a user"

  • Some roles cannot be added to the specific customer account type: e.g. Partner Administrator role cannot be added to customer of Customer account type: "Entered roles cannot be added to a user of current customer."

  • IF Role guid is not existing THEN validation message is shown ("Role does not exist").

  • IF Role guid has invalid value THEN validation message is shown.
  • Partner is allowed to add only partner and customer's roles to partner user.
  • Partner is allowed to add customer's roles to child customer user.
  • Customer is allowed to add only customer's role.

Customer ID

• in: body
• name: customerID
• type:integer
• description: Parameter available for BSI or Partner and responsible for specifying customer by ID.
• 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 THEN Customer ID shall be Child Customer ID.

API endpoint provides the QuickHelp activity history for your users.

/User/History

User ID

• in: located in URL
• name: userId
• type: integer Format - int32
• description: Parameter responsible for filtering data per specific user.
• required: optional
• rules
  • IF User ID is not integer THEN validation is shown.
  • IF User ID = ID that does not exist THEN validation is shown.
  • IF User ID is not set THEN history for all users will be shown.
  • IF User ID does not belong to Customer = Customer ID 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).

Email

• in: located in URL
• name: email
• type: string
• description: Parameter responsible for filtering data per specific email.
• required: optional
• rules

Department

• in: located in URL
• name: department
• type: string
• description: Parameter responsible for filtering data per specific department.
• required: optional
• rules

Job Title

• in: located in URL
• name: jobTitle
• type: string
• description: Parameter responsible for filtering data per specific job title.
• required: optional
• rules

Group

• in: located in URL
• name: group
• type: string
• description: Parameter responsible for filtering data per specific group.
• required: optional
• rules

Role

• in: located in URL
• name: role
• type: string
• description:  Parameter responsible for filtering data per specific user role.
• required: optional
• rules

SSO Attribute

• in: located in URL
• name: ssoAttribute
• type: string
• description: Parameter responsible for filtering data per specific SSO Attribute.
• required: optional
• rules
  • Parameters should be in the following format [{"Attribute Name":"Attribute Value"}]. For example [{"SsoPlatform":"Mac"}]

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 > To Date THEN validation is shown.

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.

Country

• in: located in URL
• name: country
• type: string
• description: Parameter responsible for filtering data per specific country.
• required: optional
• rules

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.

The API endpoint can be used to create multiple  users accounts at once.

/User/Create

application/json

[
  {
    "firstName": "string",
    "lastName": "string",
    "password": "string",
    "email": "string",
    "department": "string",
    "jobTitle": "string",
    "groups": [
      0
    ],
    "roles": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "customerId": 0,
    "issueLicense": true,
    "supressPostCreationEmails": true
  }
]

First Name

• in: body
• name: firstName
• type: string
• description: Parameter responsible for setting First Name for the user.
• required: required
• rules
  • IF First Name > 256 characters THEN validation is shown.
  • IF First Name contain  =+:;",<>OR only one letter THEN validation is shown.
  • Is allowed to add foreign characters.

Accepted

• description: Accepts user creation request and return CorrelationId and Location where the status can be checked. The generated jobId can be used in getUserCreationJobStatus, getUserCreationTasksStatus endpoints for the further information about user creation status
• schema: 

  • {
      "format": "uuid",
      "type": "string",
      "example": "00000000-0000-0000-0000-000000000000"
    }

• (HTTP Status Code): 202 Accepted

Last Name

• in: body
• name: lastName
• type: string
• description: Parameter responsible for setting Last Name for the user.
• required: required
• rules
  • IF Last Name > 256 characters THEN validation is shown.
  • IF Last Name contain  =+:;",<>OR only one letter THEN validation is shown.
  • Is allowed to add foreign characters.

Email

• in: body
• name: email
• type: string
• description: Parameter responsible for setting Email for the user.
• required: required
• rules
  • IF  Email length > 256 characters THEN validation is shown.
  • IF  Email does not fit email pattern THEN validation is shown.
  • IF Email include domain that does not belong to current customer  THEN validation is shown.
  • IF EMAIL = Already exiting Email THEN validation is shown.

Bad Request

• description: Some validation appeared
• schema: 

  • {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "value": {
            "type": "object",
            "properties": {
              "attemptedValue": {
                "type": "string",
                "readOnly": true
              },
              "culture": {
                "type": "string",
                "readOnly": true
              },
              "rawValue": {
                "type": "object",
                "readOnly": true
              }
            }
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "exception": {
                  "type": "object",
                  "readOnly": true
                },
                "errorMessage": {
                  "type": "string",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          }
        }
      }
    }

• (HTTP Status Code): 400 Bad Request

Departments

• in: body
• name: department
• type: string
• description: Parameter responsible for setting Department for the user.
• required: optional
• rules
  • IF  Department length > 256 characters THEN validation is shown.
  • Is allowed to add all special characters.
  • Is allowed to add foreign characters.

Job Title

• in: body
• name: jobTitle
• type: string
• description: Parameter responsible for setting Job Title for the user.
• required: optional
• rules
  • IF Job Title  length > 256 characters THEN validation is shown.
  • Is allowed to add all special characters.
  • Is allowed to add foreign characters.

Issue License

• in: body
• name: licensed
• type: boolean
• description: Parameter responsible for issuing or removing license of user (If not specified licensed = TRUE).
• required: optional
• rules
  • IF Issue License is not boolean THEN validation is shown.

Password

• in: body
• name: password
• type: string
• description: Parameter responsible for setting Password for the user.
• required: optional
• rules
  • IF Password include next symbols +,/;’`?:”|<>[]{}()'  THEN validation is shown.
  • IF Password is empty OR include only spaces THEN validation is shown.
  • IF Password length < 6 THEN validation is shown.
  • IF Password length > 32 THEN validation is shown.

SupressPostCreationEmails 

• in: body
• name: supressPostCreationEmails
• type: boolean
• description: Parameter determines whether to send emails to user.
• required: optional
• rules
  • IF SupressPostCreationEmails is not boolean THEN validation is shown.

Roles

• in: body
• name: roles
• type: array
• description: Parameter responsible for assigning  roles  to user.
• required: optional
• rules
  • Сannot add simultaneously BrainStorm and non-BrainStorm roles: "Either only BrainStorm or non BrainStorm roles can be added for a user"

  • Some roles cannot be added to the specific customer account type: e.g. Partner Administrator role cannot be added to customer of Customer account type: "Entered roles cannot be added to a user of current customer."

  • IF Role guid is not existing THEN validation message is shown ("Role does not exist").

  • IF Role guid has invalid value THEN validation message is shown.
  • Partner is allowed to add only partner and customer's roles to partner user.
  • Partner is allowed to add customer's roles to child customer user.
  • Customer is allowed to add only customer's role.
  • IF same Role guid is added several times THEN validation message is shown

Groups

• in: body
• name: groups
• type: array
• description: Parameter responsible for user to system groups.
• required: optional
• rules
  • IF Group ID is not existing THEN validation message is shown.
  • IF same Group ID is added several times THEN validation message is shown.
  • IF Group ID belong to Users Group ID THEN validation message 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.

API endpoint provides a list of all skill paths in QuickHelp.

/SkillPaths/List

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.

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).

The endpoint can be used to send requests to delete user information as is pursuant to GDPR requirements.

/User/Delete

application/json

{
  "customerId": 0,
  "users": [
    {
      "id": 0,
      "email": "string"
    }
  ]
}

Customer ID

• in: body
• name: customerId
• type: integer Format - int32
• description: Parameter available for BSI or Partner and responsible for specifying customer by ID.
• 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.

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).

Users

• in: body
• name: users
• type: array
• description: Parameter responsible for providing the list of users that will be deleted.
• required: optional
• rules:
  • Usersr endpoint accepts only either userId or email.

User ID

• in: body
• name: userId
• type: integer Format - int32
• description: Parameter responsible for ID of a user being deleted.
• required: optional
• rules
  • IF User ID is not integer THEN validation is shown.
  • IF User ID = ID that does not exist THEN validation is shown.
  • IF User ID does not belong to Customer = Customer ID THEN validation is shown.
  • IF User ID = User has Event Owner OR Group Owner role THEN validation is shown.

Email

• in: body
• name: email
• type: string
• description: Parameter responsible for Email of a user being deleted.
• required: required
• rules
  
  • IF Email is invalid OR does not exist THEN validation is shown.
  • IF Email does not belong to Customer = Customer ID THEN validation is shown.
  • IF Email = User has Event Owner OR Group Owner role THEN validation is shown.

API endpoint provides a list of all skill paths in QuickHelp.

/Content/Topics

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.

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).

API endpoint to get the status of user creation job.

/User/UserCreationJobStatus

jobId

• in: located in URL
• name: jobId
• type: string Format - uuid.
• description: Parameter responsible for CorrelationId of user creation job.
• required: required
• rules
  • IF valid jobId is provided but endpoint is called not by customer that had called createUserAccount endpoint THEN empty response will be returned
  • IF jobId data type is not guid 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).

API endpoint to get user creation tasks details per each user.

/User/UserCreationTasksStatus

jobId

• in: located in URL
• name: jobId
• type: string Format - uuid.
• description: Parameter responsible for CorrelationId of user creation job.
• required: required
• rules
  • IF valid jobId is provided but endpoint is called not by customer that had called createUserAccount endpoint THEN empty response will be returned
  • IF jobId data type is not guid 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).

User/Assignments

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.

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).

User ID

• in: located in URL
• name: userId
• type: integer Format - int32
• description: Parameter responsible for filtering data per specific user.
• required: optional
• rules
  • IF User ID is not integer THEN validation is shown.
  • IF User ID = ID that does not exist THEN validation is shown.
  • IF User ID is not set THEN history for all users will be shown.
  • IF User ID does not belong to Customer = Customer ID THEN validation is shown.

Email

• in: located in URL
• name: email
• type: string
• description: Parameter responsible for filtering data per specific email.
• required: optional
• rules

SSO Claim

• in: located in URL
• name: ssoClaim
• type: string
• description: Parameter responsible for filtering data per specific SSO Claim.
• required: optional
• rules
  • Parameters should be in the following format [{"Attribute Name":"Attribute Value"}]. For example [{"SsoPlatform":"Mac"}]

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 fromDate is entered THEN assignments are filtered by dueDate that belons to the date:  dueDate >= fromtDate.
  • IF From Date > To Date THEN validation is shown.

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.
  • IF To Date is entered THEN assignments are filtered by dueDate that belongs to date: dueDate <= toDate.

API endpoint provides search results by provided query.

/Search/Results

User ID

• in: located in URL
• name: userId
• type: integer Format - int32
• description: Parameter responsible for filtering data per specific user.
• required: optional
• rules
  • IF User ID is not integer THEN validation is shown.
  • IF User ID = ID that does not exist THEN validation is shown.
  • IF User ID is not set THEN history for all users will be shown.
  • IF User ID does not belong to Customer = Customer ID 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).

Query

• in: located in URL
• name: query
• type: string
• description: Parameter responsible for searching query.
• required: required
• rules
  • IF Query is not set THEN validation is shown.

Limit

• in: located in URL
• name: limit
• type: integer, Format - int32
• description: Parameter responsible for number of returned results.
• required: optional
• rules
  • Should be in range [1-100], othwerwise following validation errors will appear:
    -  if limit <1: "'Limit' must be greater than or equal to '1'."
    -  if limit >100: "Limit should be in range [1-100]."
  • IF data in invalid format was entered THEN validation is shown.

TypeId

• in: located in URL
• name: typeId
• type: integer, Format - int32
• description: Parameter responsible for searching by type. Possible values: 1 (Events), 2 (Group), 3 (Video), 4 (HTML), 5 (PDF), 6 (Assessment), 7 (Skill path).
• required: optional
• rules
  • IF value that is not in range [1-7] was entered THEN validation is shown.
  • IF data in invalid format was entered THEN validation is shown.