AdministrationClient Methods

Submit a Adjustment Transaction. An Adjustment Transaction can be used to correct the Points Balance for a Customer Service function.

The updated Card Ponts Balance is returned.

Approve the Transaction Item from the submitted Transaction Item RSN

Cancel the processing of a queued batch of Members, from the submitted Batch RSN. A batch cannot be cancelled after it has been processed.

This method is a step in the workflow for Member File Batch submission.

Cancel the processing of a queued batch of Transactions, from the submitted Batch RSN. A batch cannot be cancelled after it has been processed.

This method is a step in the workflow for Transaction File Batch submission.

Create a new District, from the submitted values.

A District is linked to a Region. The Region RSN can be fetched from the Web Service Method: SelectRegion.

Creates a new Voucher that is a copy of the Voucher related to the submitted Voucher RSN value.

Create a new Program, from the submitted values.

Create a new Region, from the submitted values.

A Region can be related to many Districts The Region RSN can be fetched from the Web Service Method: SelectRegion.

Create a new Security Account, from the submitted values.

Create a new Voucher, from the submitted values.

Decline the Transaction Item from the submitted Transaction Item RSN

Delete the District from the submitted District RSN.

The District RSN can be fetched from the Web Service Method: SelectDistrict.

Delete the Region from the submitted Region RSN.

The Region RSN can be fetched from the Web Service Method: SelectRegion.

Modifies the the Expiry Date for the Voucher identified from the submitted Voucher RSN value.

Create a new Marketing Segment and link to an Entity Type and Entity RSN, from the submitted values.

Submitting a single file or multiple files containing Members.

If more than 1 file is being submitted, the set the value for BatchOStagingMember.Final = 1

Optimum number of Member rows per file is 20.

This method is a step in the workflow for Member File Batch submission.

Submitting a single file or multiple files containing Transactions.

If more than 1 file is being submitted, the set the value for BatchOStagingTransaction.Final = 1

Optimum number of Transaction rows per file is 20.

This method is a step in the workflow for Transaction File Batch submission.

Initialise the Batch for Generating a Batch of new Cards. The service returns the Batch Details, containing a key for calling the Service: QueryCardBatch.

Cards can be generated with a specified value loaded.

Initialise the Batch for submitting file(s) containing Members. The service returns the Batch Details, containing a key for calling the subsequent workflow Member Batch methods.

This method is a step in the workflow for Member File Batch submission.

Initialise the Batch for submitting file(s) containing Transaction. The service returns the Batch Details, containing a key for calling the subsequent workflow Transaction Batch methods.

This method is a step in the workflow for Transaction File Batch submission.

Submit a Points Transfer Transaction, for a nominated Points amount. The From Card Number and To Card Number are specified in the request.

The updated Card Ponts Balance is returned.

Returns the Batch Details metadata that enables monitoring the submitted Card Batch Progress.

Returns the Batch Details metadata that enables monitoring the submitted Member Batch Progress.

This method is an optional step in the workflow for Member File Batch submission.

Returns the Batch Details metadata that enables monitoring the submitted Transaction Batch Progress.

This method is an optional step in the workflow for Transaction File Batch submission.

Analyse the final results of the completed processing for a batch of Members, from the submitted Batch RSN.

This method is a step in the workflow for Member File Batch submission.

Analyse the final results of the completed processing for a batch of Transaction, from the submitted Batch RSN.

This method is a step in the workflow for Member File Batch submission.

Reverse the matching Transaction to the submitted Transaction Item RSN. The Reversal Transaction is a contra of the original Transaction.

Returns the Value of the supplied Field for the Customer Account linked to the supplied Card and Customer Account ID.

Will return the supplied Default Value if the Field is empty.

Return the District Details from the submitted District RSN.

The District RSN can be fetched from the Web Service Method: SelectDistrict.

Returns the Value of the supplied Field for the Member linked to the supplied Card and Member Type.

Will return the supplied Default Value if the Field is empty.

Return a collection of Members, filtered from the submitted values.

Pagination parameters are available to format the response.

Return a collection of Partner Outlets, filtered from the submitted values.

Pagination parameters are available to format the response.

Return a collection of Partners, filtered from the submitted values.

Pagination parameters are available to format the response.

Returns a Paged Collection of all the Transactions Pending Approval.

Paging parameters can be defined in the request.

Select the Program details from the submitted Program RSN.

The Program RSN can be fetched from the Web Service Method: SelectProgramList

Return a collection of Programs, filtered from the submitted values.

Pagination parameters are available to format the response.

Returns the Value of the supplied Field for the Program Membership linked to the supplied Card Number.

Will return the supplied Default Value if the Field is empty.

Return a collection of the last 15 Transactions, ordered by Transaction Date DESC

Return the Region Details from the submitted Region RSN.

The Region RSN can be fetched from the Web Service Method: SelectRegion.

Select the Settings details, from the submitted Settings RSN.

The Settings RSN can be fetched from the Web Service Method: SelectSettingsList

Settings are a row of Fields and Values that provide enterprise values for the Loyalty Implementation.

Return a collection of all the Settings.

Settings are a row of Fields and Values that provide enterprise values for the Loyalty Implementation.

Pagination parameters are available to format the response.

Returns the User Name from the Security Account linked to the submitted Member RSN.

The Member RSN can be fetched from the Web Service Method: SelectMembers

Set the End Date for the Program Membership linked to the submitted Member RSN.

This will also by extension set an End Date to any Card belonging to the Program Membership.

The Member RSN can be fetched from the Web Service Method: SelectMembers

Update the Card Status, from the submitted Card Number.

Only the Card Status Property will be updated, regardless of the Card Properties that can be submitted.

Update the District Detail from the submitted Values.

The District RSN can be fetched from the Web Service Method: SelectDistrict.

Update the Program from the submitted Values.

The Program RSN can be fetched from the Web Service Method: SelectProgram

Update the Region Detail from the submitted Values.

The Region RSN can be fetched from the Web Service Method: SelectRegion.

Update the Settings linked to the submitted Values.

The Settings RSN can be fetched from the Web Service Method: SelectSettings