Interaction SDK
(Web Services)

Service: SRLService


The Standard Response Library service.
Attribute Summary
com.genesyslab.ail.ws.Attachment[] srl:attachments
           The files attached to this standard response.
String srl:body
           The body text of this standard response.
String srl:categoryId
           The category identifier of this standard response.
String srl:description
           The description of this standard response.
boolean srl:hasAttachments
           true if this standard response has attached files.
String srl:lang
           The language of this standard response.
String srl:name
           The standard response name.
com.genesyslab.ail.ws.ShortAttachment[] srl:shortAttachments
           The short form of the attachment without the data.
String srl:structBody
           The structured body text of this StandardResponse. Note: Custom field codes are not replaced in the returned text.
String srl:structBodyMimeType
           Returns the MIME type of the structured body. Complies with rules described in RFC 2046. The text returned by calling getStructuredBody depends on this MIME type.
String srl-category:categoryId
           The standard response category identifier.
com.genesyslab.ail.ws.srl.SRLCategoryDTO[] srl-category:childCategories
           The child categories.
String srl-category:description
           The description of this category.
String srl-category:lang
           The language of this category.
long srl-category:modifiedDate
           The modified date of this category (GMT Time).
String srl-category:name
           The category name.
int srl-category:ownerId
           The owner ID of this category.
String srl-category:parentCategoryId
           The parent category identifier.
String srl-category:status
           The status of this category as a string. Status can be: 'Approved' or 'Not Approved'.
int srl-category:tenantId
           The tenant ID of this category.
com.genesyslab.ail.ws.srl.SRLCategoryType srl-category:type
           The type of this category.

Method Summary
com.genesyslab.ail.ws.srl.SRLFormResult[] addSRLFavorites
           Adds standard responses to the favorites of this agent.
com.genesyslab.ail.ws.srl.SRLCategoriesResponses findCategoriesAndResponses
           Finds the categories and standard responses that belong to a given category and match a given filter.
com.genesyslab.ail.ws.srl.SRLCategoryDTO[] findCategoriesDTO
           Finds information about the categories and standard responses of the SRL (Standard Response Library). For each category, this information includes the category data and the standard responses belonging to the category.
com.genesyslab.ail.ws.srl.SRLCategoriesResponses findCategoriesResponsesFromRoots
           Finds The categories and standard responses of the SRL (Standard Response Library) from all CategoryRoots.
com.genesyslab.ail.ws.srl.StandardResponseDTO[] findStandardResponsesDTO
           Finds information about the standard responses of the SRL (Standard Response Library).
com.genesyslab.ail.ws.srl.SRLCategoryDTO[] getCategoriesDTO
           Returns information about the given categories of the SRL (Standard Response Library). For each category, in addition to the category data, this method returns data of the standard responses belonging to the category.
String getStandardResponseBody
           Returns the body text of this standard response with the field codes replaced by their values.
String getStandardResponseBodyCustomFieldCodes
           Returns the body text of this standard response with the custom field codes replaced by their values.
com.genesyslab.ail.ws.srl.StandardResponseDTO[] getStandardResponsesByCategoryDTO
           Returns the requested attributes about the standard responses of a category.
com.genesyslab.ail.ws.srl.StandardResponseDTO[] getStandardResponsesDTO
           Returns the requested attributes for each standard response.
com.genesyslab.ail.ws.srl.SRLUsernameDTO[] getStandardResponsesFavoritesDTO
           Returns information about the favorite standard responses for each user.
String getStandardResponseStructuredBody
           Returns the structured body text of this StandardResponse, with all field codes replaced by their values. To determine the type of body returned, test its MIME type by reading srl:structBodyMimeType attribute. Full names are defined as "FirstName + ' ' + LastName".
String getStandardResponseStructuredBodyCustomFieldCodes
           Returns the structured body text of this StandardResponse, with all field codes replaced by their values. To determine the type of body returned, test its MIME type by reading srl:structBodyMimeType attribute. Full names are defined as FirstName + ' ' + LastName.
com.genesyslab.ail.ws.srl.SRLFormResult[] removeSRLFavorites
           Removes standard responses from the favorites of this agent.
void responseUsed
           Notifies the usage of this standard response.
com.genesyslab.ail.ws.srl.StandardResponseDTO[] searchInStandardResponseFavoritesDTO
           Returns the standard responses that match a given filter.

Event Summary
SRLEvent
           SRL service event. Report a SRL update.

Attribute Detail

Attributes of domain srl

Standard response attributes definition


attachments

Type: com.genesyslab.ail.ws.Attachment[]
The files attached to this standard response.
Properties: read


body

Type: String
The body text of this standard response.
Properties: read read-default


categoryId

Type: String
The category identifier of this standard response.
Properties: read


description

Type: String
The description of this standard response.
Properties: read read-default


hasAttachments

Type: boolean
true if this standard response has attached files.
Properties: read read-default


lang

Type: String
The language of this standard response.
Properties: read read-default


name

Type: String
The standard response name.
Properties: read read-default write


shortAttachments

Type: com.genesyslab.ail.ws.ShortAttachment[]
The short form of the attachment without the data.
Properties: read read-default


structBody

Type: String
The structured body text of this StandardResponse. Note: Custom field codes are not replaced in the returned text.
Properties: read read-default


structBodyMimeType

Type: String
Returns the MIME type of the structured body. Complies with rules described in RFC 2046. The text returned by calling getStructuredBody depends on this MIME type.
Properties: read read-default write


Attributes of domain srl-category

Standard response category attributes definition


categoryId

Type: String
The standard response category identifier.
Properties: read read-default


childCategories

Type: com.genesyslab.ail.ws.srl.SRLCategoryDTO[]
The child categories.
Properties: read read-default


description

Type: String
The description of this category.
Properties: read read-default


lang

Type: String
The language of this category.
Properties: read read-default


modifiedDate

Type: long
The modified date of this category (GMT Time).
Properties: read read-default write


name

Type: String
The category name.
Properties: read read-default


ownerId

Type: int
The owner ID of this category.
Properties: read read-default


parentCategoryId

Type: String
The parent category identifier.
Properties: read


status

Type: String
The status of this category as a string. Status can be: 'Approved' or 'Not Approved'.
Properties: read read-default


tenantId

Type: int
The tenant ID of this category.
Properties: read read-default


type

Type: com.genesyslab.ail.ws.srl.SRLCategoryType
The type of this category.
Properties: read read-default write


Method Detail

addSRLFavorites

Adds standard responses to the favorites of this agent.
Parameters:

  srlForms  com.genesyslab.ail.ws.srl.SRLForm[]
   Standard responses to be added.

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLFormResult[]

   The result of the action for each response. The SRLFormResult.done field is true if the action was successful.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


findCategoriesAndResponses

Finds the categories and standard responses that belong to a given category and match a given filter.
Parameters:

  categoryId  String
   The category identifier.

  searchTemplate  com.genesyslab.ail.ws.srl.SRLSearchTemplate
   a SearchSRLTemplate that contains the filter.

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLCategoriesResponses

   The categories and standard responses identifiers.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.SRL.CategoryInvalid


findCategoriesDTO

Finds information about the categories and standard responses of the SRL (Standard Response Library). For each category, this information includes the category data and the standard responses belonging to the category.
Parameters:

  categoryId  String
   The category identifier.

  searchTemplate  com.genesyslab.ail.ws.srl.SRLSearchTemplate
   a SearchSRLTemplate that contains the filter.

  categoryAttributes  String[]
   The attributes to be retrieved for each category (srl-category:*).

  srAttributes  String[]
   The attributes to be retrieved for each standard response belonging to those categories (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLCategoryDTO[]

   The DTO data for each category. Note: if the category identifier is invalid, the SRLCategoryDTO.data field is empty.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.SRL.CategoryInvalid


findCategoriesResponsesFromRoots

Finds The categories and standard responses of the SRL (Standard Response Library) from all CategoryRoots.
Parameters:

  searchCriteria  com.genesyslab.ail.ws.srl.SRLSearchCriteria
   The search criteria.

  searchTemplate  com.genesyslab.ail.ws.srl.SRLSearchTemplate
   a SearchSRLTemplate that contains the filter.

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLCategoriesResponses

   The categories and standard responses identifiers.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.SRL.CategoryInvalid


findStandardResponsesDTO

Finds information about the standard responses of the SRL (Standard Response Library).
Parameters:

  categoryId  String
   The category identifier to find from.

  searchTemplate  com.genesyslab.ail.ws.srl.SRLSearchTemplate
   a SearchSRLTemplate that contains the filter.

  srAttributes  String[]
   The attributes to be retrieved for each standard response belonging to those categories (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.StandardResponseDTO[]

   The DTO data for each standard response. Note: if the standard response identifier is invalid, the StandardResponseDTO.data field is empty.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.SRL.CategoryInvalid


getCategoriesDTO

Returns information about the given categories of the SRL (Standard Response Library). For each category, in addition to the category data, this method returns data of the standard responses belonging to the category.
Parameters:

  categoryIds  String[]
   The category identifiers. If null, returns all root categories.

  categoryAttributes  String[]
   The attributes to be retrieved for each category (srl-category:*).

  srAttributes  String[]
   The attributes to be retrieved for each standard response that belongs to one of the returned categories. (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLCategoryDTO[]

   The DTO data for each category. Note: if the category identifier is invalid, the SRLCategoryDTO.data and SRLCategoryDTO.srlsDTO fields are empty.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


getStandardResponseBody

Returns the body text of this standard response with the field codes replaced by their values.
Parameters:

  srlId  String
   The standard response identifier.

  agentId  String
   The agent identifier.

  interactionId  String
   The interaction identifier.

Returns:

  Type:  String

   The body text.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid

  error.srl.StandardResponseNotFound

  error.srl.AgentNotFound

  error.srl.InteractionNotFound


getStandardResponseBodyCustomFieldCodes

Returns the body text of this standard response with the custom field codes replaced by their values.
Parameters:

  srlId  String
   The standard response identifier.

  agentId  String
   The agent identifier.

  interactionId  String
   The interaction identifier.

  customFieldCodes  com.genesyslab.ail.ws.KeyValue[]
   The concerned Custom Field Codes.

Returns:

  Type:  String

   The body text.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid

  error.srl.StandardResponseNotFound

  error.srl.AgentNotFound

  error.srl.InteractionNotFound


getStandardResponsesByCategoryDTO

Returns the requested attributes about the standard responses of a category.
Parameters:

  categoryId  String
   The category identifier.

  attributes  String[]
   The attributes to be retrieved (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.StandardResponseDTO[]

   The attributes for each standard response.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


getStandardResponsesDTO

Returns the requested attributes for each standard response.
Parameters:

  srlIds  String[]
   The standard response identifiers. Cannot be null.

  attributes  String[]
   The attributes to be retrieved (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.StandardResponseDTO[]

   The attributes for each standard response. Note: if the standard response identifier is invalid, the StandardResponseDTO.data field is empty.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


getStandardResponsesFavoritesDTO

Returns information about the favorite standard responses for each user.
Parameters:

  usernames  String[]
   The agent user names.

  attributes  String[]
   The attributes to be retrieved (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLUsernameDTO[]

   The attributes of the favorite standard responses for each user. Note: if the username identifier is invalid, the returned SRLUsernameDTO.data field is empty.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


getStandardResponseStructuredBody

Returns the structured body text of this StandardResponse, with all field codes replaced by their values. To determine the type of body returned, test its MIME type by reading srl:structBodyMimeType attribute. Full names are defined as "FirstName + ' ' + LastName".
Parameters:

  srlId  String
   The standard response identifier.

  agentId  String
   The agent identifier.

  interactionId  String
   The interaction identifier.

Returns:

  Type:  String

   The body text.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid

  error.srl.StandardResponseNotFound

  error.srl.AgentNotFound

  error.srl.InteractionNotFound


getStandardResponseStructuredBodyCustomFieldCodes

Returns the structured body text of this StandardResponse, with all field codes replaced by their values. To determine the type of body returned, test its MIME type by reading srl:structBodyMimeType attribute. Full names are defined as FirstName + ' ' + LastName.
Parameters:

  srlId  String
   The standard response identifier.

  agentId  String
   The agent identifier.

  interactionId  String
   The interaction identifier.

  customFieldCodes  com.genesyslab.ail.ws.KeyValue[]
   The concerned Custom Field Codes.

Returns:

  Type:  String

   The body text.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid

  error.srl.StandardResponseNotFound

  error.srl.AgentNotFound

  error.srl.InteractionNotFound


removeSRLFavorites

Removes standard responses from the favorites of this agent.
Parameters:

  srlForms  com.genesyslab.ail.ws.srl.SRLForm[]
   Standard responses to be removed.

Returns:

  Type:  com.genesyslab.ail.ws.srl.SRLFormResult[]

   The result of the action for each response. The SRLFormResult.done field is true if the action was successful.

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid


responseUsed

Notifies the usage of this standard response.
Parameters:

  agentId  String
   The agent who used the response.

  standardResponseId  String
   The standard response identifier.

  interactionEmailOutId  String
   The interaction identifier.

  feedbackType  com.genesyslab.ail.ws.srl.SRLResponseType
   The feedback type.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

   error.common.ParameterInvalid

  error.srl.StandardResponseNotFound

  error.srl.AgentNotFound

  error.srl.InteractionNotFound


searchInStandardResponseFavoritesDTO

Returns the standard responses that match a given filter.
Parameters:

  username  String
   The agent, the response IDs of whom are requested.

  searchTemplate  com.genesyslab.ail.ws.srl.SRLSearchTemplate
   a SearchSRLTemplate that contains the filter.

  srAttributes  String[]
   The attributes to retrieve for each standard response contained in those categories (srl:*).

Returns:

  Type:  com.genesyslab.ail.ws.srl.StandardResponseDTO[]

   The DTO data for each standard response. Note: if the standard response identifier is invalid, the StandardResponseDTO.data field is empty.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid

  error.SRL.CategoryInvalid


Event Detail

SRLEvent

SRL service event. Report a SRL update.
Available attributes:  * or can be null.

Filters:

Triggers:

  Key: *   Value: *  -  The trigger key,value pair can be null.


Interaction SDK
(Web Services)