/AWS1/IF_GST=>LISTCONTACTS()

About ListContacts

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

Method Signature

METHODS /AWS1/IF_GST~LISTCONTACTS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/GSTPAGINATIONMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GSTPAGINATIONTOKEN OPTIONAL
    !IT_STATUSLIST TYPE /AWS1/CL_GSTSTATUSLIST_W=>TT_STATUSLIST OPTIONAL
    !IV_STARTTIME TYPE /AWS1/GSTTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/GSTTIMESTAMP OPTIONAL
    !IV_GROUNDSTATION TYPE /AWS1/GSTGROUNDSTATIONNAME OPTIONAL
    !IV_SATELLITEARN TYPE /AWS1/GSTSATELLITEARN OPTIONAL
    !IV_MISSIONPROFILEARN TYPE /AWS1/GSTMISSIONPROFILEARN OPTIONAL
    !IO_EPHEMERIS TYPE REF TO /AWS1/CL_GSTEPHEMERISFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gstlistcontactsrsp
  RAISING
    /AWS1/CX_GSTDEPENDENCYEX
    /AWS1/CX_GSTINVALIDPARAMETEREX
    /AWS1/CX_GSTRESOURCENOTFOUNDEX
    /AWS1/CX_GSTCLIENTEXC
    /AWS1/CX_GSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

it_statuslist TYPE /AWS1/CL_GSTSTATUSLIST_W=>TT_STATUSLIST TT_STATUSLIST

Status of a contact reservation.

iv_starttime TYPE /AWS1/GSTTIMESTAMP /AWS1/GSTTIMESTAMP

Start time of a contact in UTC.

iv_endtime TYPE /AWS1/GSTTIMESTAMP /AWS1/GSTTIMESTAMP

End time of a contact in UTC.

Optional arguments:

iv_maxresults TYPE /AWS1/GSTPAGINATIONMAXRESULTS /AWS1/GSTPAGINATIONMAXRESULTS

Maximum number of contacts returned.

iv_nexttoken TYPE /AWS1/GSTPAGINATIONTOKEN /AWS1/GSTPAGINATIONTOKEN

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

iv_groundstation TYPE /AWS1/GSTGROUNDSTATIONNAME /AWS1/GSTGROUNDSTATIONNAME

Name of a ground station.

iv_satellitearn TYPE /AWS1/GSTSATELLITEARN /AWS1/GSTSATELLITEARN

ARN of a satellite.

iv_missionprofilearn TYPE /AWS1/GSTMISSIONPROFILEARN /AWS1/GSTMISSIONPROFILEARN

ARN of a mission profile.

io_ephemeris TYPE REF TO /AWS1/CL_GSTEPHEMERISFILTER /AWS1/CL_GSTEPHEMERISFILTER

Filter for selecting contacts that use a specific ephemeris".

RETURNING

oo_output TYPE REF TO /aws1/cl_gstlistcontactsrsp /AWS1/CL_GSTLISTCONTACTSRSP

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->listcontacts(
  io_ephemeris = new /aws1/cl_gstephemerisfilter( new /aws1/cl_gstazelephemerisfilt( |string| ) )
  it_statuslist = VALUE /aws1/cl_gststatuslist_w=>tt_statuslist(
    ( new /aws1/cl_gststatuslist_w( |string| ) )
  )
  iv_endtime = '20150101000000.0000000'
  iv_groundstation = |string|
  iv_maxresults = 123
  iv_missionprofilearn = |string|
  iv_nexttoken = |string|
  iv_satellitearn = |string|
  iv_starttime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_paginationtoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_contactlist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_contactid( ).
      lv_missionprofilearn = lo_row_1->get_missionprofilearn( ).
      lv_satellitearn = lo_row_1->get_satellitearn( ).
      lv_timestamp = lo_row_1->get_starttime( ).
      lv_timestamp = lo_row_1->get_endtime( ).
      lv_timestamp = lo_row_1->get_prepassstarttime( ).
      lv_timestamp = lo_row_1->get_postpassendtime( ).
      lv_string = lo_row_1->get_groundstation( ).
      lv_contactstatus = lo_row_1->get_contactstatus( ).
      lv_string = lo_row_1->get_errormessage( ).
      lo_elevation = lo_row_1->get_maximumelevation( ).
      IF lo_elevation IS NOT INITIAL.
        lv_double = lo_elevation->get_value( ).
        lv_angleunits = lo_elevation->get_unit( ).
      ENDIF.
      lv_string = lo_row_1->get_region( ).
      LOOP AT lo_row_1->get_tags( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_string = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_timestamp = lo_row_1->get_visibilitystarttime( ).
      lv_timestamp = lo_row_1->get_visibilityendtime( ).
      lo_ephemerisresponsedata = lo_row_1->get_ephemeris( ).
      IF lo_ephemerisresponsedata IS NOT INITIAL.
        lv_uuid = lo_ephemerisresponsedata->get_ephemerisid( ).
        lv_ephemeristype = lo_ephemerisresponsedata->get_ephemeristype( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.