/AWS1/IF_PTB=>LISTBENEFITALLOCATIONS()

About ListBenefitAllocations

Retrieves a paginated list of benefit allocations based on specified filter criteria.

Method Signature

METHODS /AWS1/IF_PTB~LISTBENEFITALLOCATIONS
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTBCATALOGNAME OPTIONAL
    !IT_FULFILLMENTTYPES TYPE /AWS1/CL_PTBFULFILLMENTTYPES_W=>TT_FULFILLMENTTYPES OPTIONAL
    !IT_BENEFITIDENTIFIERS TYPE /AWS1/CL_PTBBENEFITIDS_W=>TT_BENEFITIDENTIFIERS OPTIONAL
    !IT_BENEFITAPPIDENTIFIERS TYPE /AWS1/CL_PTBBENEFITAPPIDLIST_W=>TT_BENEFITAPPIDENTIFIERLIST OPTIONAL
    !IT_STATUS TYPE /AWS1/CL_PTBBENALCTATUSLIST_W=>TT_BENEFITALLOCATIONSTATUSLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTBINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptblistbenefallocsout
  RAISING
    /AWS1/CX_PTBACCESSDENIEDEX
    /AWS1/CX_PTBINTERNALSERVEREX
    /AWS1/CX_PTBRESOURCENOTFOUNDEX
    /AWS1/CX_PTBTHROTTLINGEX
    /AWS1/CX_PTBVLDTNEXCEPTION
    /AWS1/CX_PTBCLIENTEXC
    /AWS1/CX_PTBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTBCATALOGNAME /AWS1/PTBCATALOGNAME

The catalog identifier to filter benefit allocations by catalog.

Optional arguments:

it_fulfillmenttypes TYPE /AWS1/CL_PTBFULFILLMENTTYPES_W=>TT_FULFILLMENTTYPES TT_FULFILLMENTTYPES

Filter benefit allocations by specific fulfillment types.

it_benefitidentifiers TYPE /AWS1/CL_PTBBENEFITIDS_W=>TT_BENEFITIDENTIFIERS TT_BENEFITIDENTIFIERS

Filter benefit allocations by specific benefit identifiers.

it_benefitappidentifiers TYPE /AWS1/CL_PTBBENEFITAPPIDLIST_W=>TT_BENEFITAPPIDENTIFIERLIST TT_BENEFITAPPIDENTIFIERLIST

Filter benefit allocations by specific benefit application identifiers.

it_status TYPE /AWS1/CL_PTBBENALCTATUSLIST_W=>TT_BENEFITALLOCATIONSTATUSLIST TT_BENEFITALLOCATIONSTATUSLIST

Filter benefit allocations by their current status.

iv_maxresults TYPE /AWS1/PTBINTEGER /AWS1/PTBINTEGER

The maximum number of benefit allocations to return in a single response.

iv_nexttoken TYPE /AWS1/PTBSTRING /AWS1/PTBSTRING

A pagination token to retrieve the next set of results from a previous request.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptblistbenefallocsout /AWS1/CL_PTBLISTBENEFALLOCSOUT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listbenefitallocations(
  it_benefitappidentifiers = VALUE /aws1/cl_ptbbenefitappidlist_w=>tt_benefitappidentifierlist(
    ( new /aws1/cl_ptbbenefitappidlist_w( |string| ) )
  )
  it_benefitidentifiers = VALUE /aws1/cl_ptbbenefitids_w=>tt_benefitidentifiers(
    ( new /aws1/cl_ptbbenefitids_w( |string| ) )
  )
  it_fulfillmenttypes = VALUE /aws1/cl_ptbfulfillmenttypes_w=>tt_fulfillmenttypes(
    ( new /aws1/cl_ptbfulfillmenttypes_w( |string| ) )
  )
  it_status = VALUE /aws1/cl_ptbbenalctatuslist_w=>tt_benefitallocationstatuslist(
    ( new /aws1/cl_ptbbenalctatuslist_w( |string| ) )
  )
  iv_catalog = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_benefitallocsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_benefitallocationid = lo_row_1->get_id( ).
      lv_catalogname = lo_row_1->get_catalog( ).
      lv_string = lo_row_1->get_arn( ).
      lv_benefitallocationstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_benefitallocationname = lo_row_1->get_name( ).
      lv_benefitid = lo_row_1->get_benefitid( ).
      lv_benefitapplicationid = lo_row_1->get_benefitapplicationid( ).
      LOOP AT lo_row_1->get_fulfillmenttypes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_fulfillmenttype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_timestamp = lo_row_1->get_expiresat( ).
      LOOP AT lo_row_1->get_applicablebenefitids( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_benefitid = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.