Interface IIcrConfigService
This interface has operations for ICR Config resource management.
Syntax
public interface IIcrConfigServiceMethods
Create(IcrConfigCreate)
Create a new ICR configuration
Declaration
IcrConfig Create(IcrConfigCreate config)Parameters
| Type | Name | Description |
|---|---|---|
| IcrConfigCreate | config | Request object for creating a new ICR configuration |
Returns
| Type | Description |
|---|---|
| IcrConfig | Created IcrConfig |
Exceptions
| Type | Condition |
|---|---|
| UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result. |
| GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults. |
Delete(Guid[])
Deletes one or more ICR configurations based on their Ids
Declaration
void Delete(Guid[] icrConfigIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | icrConfigIds | Ids of the configurations to delete |
Exceptions
| Type | Condition |
|---|---|
| UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result. |
| GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults. |
Get(Guid)
Returns an IcrConfig based on the id, empty guid will return the default configuration
Declaration
IcrConfig Get(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | Id of the requested ICR configuration |
Returns
| Type | Description |
|---|---|
| IcrConfig | Requested IcrConfig with Id |
Exceptions
| Type | Condition |
|---|---|
| UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result. |
| GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults. |
List()
List ICR configurations, empty guid represents the default configuration
Declaration
List<IcrConfigMeta> List()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<IcrConfigMeta> | List of IcrConfigMeta containing the Id and Name of the configuration |
Exceptions
| Type | Condition |
|---|---|
| UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result. |
| GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults. |
Update(IcrConfig)
Update ICR configuration object based on its Id
Declaration
IcrConfig Update(IcrConfig config)Parameters
| Type | Name | Description |
|---|---|---|
| IcrConfig | config | ICR configuration to update |
Returns
| Type | Description |
|---|---|
| IcrConfig | Updated IcrConfig |
Exceptions
| Type | Condition |
|---|---|
| UnexpectedFault | An unexpected error occurred; equivalent of an 501 'Internal server error' http result. |
| GenericFault | The details within the fault identify the specific error. Thrown for expected business errors that have no specific faults. |