NAME

Kernel::GenericInterface::Invoker::Ticket::Common – common Invoker functions

DESCRIPTION

All common functions for Tickets.

PUBLIC INTERFACE

new()

create an object

    use Kernel::GenericInterface::Invoker::Ticket::Common;

    my $TicketCommonObject = Kernel::GenericInterface::Invoker::Ticket::Common->new(
        DebuggerObject     => $DebuggerObject,
        Invoker            => 'TicketCreate', # example
    );

PrepareRequest()

prepare the invocation of the configured remote web-service.

    my $Result = $InvokerObject->PrepareRequest(
        Data => {                                               # data payload
            TicketID => 123,
            ArticleID => 123,                                   # optional
        },
    );

Result example: { Data => { Ticket => { Title => 'some ticket title', Queue => 'some queue name', Lock => 'some lock name', # optional Type => 'some type name', # optional Service => 'some service name', # optional SLA => 'some SLA name', # optional State => 'some state name', Priority => 'some priority name', Owner => 'some user login', # optional Responsible => 'some user login', # optional CustomerUser => 'some customer user login', PendingTime { # optional Year => 2011, Month => 12 Day => 03, Hour => 23, Minute => 05, }, }, Article => { SenderType => 'some sender type name', # optional AutoResponseType => 'some auto response type', # optional From => 'some from string', # optional Subject => 'some subject', Body => 'some body'

                ContentType      => 'some content type',        # ContentType or MimeType and Charset is requieed
                MimeType         => 'some mime type',
                Charset          => 'some charset',
                TimeUnit         => 123,                        # optional
            },

            DynamicField => [                                   # optional
                {
                    Name   => 'some name',
                    Value  => 'Value',                          # value type depends on the dynamic field
                },
                # ...
            ],

            Attachment => [
                {
                    Content     => 'content'                    # base64 encoded
                    ContentType => 'some content type'
                    Filename    => 'some fine name'
                },
                # ...
            ],
        },
    };

HandleResponse()

handle response data of the configured remote web-service.

    my $Result = $InvokerObject->HandleResponse(
        ResponseSuccess      => 1,              # success status of the remote web-service
        ResponseErrorMessage => '',             # in case of web-service error
        Data => {                               # data payload
            ...
        },
    );

    $Result = {
        Success         => 1,                   # 0 or 1
        ErrorMessage    => '',                  # in case of error
        Data            => {                    # data payload after Invoker
            ...
        },
    };

ReturnError()

helper function to return an error message.

    my $Return = $CommonObject->ReturnError(
        ErrorCode    => Ticket.AccessDenied,
        ErrorMessage => 'You dont have rights to access this ticket',
    );