C# Class Foretagsplatsen.Api.Resources.KeyFigurePresetResource

Key figure data REST resource:

显示文件 Open project: foretagsplatsen/Foretagsplatsen-DotNet-API

Public Methods

Method	Description
Create ( KeyFigurePreset keyFigurePreset ) : void	Creates a new KeyFigurePreset. If the KeyFigurePreset does not contain an id or a list of KeyFigureTypes, an InvalidArguments exception will be thrown If the id of the KeyFigurePreset already exists for the company, an Exists exception will be thrown.
Delete ( string id ) : void	Deletes a KeyFigurePreset. If the id of the KeyFigurePreset doesn't exist for the company, a NotFound exception will be thrown
Get ( string id ) : KeyFigurePreset	Gets a single KeyFigurePreset for a company. If the id of the KeyFigurePreset doesn't exist for the company, a NotFound exception will be thrown
GetUrl ( ) : string	Url for the keyfigure preset data list resource
GetUrlWithPresetId ( string presetId ) : string	Url for the keyfigure preset data list resource
KeyFigurePresetResource ( ApiClient client, CompanyInfo company ) : System.Collections.Generic	Instantiates a new KeyFigurePresetResource object.
KeyFigurePresetResource ( ApiClient client, string businessIdentityCode ) : System.Collections.Generic	Instantiates a new KeyFigurePresetResource object.
List ( ) : List	Lists all KeyFigurePreset for a company.
Update ( KeyFigurePreset keyFigurePreset ) : void	Creates or updates a KeyFigurePreset If the KeyFigurePreset does not contain an id or a list of KeyFigureTypes, an InvalidArguments exception will be thrown

Method Details

Create() public method

Creates a new KeyFigurePreset. If the KeyFigurePreset does not contain an id or a list of KeyFigureTypes, an InvalidArguments exception will be thrown If the id of the KeyFigurePreset already exists for the company, an Exists exception will be thrown.

public Create ( KeyFigurePreset keyFigurePreset ) : void
keyFigurePreset	Foretagsplatsen.Api.Entities.KeyFigurePreset	The KeyFigurePreset to create
return	void

Delete() public method

Deletes a KeyFigurePreset. If the id of the KeyFigurePreset doesn't exist for the company, a NotFound exception will be thrown

public Delete ( string id ) : void
id	string	The id of the KeyFigurePreset to delete
return	void

Get() public method

Gets a single KeyFigurePreset for a company. If the id of the KeyFigurePreset doesn't exist for the company, a NotFound exception will be thrown

public Get ( string id ) : KeyFigurePreset
id	string	The id of the KeyFigurePreset to get
return	Foretagsplatsen.Api.Entities.KeyFigurePreset

GetUrl() public method

Url for the keyfigure preset data list resource

public GetUrl ( ) : string
return	string

GetUrlWithPresetId() public method

Url for the keyfigure preset data list resource

public GetUrlWithPresetId ( string presetId ) : string
presetId	string
return	string

KeyFigurePresetResource() public method

Instantiates a new KeyFigurePresetResource object.

public KeyFigurePresetResource ( ApiClient client, CompanyInfo company ) : System.Collections.Generic
client	ApiClient	REST client
company	Foretagsplatsen.Api.Entities.CompanyInfo	Company
return	System.Collections.Generic

KeyFigurePresetResource() public method

Instantiates a new KeyFigurePresetResource object.

public KeyFigurePresetResource ( ApiClient client, string businessIdentityCode ) : System.Collections.Generic
client	ApiClient	REST client
businessIdentityCode	string	Business identity code for company.
return	System.Collections.Generic

List() public method

Lists all KeyFigurePreset for a company.

public List ( ) : List
return	List

Update() public method

Creates or updates a KeyFigurePreset If the KeyFigurePreset does not contain an id or a list of KeyFigureTypes, an InvalidArguments exception will be thrown

public Update ( KeyFigurePreset keyFigurePreset ) : void
keyFigurePreset	Foretagsplatsen.Api.Entities.KeyFigurePreset	The KeyFigurePreset to create or update
return	void