Interaction SDK
(Web Services)

Service: PlaceService


Gives information about the places where agents can sit.
Attribute Summary
String place:currentAgentId
           The identifier of the agent currently logged into this place.
String place:dnAdded
           The ID of the DN added into the place. Related to PlaceEventReason: DN_ADDED.
String place:dnRemoved
           The ID of the DN removed from the place. Related to PlaceEventReason: DN_REMOVED.
com.genesyslab.ail.ws.place.VoiceMediaInfo[] place:dns
           The list of DNs available on this place.
com.genesyslab.ail.ws.agent.DnWorkmodesPossible[] place:dnsWorkmodesPossible
           The possible workmodes on each DN of this place.
com.genesyslab.ail.ws.place.PlaceEventReason place:eventReason
           The media status.
boolean place:isDNDMultimedia
           The status of the Do-Not-Disturb feature for multimedia.
boolean place:isEnabled
           The status of the Place object in the Configuration Layer.
String place:mediaAdded
           The added media name. Related to PlaceEventReason: MEDIA_ADDED.
String place:mediaRemoved
           The removed media name. Related to PlaceEventReason: MEDIA_REMOVED.
com.genesyslab.ail.ws.place.MediaInfo[] place:medias
           The list of medias available on this place.
com.genesyslab.ail.ws.place.MediaInfo place:mediaStatusChanged
           Information about media. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.
String[] place:placeGroups
           PlaceGroups identifiers to which this place belongs.
String place:placeId
           The current place identifier when a place event occurs.
String place:statusReason
           the reason of the status of the media. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.
String place:statusReasonDescription
           The description of the reason of the status of the media.. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.

Method Summary
com.genesyslab.ail.ws.place.PlaceDTO[] getPlacesDTO
           Retrieves all the requested attributes on those places.
com.genesyslab.ail.ws.place.PlaceError[] setPlacesDTO
           Sets the data on these places.

Event Summary
PlaceEvent
           Place event.

Attribute Detail

Attributes of domain place

Places attributes definition


currentAgentId

Type: String
The identifier of the agent currently logged into this place.
Properties: read


dnAdded

Type: String
The ID of the DN added into the place. Related to PlaceEventReason: DN_ADDED.
Properties: event-default event


dnRemoved

Type: String
The ID of the DN removed from the place. Related to PlaceEventReason: DN_REMOVED.
Properties: event-default event


dns

Type: com.genesyslab.ail.ws.place.VoiceMediaInfo[]
The list of DNs available on this place.
Properties: read


dnsWorkmodesPossible

Type: com.genesyslab.ail.ws.agent.DnWorkmodesPossible[]
The possible workmodes on each DN of this place.
Properties: read


eventReason

Type: com.genesyslab.ail.ws.place.PlaceEventReason
The media status.
Properties: event-default event


isDNDMultimedia

Type: boolean
The status of the Do-Not-Disturb feature for multimedia.
Properties: read write event


isEnabled

Type: boolean
The status of the Place object in the Configuration Layer.
Properties: read


mediaAdded

Type: String
The added media name. Related to PlaceEventReason: MEDIA_ADDED.
Properties: event-default event


mediaRemoved

Type: String
The removed media name. Related to PlaceEventReason: MEDIA_REMOVED.
Properties: event-default event


medias

Type: com.genesyslab.ail.ws.place.MediaInfo[]
The list of medias available on this place.
Properties: read


mediaStatusChanged

Type: com.genesyslab.ail.ws.place.MediaInfo
Information about media. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.
Properties: event-default event


placeGroups

Type: String[]
PlaceGroups identifiers to which this place belongs.
Properties: read


placeId

Type: String
The current place identifier when a place event occurs.
Properties: event-default event


statusReason

Type: String
the reason of the status of the media. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.
Properties: event


statusReasonDescription

Type: String
The description of the reason of the status of the media.. Related to PlaceEventReason:MEDIA_STATUS_CHANGED.
Properties: event


Method Detail

getPlacesDTO

Retrieves all the requested attributes on those places.
Parameters:

  placeIds  String[]
   The place identifiers.

  attributes  String[]
   The keys of the attributes to retrieve (place:*).

Returns:

  Type:  com.genesyslab.ail.ws.place.PlaceDTO[]

   The attributes for each place. NB : if the place identifier is invalid, it does not return data for the associated place.

Errors:

  error.common.AilFactoryNotInitialized


setPlacesDTO

Sets the data on these places.
Parameters:

  datas  com.genesyslab.ail.ws.place.PlaceDTO[]
   The attributes to set for each place (place:*).

Returns:

  Type:  com.genesyslab.ail.ws.place.PlaceError[]

   The errors on each place.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed
  

  error.common.ConfigurationService
  

  error.common.BadAttributeType
  

  error.place.PlaceNotExist
  


Event Detail

PlaceEvent

Place event.
Available attributes:  place:eventReason, place:placeId. place:dnAdded if a DN is added; place:dnRemoved if a DN is removed; place:eventReason, place:mediaAdded if a media is added, place:mediaRemoved if a media is removed. place:eventReason, place:isDNDMultimedia if the Do-Not-Disturb feature has been turned on or off.

Filters:

  Key: EVENT_REASON   Value: one event reason value.  -  See PlaceEventReason definition

Triggers:

  Key: PLACE   Value: placeId  -  Subscribes on this place


Interaction SDK
(Web Services)