Generic

Generic#

NAME#

Kernel::GenericInterface::Invoker::Ticket::Generic - Generic Interface Invoker for ticket-related requester calls

DESCRIPTION#

Invoker that prepares requests and processes responses for ticket-related Generic Interface requester calls.

PUBLIC INTERFACE#

new()#

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

PrepareRequest()#

prepare the invocation of the configured remote web service.

my $Result = $InvokerObject->PrepareRequest(
    Data => {                               # data payload
        TicketID                 => 1,      # optional
        ArticleID                => 7,      # optional
        GetAllArticleAttachments => 1,      # optional, 0 as default. 0|1,
    },

    InvokerName => 'Generic',
    Webservice  => { ... },                 # optional
);

Returns:

$Result = {
    Success         => 1,                   # 0 or 1
    ErrorMessage    => '...',               # in case of error
    Data => {
        Ticket => { ... },
        Event  => { ... },
    },
};

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
        ...
    },
);

Returns:

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

HandleError()#

Calls HandleResponse() with ResponseSuccess = 0 and the provided Data.

SEE ALSO#

Kernel::GenericInterface::Invoker

Contents