gCast SOAP API Integration - Lookups Method

    Follow

    Purpose of the Lookups Method

    The Lookups integration method handles retrieving data on a variety of fields in gCast that use pre-defined lists. Clients may find this method useful as a point of reference for valid field content when passing data to gCast.

    The Lookup method operations currently available are (in alphabetical order):

    GetCountries

    GetMaritalStatus

    GetMessages

    GetPositionLevels

    GetProfileAttributes

    GetRoles

    GetStates

    GetUserTitles

    GetCountries
    Purpose
    This operation is useful for clients who want to retrieve a list of country codes and country name (in line with ISO-3166-1) ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all countries; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all country codes and country names available for use in gCast.

    GetMaritalStatus
    Purpose
    This operation is useful for clients who want to retrieve a list of marital statuses ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all marital statuses; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all marital statuses available for use in gCast.

    GetMessages
    Purpose
    This operation is useful for clients who want to retrieve a list of error codes that can be returned via the API following a request.
    API Requests
    API requests can be passed to gCast requesting data on all error messages; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all error messages available for use in gCast, including the error code (numeric), text (a short-form description), and a description (a more detailed description of the error).

    GetPositionLevels
    Purpose
    This operation is useful for clients who want to retrieve a list of position descriptions ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all position descriptions; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all position descriptions available for use in gCast.

    GetProfileAttributes
    Purpose
    This operation is useful for clients who want to retrieve a list of fields found in member records ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all profile attributes; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all profile attributes available for use in gCast.

    GetRoles
    Purpose
    This operation is useful for clients who want to retrieve a list of permission levels ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all permission levels; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all permission levels available for use in gCast (note, however, that restricted roles cannot be assigned when creating a user in gCast as these roles are assigned to gCast administrators.

    GetStates
    Purpose
    This operation is useful for clients who want to retrieve a list of Australian states ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all states; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all Australian states available for use in gCast.

    GetUserTitles
    Purpose
    This operation is useful for clients who want to retrieve a list of titles (e.g. Mr, Mrs, etc) ahead of passing this data through from their external system into gCast.
    API Requests
    API requests can be passed to gCast requesting data on all titles; they cannot have any additional parameters assigned to the request.
    API Returns
    The API will return a list of all titles available for use in gCast (note, however, that restricted roles cannot be assigned when creating a user in gCast as these roles are assigned to gCast administrators.

    Was this article helpful?
    0 out of 0 found this helpful

    Comments