/AWS1/IF_PTB=>GETBENEFITALLOCATION()

About GetBenefitAllocation

Retrieves detailed information about a specific benefit allocation that has been granted to a partner.

Method Signature

METHODS /AWS1/IF_PTB~GETBENEFITALLOCATION
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTBCATALOGNAME OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PTBBENEFITALLOCID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptbgetbenefallocout
  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 that specifies which benefit catalog to query.

iv_identifier TYPE /AWS1/PTBBENEFITALLOCID /AWS1/PTBBENEFITALLOCID

The unique identifier of the benefit allocation to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptbgetbenefallocout /AWS1/CL_PTBGETBENEFALLOCOUT

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->getbenefitallocation(
  iv_catalog = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_benefitallocationid = lo_result->get_id( ).
  lv_catalogname = lo_result->get_catalog( ).
  lv_benefitallocationarn = lo_result->get_arn( ).
  lv_string = lo_result->get_name( ).
  lv_string = lo_result->get_description( ).
  lv_benefitallocationstatus = lo_result->get_status( ).
  lv_string = lo_result->get_statusreason( ).
  lv_benefitapplicationid = lo_result->get_benefitapplicationid( ).
  lv_benefitid = lo_result->get_benefitid( ).
  lv_fulfillmenttype = lo_result->get_fulfillmenttype( ).
  LOOP AT lo_result->get_applicablebenefitids( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_benefitid = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_fulfillmentdetails = lo_result->get_fulfillmentdetail( ).
  IF lo_fulfillmentdetails IS NOT INITIAL.
    lo_disbursementdetails = lo_fulfillmentdetails->get_disbursementdetails( ).
    IF lo_disbursementdetails IS NOT INITIAL.
      lo_monetaryvalue = lo_disbursementdetails->get_disbursedamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      lo_issuancedetail = lo_disbursementdetails->get_issuancedetails( ).
      IF lo_issuancedetail IS NOT INITIAL.
        lv_string = lo_issuancedetail->get_issuanceid( ).
        lo_monetaryvalue = lo_issuancedetail->get_issuanceamount( ).
        IF lo_monetaryvalue IS NOT INITIAL.
          lv_string = lo_monetaryvalue->get_amount( ).
          lv_currencycode = lo_monetaryvalue->get_currencycode( ).
        ENDIF.
        lv_timestamp = lo_issuancedetail->get_issuedat( ).
      ENDIF.
    ENDIF.
    lo_consumabledetails = lo_fulfillmentdetails->get_consumabledetails( ).
    IF lo_consumabledetails IS NOT INITIAL.
      lo_monetaryvalue = lo_consumabledetails->get_allocatedamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      lo_monetaryvalue = lo_consumabledetails->get_remainingamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      lo_monetaryvalue = lo_consumabledetails->get_utilizedamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      lo_issuancedetail = lo_consumabledetails->get_issuancedetails( ).
      IF lo_issuancedetail IS NOT INITIAL.
        lv_string = lo_issuancedetail->get_issuanceid( ).
        lo_monetaryvalue = lo_issuancedetail->get_issuanceamount( ).
        IF lo_monetaryvalue IS NOT INITIAL.
          lv_string = lo_monetaryvalue->get_amount( ).
          lv_currencycode = lo_monetaryvalue->get_currencycode( ).
        ENDIF.
        lv_timestamp = lo_issuancedetail->get_issuedat( ).
      ENDIF.
    ENDIF.
    lo_creditdetails = lo_fulfillmentdetails->get_creditdetails( ).
    IF lo_creditdetails IS NOT INITIAL.
      lo_monetaryvalue = lo_creditdetails->get_allocatedamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      lo_monetaryvalue = lo_creditdetails->get_issuedamount( ).
      IF lo_monetaryvalue IS NOT INITIAL.
        lv_string = lo_monetaryvalue->get_amount( ).
        lv_currencycode = lo_monetaryvalue->get_currencycode( ).
      ENDIF.
      LOOP AT lo_creditdetails->get_codes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_awsaccountid( ).
          lo_monetaryvalue = lo_row_3->get_value( ).
          IF lo_monetaryvalue IS NOT INITIAL.
            lv_string = lo_monetaryvalue->get_amount( ).
            lv_currencycode = lo_monetaryvalue->get_currencycode( ).
          ENDIF.
          lv_string = lo_row_3->get_awscreditcode( ).
          lv_benefitallocationstatus = lo_row_3->get_status( ).
          lv_timestamp = lo_row_3->get_issuedat( ).
          lv_timestamp = lo_row_3->get_expiresat( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_accessdetails = lo_fulfillmentdetails->get_accessdetails( ).
    IF lo_accessdetails IS NOT INITIAL.
      lv_string = lo_accessdetails->get_description( ).
    ENDIF.
  ENDIF.
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
  lv_timestamp = lo_result->get_startsat( ).
  lv_timestamp = lo_result->get_expiresat( ).
ENDIF.