Account Limits user accounts, to enforce prepaid billing model) Service

Available methods:

GET /v1/api/accounts/{accountID}/limits 

The method gets account limits.

Note: This operation is applicable only to user

Input Parameters

#ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 accountID path string Required

Identifies the account

2 areEffective query boolean Optional

Gets or sets a value indicating, whether to return effective account limits(true) or not (false)

The default value is false.

3 skip query integer Optional

Pagination: Number of items to skip

4 take query integer Optional

Pagination: Number of items to take

Output Parameters

PageV1Model  [LimitV1Model]

PageV1Model[LimitV1Model] { count (integer, optional): Pagination: Number of items retrieved, total (integer, optional): Pagination: Total number of items, items (Array[LimitV1Model], optional): An array of items } LimitV1Model { name (string): The account limit name, value (number): The account limit value }

Response Class (Status 200)

An array of all limits currently configured for the specified account.

Response example

Returns 5 effective account limits, starting from the 11th (10 skipped)

Response Body example { "count": 5, "total": 32, "items": [ { "name": "SharePoint_package14Min", "value": 1 }, { "name": "SharePoint_package14Max", "value": 1 }, { "name": "SharePoint_package15Min", "value": 1 }, { "name": "SharePoint_package15Max", "value": 1 }, { "name": "SharePoint_package55Min", "value": 1 } ] }

Possible error response messages

POST /v1/api/accounts/{accountID}/limits 

The method adds account limits.

Implementation Notes This operation is applicable only to user account.

  Input Parameters

#ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 accountID path string Required

Identifies the account

2 limit body LimitV1Model Required

The properties of limit to create

Output Parameters

LimitV1Model 

LimitV1Model { name (string): The account limit name, value (number): The account limit value }

Response Class (Status 201)

The limit was successfully created for the specified account.

Request and response examples

Request

Description of limit that is created:

 Request Body example { "name": "SharePoint_serverMax", "value": 100 }

Response

The data of the created limit:

 Response Body example { "name": "SharePoint_serverMax", "value": 100 }

Possible error response messages

DELETE /v1/api/accounts/{accountID}/limits/{limitName}  

This method removes account limit.

Implementation Notes This operation is applicable only to user account.

Input Parameters

#ParameterParameter TypeData Type

Mandatory

Description/Valid ValuesAdditional Information
1 accountID path string Required

Identifies the account

2 limitName path string Required

Limit name*

* Name of the limit, that is valid for this account.

To get effective valid account limits use
GET /v1/api/accounts/{accountID}/limits  method

Output Parameters

Inline Model 

Response Class (Status 204)

The account limit was successfully removed.

Possible error response messages

GET /v1/api/accounts/{accountID}/limits/{limitName} 

The method retrieves a value for a specific limit configured for the account.

Note: This operation is applicable only to user account.

Input Parameters

#ParameterParameter TypeData Type

Mandatory

Description/Valid ValuesAdditional Information
1 accountID path string Required

Identifies the account

2 limitName path string Required

Limit name*

* Name of the limit, that is valid for this account.

To get effective valid account limits use
GET /v1/api/accounts/{accountID}/limits method

Output Parameters

LimitV1Model

LimitV1Model { name (string): The account limit name, value (number): The account limit value }

Response Class (Status 200)

An object describing the updated limit for the specific account.

Response example

The information about the specified limit is returned:

 Response Body example { "name": "SharePoint_serverMax", "value": 100 }  

Possible error response messages

PUT /v1/api/accounts/{accountID}/limits/{limitName} 

This method updates account limit.

Implementation Notes This operation is applicable only to user account.

Input Parameters

#ParameterParameter TypeData Type

Mandatory

Description/Valid ValuesAdditional Information
1 accountID string Required

Identifies the account

2 limitName path string Required

Limit name*

* Name of the limit, that is valid for this account.
 To get effective valid account limits use
 GET /v1/api/accounts/{accountID}/limits method.

3 limit body LimitUpdateV1Model  Required

The new account limit value

 

  Output Parameters

LimitV1Model

LimitV1Model { name (string): The account limit name, value (number): The account limit value }

Response Class (Status 200)

Returns an object describing the updated limit.

Request and response examples

Request

Specifies the new limit value:

 Request Body example { "value": 25 }

Response

New limit value is displayed:

Response Body example
{ "name": "SharePoint_serverMax", "value": 25 }

Possible error response messages