Search

Page tree
Skip to end of metadata
Go to start of metadata


Description of the Service Manager EndPoints

Table of Contents


Setup Configuration

Get Setup Fields

Returns definitions for the extra fields that will be available on 'Settings' of the application.

Request

Http Verb: GET

Basic type

Response
{
    "Fields": [
        {
            "ID": "username",
            "Definition": {
                "ID": "username",
                "SortOrder": 0,
                "Name": "User Name",
                "Kind": "Text",
                "MaxLength": 20,
                "IsRequired": true
            }
        },
        {
            "ID": "password",
            "Definition": {
                "ID": "password",
                "SortOrder": 0,
                "Name": "Password",
                "Kind": "PasswordText",
                "MaxLength": 20,
                "IsRequired": true
            }
        },
        {
            "ID": "StorageLocation",
            "Definition": {
                "ID": "StorageLocation",
                "SortOrder": 0,
                "Name": "Storage Location",
                "Kind": "PredefinedChooseOne",
                "MaxLength": 0,
                "IsRequired": true,
                "PredefinedValues": {
                    "1": "Data Center 1",
                    "2": "Data Center 2"
                }
            }
        }
    ]
}


Validate Setup Fields

Validates values provided for 'Settings' of the application and return errors accordingly.

Request

Http Verb: POST

Request

{

 "Fields": [
{
"ID": "username",
"Value": "test"
},
{
"ID": "password",
"Value": "123456"
}
]
};

Response

[
"Invalid username",
"Password could not be empty"
]


Get Service Definitions

 Get definitions for the services supported by application. 


Request

Http Verb: GET

Response

{
"ProductTypes": [
{
"ID": "myservice",
"Name": "Example Service",
"Description": "The definition of an example service",
"AllowMultipleSubscriptions": true,
"AutoExecuteAddonCancelRequest": false,
"AutoExecuteSubscriptionCancelRequest": false,
"AutoExecuteSubscriptionDowngradeRequest": false,
"QuantityLimit": 0,
"QuantityLimitLocked": false,
"Scope": "Both",
     "PortalURL": "https://portal.vendor.com"
     "Restrictions": null,
"ExtraParameters": null,
"AttributeList": [
{
"Usage": "ProductCharacteristic",
"Kind": "Numeric",
"ID": "valueNumeric",
"SortOrder": 1,
"Name": "Numeric value",
"Description": "Type a numeric value to define service attribute",
"UsageSpecified": true,
"KindSpecified": true,
"IsRequired": true,
"IsSyncLocked": 0,
"LinkedToQuantity": false,
"AllowUnlimited": false,
"PredefinedValues": [],
"ExtraParameters": null,
"SliderMin": 0,
"SliderMax": 0,
"SliderStep": 0
},
{
"Usage": "OrderCharacteristic",
"Kind": "PredefinedChooseOne",
"ID": "valueList",
"SortOrder": 2,
"Name": "List value",
"Description": "Select a value from the list to define service attribute",
"UsageSpecified": true,
"KindSpecified": true,
"IsRequired": true,
"IsSyncLocked": 0,
"LinkedToQuantity": false,
"AllowUnlimited": false,
"PredefinedValues": [
{
"ID": "1",
"Code": "1",
"Name": "Value 1",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "2",
"Code": "2",
"Name": "Value 2",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "3",
"Code": "3",
"Name": "Value 3",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "4",
"Code": "4",
"Name": "Value 4",
"IsDefault": false,
"ResourceId": 0
}
],
"ExtraParameters": null,
"SliderMin": 0,
"SliderMax": 0,
"SliderStep": 0
},
{
"Usage": "ProductCharacteristic",
"Kind": "Boolean",
"ID": "valueCheckbox",
"SortOrder": 3,
"Name": "Bool value",
"Description": "Check to define service attribute",
"UsageSpecified": true,
"KindSpecified": true,
"IsRequired": true,
"IsSyncLocked": 0,
"LinkedToQuantity": false,
"AllowUnlimited": false,
"PredefinedValues": [],
"ExtraParameters": null,
"SliderMin": 0,
"SliderMax": 0,
"SliderStep": 0
},
{
"Usage": "ProductCharacteristic",
"Kind": "PredefinedChooseMany",
"ID": "valueCheckboxes",
"SortOrder": 4,
"Name": "Multiple checkboxes value",
"Description": "Select multiple values from the list to define service attribute",
"UsageSpecified": true,
"KindSpecified": true,
"IsRequired": true,
"IsSyncLocked": 0,
"LinkedToQuantity": false,
"AllowUnlimited": false,
"PredefinedValues": [
{
"ID": "1",
"Code": "1",
"Name": "Value 1",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "2",
"Code": "2",
"Name": "Value 2",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "3",
"Code": "3",
"Name": "Value 3",
"IsDefault": false,
"ResourceId": 0
},
{
"ID": "4",
"Code": "4",
"Name": "Value 4",
"IsDefault": false,
"ResourceId": 0
}
],
"ExtraParameters": null,
"SliderMin": 0,
"SliderMax": 0,
"SliderStep": 0
}
]
}
]
}


Accounts Management

Account Get Sync Options

Get definition of fields that should be collected for synchronizing an account.

Request

Http Verb: GET

Response

{
"Fields": [
{
"ID": "username",
"Definition": {
"ID": "username",
"SortOrder": 0,
"Name": "Username",
"Description": "",
"Kind": "SimpleValue",
"DataType": "Text",
"IsRequired": true,
"PredefinedValues": []
}
}
]



Account Synchronize

Create customer/user for external application.

Request

Http Verb: POST

Request

{
	 "ID": "13",
	 "ExternalID": "",
	 "ResellerID": null,
	 "ResellerExternalID": null,
	 "Name": "My Reseller",
	 "Code": "ress",
	 "Phone": "",
	 "Fax": "",
	 "WebSite": "",
	 "Email": "my@r.com",
	 "Description": "",
	 "ExtraDetails": {},
	 "SyncOptions": {
		 "username": "test"
	 },
	 "ContactDetails": {
		 "ID": "16",
		 "FirstName": "Stelios",
		 "LastName": "Reseller",
		 "Phone": "",
		 "Fax": "",
		 "Email": "my@r.com"
	 }
}

Response

{
"ErrorCode": 0,
"ErrorMessage": "",
"Result": ""
}


Account Is Reseller

Check if the account info provided matching an reseller customer. 

Request

Http Verb: POST

Request

{
	 "ID": "13",
	 "ExternalID": "",
	 "ResellerID": null,
	 "ResellerExternalID": null,
	 "Name": "My Reseller",
	 "Code": "ress",
	 "Phone": "",
	 "Fax": "",
	 "WebSite": "",
	 "Email": "my@r.com",
	 "Description": "",
	 "ExtraDetails": {},
	 "SyncOptions": {
		 "username": "test"
	 },
	 "ContactDetails": {
		 "ID": "16",
		 "FirstName": "Stelios",
		 "LastName": "Reseller",
		 "Phone": "",
		 "Fax": "",
		 "Email": "my@r.com"
	 }
}

Response

{
"ErrorCode": 0,
"ErrorMessage": "",
"Result": ""
}


Account Delete

Delete a user/customer from the external system.

Request

Http Verb: POST

Request

{
	 "ID": "13",
	 "ExternalID": "",
	 "ResellerID": null,
	 "ResellerExternalID": null,
	 "Name": "My Reseller",
	 "Code": "ress",
	 "Phone": "",
	 "Fax": "",
	 "WebSite": "",
	 "Email": "my@r.com",
	 "Description": "",
	 "ExtraDetails": {},
	 "SyncOptions": {
		 "username": "test"
	 },
	 "ContactDetails": {
		 "ID": "16",
		 "FirstName": "Stelios",
		 "LastName": "Reseller",
		 "Phone": "",
		 "Fax": "",
		 "Email": "my@r.com"
	 }
}

Response

{
"ErrorCode": 0,
"ErrorMessage": "",
"Result": ""
}


Account Exists

Check if the account info provided matching an existing customer. 

Request

Http Verb: POST

Request

{
	 "ID": "13",
	 "ExternalID": "",
	 "ResellerID": null,
	 "ResellerExternalID": null,
	 "Name": "My Reseller",
	 "Code": "ress",
	 "Phone": "",
	 "Fax": "",
	 "WebSite": "",
	 "Email": "my@r.com",
	 "Description": "",
	 "ExtraDetails": {},
	 "SyncOptions": {
		 "username": "test"
	 },
	 "ContactDetails": {
		 "ID": "16",
		 "FirstName": "Stelios",
		 "LastName": "Reseller",
		 "Phone": "",
		 "Fax": "",
		 "Email": "my@r.com"
	 }
}

Response

{
"ErrorCode": 0,
"ErrorMessage": "",
"Result": ""
}

Subscriptions Management

Subscription Create

Create a new subscription / provision a service.

Request

Http Verb: POST

Request

{

	 "ID": "",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": []
}

Response

{
"AccountExtraInfo": null,
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Subscription Update

Update an existing subscription / increase-decrease resources for a service.

Request

Http Verb: POST

Request

{

	 "ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": []
}

Response

{
"AccountExtraInfo": null,
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Subscription Delete

Delete a subscription / deprovision service

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": []
}

Response

{
"AccountExtraInfo": null,
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Subscription Activate

Activate subscription / enable services

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": []
}

Response

{
"AccountExtraInfo": null,
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Subscription Suspend

Suspend subscription / suspend service

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": []
}

Response

{
"AccountExtraInfo": null,
"Code": 0,
"Message": "",
"Result": "2103213618"
}

Addons Management

Addon Create

Create a new addon for a specific subscription / modify resources for service

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": [
{
"ID": "",
"Name": null,
"ProductID": "2D3D5B37-84C1-4848-8731-059875E01DBB",
"ActionType": "Provision",
"Quantity": 1,
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "0",
"Code": ""
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2; Value 3",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "0.000000",
"Code": ""
}
}
}
]

}

Response

{
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Addon Update

Update an addon // modify resources for service

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": [
{
"ID": "3F7093F5-260D-4E11-B977-01580CC5FAB6",
"Name": null,
"ProductID": "2D3D5B37-84C1-4848-8731-059875E01DBB",
"ActionType": "Provision",
"Quantity": 1,
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "0",
"Code": ""
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2; Value 3",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "0.000000",
"Code": ""
}
}
}
]

}

Response

{
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Addon Delete

Delete an addon // modify resources for service

Request

Http Verb: POST

Request


{
"ID": "2AD88E58-9EBB-41DA-BF74-AFAFFD7E4011",
"ServiceType": "MyService",
"ProductID": "C4A37F95-ABF7-4681-BFB0-39EEF4E8517D",
"ActionType": "Provision",
"Quantity": 1,
"Account": {
"ID": "13",
"ExternalID": "2103213618",
"ResellerID": null,
"ResellerExternalID": null,
"Name": "My Reseller",
"Code": "ress",
"Phone": "",
"Fax": "",
"WebSite": "",
"Email": "my@r.com",
"Description": "",
"ExtraDetails": {},
"SyncOptions": {
"username": "test"
},
"ContactDetails": {
"ID": "16",
"FirstName": "Stelios",
"LastName": "Reseller",
"Phone": "",
"Fax": "",
"Email": "my@r.com"
}
},
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "1",
"Code": ""
},
"valueList": {
"ID": "valueList",
"Name": "List value",
"Value": "Value 2",
"Code": "2"
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "1.000000",
"Code": ""
}
},
"Addons": [
{
"ID": "3F7093F5-260D-4E11-B977-01580CC5FAB6",
"Name": null,
"ProductID": "2D3D5B37-84C1-4848-8731-059875E01DBB",
"ActionType": "Delete",
"Quantity": 1,
"AttributeList": {
"valueCheckbox": {
"ID": "valueCheckbox",
"Name": "Bool value",
"Value": "0",
"Code": ""
},
"valueCheckboxes": {
"ID": "valueCheckboxes",
"Name": "Multiple checkboxes value",
"Value": "Value 1; Value 2; Value 3",
"Code": ""
},
"valueNumeric": {
"ID": "valueNumeric",
"Name": "Numeric value",
"Value": "0.000000",
"Code": ""
}
}
}
]

}

Response

{
"Code": 0,
"Message": "",
"Result": "2103213618"
}


Users Management

Get Customer

Get details for a customer

Request

Http Verb: POST

Request

{
"ID": "customer_1"
}

Response

{
"ID": "customer_1",
"Name": "Customer A",
"PrimaryDomain": "customerA.com",
"Status": "Provisioned",
"TotalUsers": 5
}

Get Users

Get list of Users for a specific Customer

Request

Http Verb: POST

Request

{
"CustomerID": "customer_1",
"SearchText": "Customer",
"PageID": 1,
"PageSize": 25
}

Response

{
"Users": [{
"ID": "user_1",
"Customer": {
"ID": "customer_1",
"Name": "Customer A"
},
"FirstName": "Test",
"LastName": "User A",
"DisplayName": "Test User A",
"Username": "test@userA.com",
"Email": "test@userA.com",
"Status": "Provisioned",
"Role": "User",
"TotalServices": 1
}, {
"ID": "user_2",
"Customer": {
"ID": "customer_1",
"Name": "Customer A"
},
"FirstName": "Test",
"LastName": "User B",
"DisplayName": "Test User B",
"Username": "test@userB.com",
"Email": "test@userB.com",
"Status": "Disabled",
"Role": "Administrator",
"TotalServices": 1
}],
"TotalUsers": 2,
"AvailableServices": [{
"ID": "storage_basic",
"Name": "Cloud Storage Basic"
}, {
"ID": "backup_premium",
"Name": "Cloud Storage Backup Premium"
}, {
"ID": "sync_enterprise",
"Name": "Sync Cloud Services Enterprise"
}]
}

Get User

Get details of a User

Request

Http Verb: POST

Request

{
"ID": "user_1",
"Customer": {
"ID": "1"
}
}

Response

{
"ID": "user_1",
"FirstName": "Test",
"LastName": "User C",
"DisplayName": "Test User C",
"Username": "test@userC.com",
"Email": "test@userC.com",
"Status": "Disabled",
"Role": "Administrator",
"TotalServices": 3
}
User Create

Create a new User

Request

Http Verb: POST

Request

{
"Customer": {
"ID": "customer_1"
},
"FirstName": "Test",
"LastName": "User",
"DisplayName": "Test User",
"Username": "user@test.com",
"Email": "user@test.com",
"Password": "{Password}"
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Update

Update an existing User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
},
"FirstName": "Test",
"LastName": "User",
"Email": "user@test.com",
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Delete

Delete a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Disable

Disable a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Activate

Activate a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Deprovision

Deprovision a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Provision

Provision a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Reset Password

Reset password for a User

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

User Services Management

Get User Services

Get services available for a User and their status

Request

Http Verb: POST

Request

{
 "ID": "user_1565",
	 "Customer": {
"ID": "customer_1"
}
}

Response

[
{
"ID": "storage_basic",
"Name": "Cloud Storage Basic",
"Enabled": false
},
{
"ID": "backup_premium",
"Name": "Cloud Storage Backup Premium",
"Enabled": false
},
{
"ID": "sync_enterprise",
"Name": "Sync Cloud Services Enterprise",
"Enabled": true
}
]

Add User Service

Assign a new service for a selected User

Request

Http Verb: POST

Request

{
"ServiceID": "basic",
"User": {
"ID": "user_1565",
"Customer": {
"ID": "customer_1"
}
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

Remove User Service

Remove a service from a selected User

Request

Http Verb: POST

Request

{
"ServiceID": "basic",
"User": {
"ID": "user_1565",
"Customer": {
"ID": "customer_1"
}
}
}

Response

{
"Code": 0,
"Message": "",
"Result": "user_1565"
}

Object Types

The following object types are included in Code Samples or can be downloaded independently for the following languages

Object: FieldDefinition

{
        "ID": "StorageLocation",
        "SortOrder": 0,
        "Name": "Storage Location",
        "Description": "Define the location of the storage",
        "Kind": "PredefinedChooseOne",
        "MaxLength": 0,
        "IsRequired": true,
        "PredefinedValues": {
          "1": "Data Center 1",
          "2": "Data Center 2"
        }
}
IDExternal system identifier
SortOrderThe position of the field in settings
NameThe display name
DescriptionDescription for the field
Kind

Text - text input

PasswordText - password text input

Url - url input

Integer - numeric input

PredefinedChooseOne - dropdown input

PredefinedChooseMany - multiple select checkboxes input

MaxLengthThe maximum number of characters a user can enter for this field
IsRequired

true, in case the value of this field is required,

false, otherwise

PredefinedValuesAn array of values to be display in case Kind is PredefinedChooseOne or PredefinedChooseMany