Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Register

Description

???Add a new service or update an existing service.

Package Details

Interface

IOnboardingServiceManager

Syntax

Task<string> Register(ServiceInfo info);

Returns

Task<string>

API Endpoint

Parameters

...

Parameter

...

Description

...

Parameter Type

Sample request body

There are no parameters.

Example

Code Block
languagejson

Returns

On success, 200 OK

On error, 400 Bad Request

On authorization error, 403 Forbidden

Example

Code Block
languagec#c#
var serviceInfo = new ServiceInfo
{
    BaseUrl = "your url",
    BusinessUnit = TcBusinessUnit.MyTcOnline,
    FriendlyNameEn = "My Service En",
    FriendlyNameFr = "My Service Fr",
    Groups = new List<ServiceGroup>(),
    Icon = "icon.jpg",
    IsDisplayableInCatalog = true,
    IsEnrollmentRequired = true,
    IsPublic = true,
    Id = 100 //Only when updating
};
            
var info = await onboardingServiceManager.Register(serviceInfo);