
###########
OutOfOffice
###########


****
NAME
****


Kernel::GenericInterface::Mapping::OutOfOffice


********
SYNOPSIS
********



****************
PUBLIC INTERFACE
****************


new()
=====


usually, you want to create an instance of this
by using Kernel::GenericInterface::Mapping->new();


Map()
=====


perform data mapping


.. code-block:: perl

     my $Result = $MappingObject->Map(
         Data => {                                                                           # data payload before mapping
             SessionID                   => 'AValidSessionIDValue',                          # the ID of the user session
             UserLogin                   => 'Agent',                                         # if no SessionID is given UserLogin is required
             Password                    => 'some password',                                 # user password
             OutOfOfficeEntriesCSVString => 'CSV string with out-of-office entries to set',
         },
     );
 
     $Result = {
         Success         => 1,  # 0 or 1
         ErrorMessage    => '', # in case of error
         Data            => {                                                                # data payload of after mapping
             SessionID                   => 'AValidSessionIDValue',                          # the ID of the user session
             UserLogin                   => 'Agent',                                         # if no SessionID is given UserLogin is required
             Password                    => 'some password',                                 # user password
             OutOfOfficeEntriesCSVString => 'CSV string with out-of-office entries to set',
             OutOfOfficeEntries          => [
                 {
                     UserLogin   => '...',
                     UserSearch  => '...',
                     UserEmail   => '...',
                     StartDate   => '...',
                     EndDate     => '...',
                     OutOfOffice => 1,
                 },
 
                 # ...
             ],
         },
     };




