IRestClient

Interface for general class to send requests to CATI REST API. This class is used from SDK service classes (like GroupService, SurveyService and others) and it is not supposed to use this class directly.

Properties

HttpClient

Http client object to send requests

Methods


GetAsyncIds<T>(string urlItem, int key, string urlSubItem)

Send Get request with result as list of integer values

Parameters

urlItem

Rest API url part before key value

key

Key value to identify object

urlSubItem

Rest API url part after key value

Returns

List of integer values


GetAsyncSubItem<T>(string urlItem, int key, string urlSubItem)

Send Get request with result as list of objects

Parameters

urlItem

Rest API url part before key value

key

Key value to identify object

urlSubItem

Rest API url part after key value

Returns

List of objects


GetAsyncMany<T>(string urlItem, string odataQuery)

Send Get request with result as list of objects using OData request

Parameters

urlItem

Rest API url part

odataQuery

String with OData filter

Returns

List of objects


GetAsyncSingle<T>(string urlItem, int key)

Send Get request with result as object by integer key

Parameters

urlItem

Rest API url part

key

Key value to identify object

Returns

Object


GetAsyncSingle<T>(string urlItem, string key)

Send Get request with result as object by string key

Parameters

urlItem

Rest API url part

key

Key value to identify object

Returns

Object


PostAsync<T>(string urlItem, T t, int key)

Send Post request with result as integer value

Parameters

urlItem

Rest API url part

t

Type of object

key

Key value to identify object (must be 0 in this case)

Returns

Integer value


PostAsync<T>(string urlItem, T t)

Sends POST request without key of the entity and returns a success status code

Parameters

urlItem

REST API url part

t

Type of object


PutAsync<T>(string urlItem, T t, int key)

Send Put request with result as integer value

Parameters

urlItem

Rest API url part

t

Type of object

key

Key value to identify object

Returns

Integer value


DeleteAsync(string urlItem, int key)

Send Delete request

Parameters

urlItem

Rest API url part

key

Key value to identify object


InvokeActionForVoid(string urlItem, int key, string nameSpace, string action, string parameters)

Send Get request without result value by integer key

Parameters

urlItem

Rest API url part

key

Key value to identify object

nameSpace

Namespace

action

Action

parameters

Parameters


InvokeActionForVoid(string urlItem, string key, string nameSpace, string action, string parameters)

Send Get request without result value by string key

Parameters

urlItem

Rest API url part

key

Key value to identify object

nameSpace

Namespace

action

Action

parameters

Parameters


InvokeActionForList<T>(string urlItem, int key, string nameSpace, string action, string parameters)

Send Get request with result as list of objects by string key

Parameters

urlItem

Rest API url part

key

Key value to identify object

nameSpace

Namespace

action

Action

parameters

Parameters

Returns

List of objects


InvokeActionForList<T>(string urlItem, string key, string nameSpace, string action, string parameters)

Send Get request with result as list of objects by integer key

Parameters

urlItem

Rest API url part

key

Key value to identify object

nameSpace

Namespace

action

Action

parameters

Parameters

Returns

List of objects


InvokeActionForSingle<T>(string urlItem, string key, string nameSpace, string action, string parameters)

Send Get request with result as objects by string key

Parameters

urlItem

Rest API url part

key

Key value to identify object

nameSpace

Namespace

action

Action

parameters

Parameters

Returns

Object