POST api/interactiontype

Create a new interaction type.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, POSTapi/interactiontype. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

Interaction type data.

InteractionTypesDto
NameDescriptionTypeAdditional information
ComplaintTypeID

Primary key of ComplaintType table.

integer
Code

Code for interaction type.

string
Description

Description for interaction type.

string
DefaultItem

Indicates interaction type is set default or not.

boolean
Active

Indicates interaction type is active or not.

boolean
UpdateMode

Update mode for interaction type (i.e.) Add, edit or delete.

integer

Request Formats

application/json, text/json

Sample:
{
  "complaintTypeID": 1,
  "code": "sample string 1",
  "description": "sample string 2",
  "defaultItem": true,
  "active": true,
  "updateMode": 1
}

application/xml, text/xml

Sample:
<InteractionTypesDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <Active>true</Active>
  <Code>sample string 1</Code>
  <ComplaintTypeID>1</ComplaintTypeID>
  <DefaultItem>true</DefaultItem>
  <Description>sample string 2</Description>
  <UpdateMode>1</UpdateMode>
</InteractionTypesDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Success Status:

  • Created (201), please see resource description below.

Failed Status(es):

Resource Description

InteractionTypesDto
NameDescriptionTypeAdditional information
ComplaintTypeID

Primary key of ComplaintType table.

integer
Code

Code for interaction type.

string
Description

Description for interaction type.

string
DefaultItem

Indicates interaction type is set default or not.

boolean
Active

Indicates interaction type is active or not.

boolean
UpdateMode

Update mode for interaction type (i.e.) Add, edit or delete.

integer

Response Formats

application/json, text/json

Sample:
{
  "complaintTypeID": 1,
  "code": "sample string 1",
  "description": "sample string 2",
  "defaultItem": true,
  "active": true,
  "updateMode": 1
}

application/xml, text/xml

Sample:
<InteractionTypesDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CRM">
  <Active>true</Active>
  <Code>sample string 1</Code>
  <ComplaintTypeID>1</ComplaintTypeID>
  <DefaultItem>true</DefaultItem>
  <Description>sample string 2</Description>
  <UpdateMode>1</UpdateMode>
</InteractionTypesDto>