NAME

Kernel::GenericInterface::Operation::CustomerCompany::CustomerCompanySearch – GenericInterface CustomerCompany Search Operation backend

_Run()

Perform customer company search Operation. This will return a Customer Company ID list.

    my $Result = $OperationObject->Run(
        Data => {
            UserLogin            => 'some agent login',                         # UserLogin or AccessToken is required
            AccessToken          => 123,
            Password             => 'some password',                            # if UserLogin is sent then Password is required

            CustomerID => 'aglufthansa',                                        # optional; to search for customer id
            CustomerID => 'agl*',                                               # starts with agl

            CustomerCompanyName => 'Lufthansa',                                 # optional; to search for customer name
            CustomerCompanyName => 'Luft*',                                     # starts with Luft

            Valid => 1,                                                         # optional; 1 or 0; default 1
                                                                                #   1 - the search will include only CustomerCompanies
                                                                                #       in state valid
                                                                                #   0 - the search will include CustomerCompanies
                                                                                #       in any valid state

            OrderBy => 'Down',                                                  # optional; Down|Up
            SortBy  => 'CustomerID',                                            # optional; CustomerID|CustomerCompanyName

            OrderBy => ['Down', 'Up'],                                          # optional; as ARRAY for sub sorting
            SortBy  => ['CustomerID', 'CustomerCompanyName'],                   # optional; as ARRAY for sub sorting

            Limit => 100,                                                       # optional; results limit
        }
    );

    $Result = {
        Success      => 1,                                                      # 0 or 1
        ErrorMessage => '',                                                     # in case of error
        Data         => {
            CustomerID => [
                'customer-company-a',
                'customer-company-b',
                ...
            ],
            Error => {                                                          # in case of error
                ErrorCode    => 'ErrorCode',
                ErrorMessage => 'Error Description',
            },
        },
    };