CREATERGNSFROMBRANDPROFILE()`¶

About CreateRegistrationsFromBrandProfile¶

Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.

Method Signature¶

METHODS /AWS1/IF_PPU~CREATERGNSFROMBRANDPROFILE
  IMPORTING
    !IV_BRANDPROFILEID TYPE /AWS1/PPUBRANDPROFILEIDORARN OPTIONAL
    !IT_REGISTRATIONTYPES TYPE /AWS1/CL_PPUREGTYPELIST_W=>TT_REGISTRATIONTYPELIST OPTIONAL
    !IV_SMARTMATCH TYPE /AWS1/PPUBOOLEAN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/PPUCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ppucreregfrmbrdpflout
  RAISING
    /AWS1/CX_PPUACCESSDENIEDEX
    /AWS1/CX_PPUCONFLICTEXCEPTION
    /AWS1/CX_PPUINTERNALSERVEREX
    /AWS1/CX_PPURESOURCENOTFOUNDEX
    /AWS1/CX_PPUTHROTTLINGEX
    /AWS1/CX_PPUVLDTNEXCEPTION
    /AWS1/CX_PPUCLIENTEXC
    /AWS1/CX_PPUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_brandprofileid` `TYPE /AWS1/PPUBRANDPROFILEIDORARN` `/AWS1/PPUBRANDPROFILEIDORARN`¶

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

`it_registrationtypes` `TYPE /AWS1/CL_PPUREGTYPELIST_W=>TT_REGISTRATIONTYPELIST` `TT_REGISTRATIONTYPELIST`¶

The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.

Optional arguments:¶

`iv_smartmatch` `TYPE /AWS1/PPUBOOLEAN` `/AWS1/PPUBOOLEAN`¶

Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

`iv_clienttoken` `TYPE /AWS1/PPUCLIENTTOKEN` `/AWS1/PPUCLIENTTOKEN`¶

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ppucreregfrmbrdpflout` `/AWS1/CL_PPUCREREGFRMBRDPFLOUT`¶

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->creatergnsfrombrandprofile(
  it_registrationtypes = VALUE /aws1/cl_ppuregtypelist_w=>tt_registrationtypelist(
    ( new /aws1/cl_ppuregtypelist_w( |string| ) )
  )
  iv_brandprofileid = |string|
  iv_clienttoken = |string|
  iv_smartmatch = ABAP_TRUE
).

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_results( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_jobid = lo_row_1->get_jobid( ).
      lv_jobresourceidentifier = lo_row_1->get_resourceidentifier( ).
    ENDIF.
  ENDLOOP.
ENDIF.

Create draft registrations from a brand profile¶

Create draft registrations from a brand profile

DATA(lo_result) = lo_client->creatergnsfrombrandprofile(
  it_registrationtypes = VALUE /aws1/cl_ppuregtypelist_w=>tt_registrationtypelist(
    ( new /aws1/cl_ppuregtypelist_w( |US_TOLL_FREE_REGISTRATION| ) )
  )
  iv_brandprofileid = |bp-abc12345678901234|
  iv_smartmatch = ABAP_TRUE
).

/AWS1/IF_PPU=>CREATERGNSFROMBRANDPROFILE()¶