gCast SOAP API Integration - User Method

    Follow

    Purpose of the User Method
    The User integration method handles updating and retrieving subscriber details. Use this method to keep your external system and gCast synchronised with each other, to add demographic attributes to subscriber records, and to for clients using our Promo Suite feature to add points to subscriber records. API requests must be done so using a valid gCast username and password combination with ‘Administrator’ permission.

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

    AddPoints

    AddPointsBatch

    AddPointsBatchResult

    GetUser

    GetUserBatch

    GetUserBatchResult

    UpdateUser

    UpdateUserBatch

    UpdateUserBatchResult

    AddPoints
    Purpose
    This operation is useful for clients with access to Promo Suite. Use this operation to manage points for a single subscriber or for a group of subscribers. If you have a significant number of subscribers to manage, and/or if your data sync is not time-sensitive you may prefer to use the AddPointsBatch operation.
    API Requests
    API requests can be passed to gCast containing one or a list of subscriber references, a number of points and notes that will be stored against the points. Points may be positive or negative.
    API Returns
    The API will return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    AddPointsBatch
    Purpose
    This operation is used for the same purpose as the AddPoints operation. The difference is that this is a batch process and is useful where you don’t need the results immediately.
    API Requests
    API requests can be passed to gCast containing one or a list of subscriber references, a number of points and notes that will be stored against the points. Points may be positive or negative.
    API Returns
    The API will return a unique ID (32-character GUID) that you can use to retrieve the batch submission at a later point in time (using the AddPointsBatchResult operation).

    AddPointsBatchResult
    Purpose
    This operation is used for the purpose of retrieving the results of the AddPointsBatch operation. You would start calling this operation no sooner than 5 minutes after calling the AddPointsBatch operation, and probably call it every few minutes thereafter until you receive a status indicating completion or failure.
    API Requests
    API requests can be passed to gCast containing one or a list of unique IDs (per the AddPointsBatch operation).
    API Returns
    The API will return a batch status of ‘Not Found’, ‘Queued’, or ‘Processing’ up until the batch itself is no longer considered to be ‘in progress’, at which point a batch status of ‘Complete’ will be returned along with a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    GetUser
    Purpose
    This operation is useful for clients that want to retrieve subscriber details from their gCast database. Use this operation to get updated subscriber information such as opt outs.
    API Requests
    API requests can be passed to gCast requesting all users, or pull back data based on user ID, external ID, user name, change date, or change date since import. In addition to a set of default data, API requests can also specify to include address, demographic, and/or role data.
    API Returns
    The API will return a list of subscribers that match the request’s search parameters.

    GetUserBatch
    Purpose
    This operation is used for the same purpose as the GetUser operation. The difference is that this is a batch process and is useful where you don’t need the results immediately.
    API Requests
    API requests can be passed to gCast requesting all users, or pull back data based on user ID, external ID, user name, change date, or change date since import. In addition to a set of default data, API requests can also specify to include address, demographic, and/or role data.
    API Returns
    The API will return a unique ID (32-character GUID) that you can use to retrieve the batch submission at a later point in time (using the GetUserBatchResult operation).

    GetUserBatchResult
    Purpose
    This operation is used for the purpose of retrieving the results of the GetUserBatch operation. You would start calling this operation no sooner than 5 minutes after calling the GetUserBatch operation, and probably call it every few minutes thereafter until you receive a status indicating completion or failure.
    API Requests
    API requests can be passed to gCast containing one or a list of unique IDs (as returned via the GetUserBatch operation).
    API Returns
    The API will return a batch status of ‘Not Found’, ‘Queued’, or ‘Processing’ up until the batch itself is no longer considered to be ‘in progress’, at which point a batch status of ‘Complete’ will be returned along with a series of messages in XML code, including a list of subscribers that match the request’s search parameters. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    UpdateUser
    Purpose
    This operation is useful for clients that administer their subscriber data externally but want to add or update those details into their gCast database.
    API Requests
    API requests can be passed to gCast containing one or a list of subscribers. External ID must be used with fields set as ‘null’ or that are not passed to gCast at all will remain unaffected in gCast.
    API Returns
    The API will return a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

    UpdateUserBatch
    Purpose
    This operation is used for the same purpose as the UpdateUser operation. The difference is that this is a batch process and is useful where you don’t need the results immediately.
    API Requests
    API requests can be passed to gCast requesting all users, or pull back data based on user ID, external ID, user name, change date, or change date since import. In addition to a set of default data, API requests can also specify to include address, demographic, and/or role data.
    API Returns
    The API will return a unique ID (32-character GUID) that you can use to retrieve the batch submission at a later point in time (using the UpdateUserBatchResult operation).

    UpdateUserBatchResult
    Purpose
    This operation is used for the purpose of retrieving the results of the UpdateUserBatch operation. You would start calling this operation no sooner than 5 minutes after calling the UpdateUserBatch operation, and probably call it every few minutes thereafter until you receive a status indicating completion or failure.
    API Requests
    API requests can be passed to gCast containing one or a list of unique IDs (as returned via the UpdateUserBatch operation).
    API Returns
    The API will return a batch status of ‘Not Found’, ‘Queued’, or ‘Processing’ up until the batch itself is no longer considered to be ‘in progress’, at which point a batch status of ‘Complete’ will be returned along with a series of messages in XML code. Each message will contain the message severity, message code, message text, record number, and reference ID:

    • Message severity - ‘Information’, ‘Warning’, or ‘Error’
    • Message code – a list of message codes can be retrieved using the Lookup method
    • Message text – a brief description of the nature of the message
    • Record number – this will correspond to the line number of the record that was passed in via the request
    • Reference ID – this will correspond to a unique identifier relevant to the record that was passed in via the request (e.g. demographic attribute reference, external ID)

     

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

    Comments