JPurse API Documentation

Version v2.2

Summary
JPurse API Documentation
API Reference
API Libraries
Authentication
Errors
URLs
AboutProvides functionality for getting deployment information.
/about/aboutReturns information about the backend such as version.
AuthenticationResource
/authentication/authenticate
/authentication/authenticateDevice
/authentication/listAuthorities
BalanceProvides functionality for viewing balance related information of a user.
/balance/balanceShow the current balance of a user
/balance/balanceHistoryShows the transactions of the balance history for a user, device or program
/balance/listUsersByTransactionTime
CardProvides functionality for managing cards.
/card/isCardValid
/card/lockCardLock a Card based on its card identifier.
/card/getCardIdentifierByUid
/card/unlockCardUnlock a Card based on its card identifier.
/card/getCardType
/card/cardInfo
/card/createCards
MerchantResource
/merchant/createMerchant
/merchant/listMerchant
/merchant/updateMerchant
/merchant/listProgramByMerchant
/merchant/listUserByMerchant
/merchant/joinProgram
/merchant/disjoinProgram
/merchant/addUser
/merchant/removeUser
Coupon
/coupon/createCoupon
/coupon/updateCoupon
/coupon/addCoupon
/coupon/claimCoupon
/coupon/deleteCoupon
/coupon/distributeCoupon
/coupon/assignCoupon
/coupon/assignCouponToGroup
/coupon/listCoupon
/coupon/listCouponAssignment
/coupon/requestCouponAssignment
CustomerProvides functionality for the registration of customers.
/customer/createCustomerCreate a customer.
/customer/registerCustomerRegister a customer.
/customer/registerRaffleCustomerRegister a raffle user as a new customer.
/customer/resetPasswordReset the password of a user’s identifier.
/customer/changePasswordChange the password of a user’s identifier.
DeviceThemeProvides functionality for DeviceTheme related actions.
/deviceTheme/getDeviceThemeRetrieve the theme for a device
GiftProvides functionality for gift related actions.
/gift/lockLock a gift.
/gift/claimGiftClaim a gift.
/gift/claimGiftsClaim a list gift.
/gift/issueGiftIssue a gift.
/gift/issueGiftsIssue a list of gifts.
/gift/balanceBalance of a gift.
/gift/reversalReversal of a gift action.
/gift/createGiftCreation of a gift
/gift/giftUpdatePincodeUpdate gift pincode
/gift/giftLinkUserLink a gift to a user
/gift/createGifts
/gift/giftInfoRetrieve information on a gift
LoyaltyResource
/loyalty/loyaltyRewardRedeem
/loyalty/startLoyalty
Product
/product/createProduct
/product/listActiveProducts
/product/updateProduct
/product/deleteProduct
/product/listProductImages
/product/addProductsToPrograms
/product/removeProductsFromPrograms
/product/listProductsByProgram
RaffleProvides functionality for raffle related actions.
/raffle/retrieveRaffleQuestionsRaffle Question Retrieval
/raffle/listRafflesCall to lists all raffles the user is assigned for
/raffle/validateRaffleTicketRaffle Ticket Validation
/raffle/validateRafflePriceRaffle Price Validation
/raffle/claimRafflePriceRaffle Price Claiming
RedeemProvides functionality for Redeeming.
/redeem/redeemRedeem.
/redeem/createFixedProductQuantityRedeem
/redeem/createVariableProductQuantityRedeem
/redeem/deleteRedeem
/redeem/listRulesList the redeem rules.
/redeem/rulesForMerchantList the redeem rules of a merchant.
ReverseResource
/reverse/reversal
RewardProvides functionality for Rewarding.
/reward/rewardReward.
/reward/createFixedProductQuantityReward
/reward/updateFixedProductQuantityReward
/reward/createPERCENTUALProductQuantityReward
/reward/updatePERCENTUALProductQuantityReward
/reward/createFixedCouponReward
/reward/updateFixedCouponReward
/reward/createFixedCashReward
/reward/updateFixedCashReward
/reward/deleteReward
/reward/rulesForMerchantList the reward rules of a merchant.
/reward/listRewardRules
Serial
/serial/generateSerial
SlideProvides functionality for managing slides.
/slide/listCurrentSlides
stackProvides functionality for creating and listing stacks.
/stack/relocateStack
StatisticsResource
/statistics/statistics
TopDown
/topdown/topDownTop down.
/topdown/topDownProductTop down product.
TopUp
/topup/topUpByCash
/topup/topUpByUser
UserProvides functionality for managing users.
/user/registerSerial
/user/authenticateUserAuthenticate a user.
/user/lockUserLock a user.
/user/cleanUserClean a user.
/user/createUser
/user/updateUser
/user/updateUserWithSerial
/user/findUserFind a user.
/user/findUsersFind users.
/user/listAndroidUsers
/user/addCardToUserAdd a card to a user.
/user/removeCardFromUserRemoves a card from a user.
/user/removeIdentifierLinkRemoves the link between the User and the UserIdentifier for the given identifier
/user/listUsersByBalance
/user/moveUserMoves all details from one user to another
/user/subscribeUserSubscribes the user by it’s userIdentifier identifier
/user/unsubscribeUserUnsubscribes the user by it’s userIdentifier identifier
Program
/program/createProgram
/program/deleteProgram
/program/updateProgram
/program/listActivePrograms
/program/listGiftPrograms
VideoProvides functionality for managing videos.
/video/listCurrentVideos

API Reference

The API is organized around HTTP and Protocol Buffers.

HTTP

Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors.  We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.

Protocol Buffers

Requests and responses are serialized using Protocol Buffers, including errors -- think XML, but smaller, faster, and simpler.

API Libraries

There are lots of pre-built libraries for interacting with JPurse.

Java

  • Classes and Sources: java/sva.sdk.java-*.jar
  • Runtime: java/protostuf-*jar

Objective-C

  • Classes and Sources: objc/protobuffer/protomessages and objc/protobuffer/protostubs
  • Runtime: objc/protobuffer/runtime

PHP

  • Classes and Sources: php/protobuffer/protomessages and php/protobuffer/protostubs
  • Runtime: php/protobuffer/runtime
  • Examples: php/examples

Python

  • Classes and Sources: python/protobuffer/protomessages and python/protobuffer/protostubs
  • Runtime: python/binaries

Authentication

  • Authentication to the API occurs via HTTP Basic Auth.
  • All API requests must be made over HTTPS.
  • Calls made over plain HTTP will fail.
  • Authorisation is required for all requests.

Basic Authentication Header Format

  • Username, password (and optionally device-ID) are concatenated with a colon.
  • The resulting string is then Base64 encoded.
  • The authorization method and a space i.e.  “Basic “ is then put before the encoded string.

Errors

JPurse uses conventional HTTP response codes to indicate success or failure of a request.

HTTP Status Code Summary

200 OKEverything worked as expected.
400 Bad RequestOften missing a required parameter, or parameters were valid but request failed.  For all bad requests, we return a FaultResponse.
401 UnauthorizedNo valid authentication credentials provided.
404 Not FoundThe requested item doesn’t exist.
500, 502, 503, 504 Server errorsSomething went wrong on JPurse’s end.

URLs

About

Provides functionality for getting deployment information.

/about/about

Returns information about the backend such as version.

Request method

HTTP GET

Security rights

ABOUT

See Also

Request entity: none

Response entity: AboutResponse

AuthenticationResource

/authentication/authenticate

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: none

Response entity: none

/authentication/authenticateDevice

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: AuthenticateDeviceRequest

Response entity: <AuthenticateDeviceResponse>

/authentication/listAuthorities

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: none

Response entity: <ListRightsResponse>

Balance

Provides functionality for viewing balance related information of a user.

/balance/balance

Show the current balance of a user.  The quantity of each product and the amount of cash registered to a user is returned as response.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceRequest

Response entity: BalanceResponse

/balance/balanceHistory

Shows the transactions of the balance history for a user, device or program.  Every transaction shows how the balance was updated.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceHistoryRequest

Response entity: BalanceHistoryResponse

/balance/listUsersByTransactionTime

Request method

HTTP POST

Security rights

LIST_USERS_BY_TRANSACTION_TIME

See Also

Request entity: <ListUsersByTransactionTimeRequest>

Response entity: <ListUsersByTransactionTimeResponse>

Card

Provides functionality for managing cards.

/card/isCardValid

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: <IsCardValidRequest>

Response entity: <IsCardValidResponse>

/card/lockCard

Lock a Card based on its card identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: LockCardRequest

Response entity: none

/card/getCardIdentifierByUid

Request method

HTTP POST

Security rights

GET_CARDIDENTIFIER_BY_UID

See Also

Request entity: <GetCardIdentifierRequest>

Response entity: <GetCardIdentifierResponse>

/card/unlockCard

Unlock a Card based on its card identifier.

Request method

HTTP POST

Security rights

CONFIGURE_CARD

See Also

Request entity: UnLockCardRequest

Response entity: none

/card/getCardType

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: <GetCardTypeRequest>

Response entity: <GetCardTypeResponse>

/card/cardInfo

Request method

HTTP POST

Security rights

CHECK_CARD

See Also

Request entity: <CardInfoRequest>

Response entity: CardInfoResponse

/card/createCards

Request method

HTTP POST

Security rights

GENERATE_CARDS

See Also

Request entity: GenerateCardsBatchRequest

Response entity: GenerateCardsBatchResponse

MerchantResource

/merchant/createMerchant

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT

See Also

Request entity: <CreateMerchantRequest>

Response entity: <MerchantVO>

/merchant/listMerchant

Request method

HTTP POST

Security rights

LIST_MERCHANTS

See Also

Request entity: <ListMerchantRequest>

Response entity: <ListMerchantResponse>

/merchant/updateMerchant

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT

See Also

Request entity: <UpdateMerchantRequest>

Response entity: <MerchantVO>

/merchant/listProgramByMerchant

Request method

HTTP POST

Security rights

LIST_PROGRAMS_BY_MERCHANT

See Also

Request entity: <ListProgramByMerchantRequest>

Response entity: <ListProgramResponse>

/merchant/listUserByMerchant

Request method

HTTP POST

Security rights

LIST_USERS_BY_MERCHANT

See Also

Request entity: <ListUserByMerchantRequest>

Response entity: <ListUserResponse>

/merchant/joinProgram

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT_PROGRAM

See Also

Request entity: <JoinProgramRequest>

Response entity: none

/merchant/disjoinProgram

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT_PROGRAM

See Also

Request entity: <DisjoinProgramRequest>

Response entity: none

/merchant/addUser

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT_USER

See Also

Request entity: AddUserRequest

Response entity: none

/merchant/removeUser

Request method

HTTP POST

Security rights

CONFIGURE_MERCHANT_USER

See Also

Request entity: <RemoveUserRequest>

Response entity: none

Coupon

The Class CouponResource.

/coupon/createCoupon

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: <CreateCouponRequest>

Response entity: <CreateCouponResponse>

/coupon/updateCoupon

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: <UpdateCouponRequest>

Response entity: none

/coupon/addCoupon

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: AddCouponRequest

Response entity: <AssignCouponResponse>

/coupon/claimCoupon

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: <ClaimCouponRequest>

Response entity: <ClaimCouponResponse>

/coupon/deleteCoupon

Request method

HTTP POST

Security rights

CONFIGURE_COUPON

See Also

Request entity: <DeleteCouponRequest>

Response entity: none

/coupon/distributeCoupon

Request method

HTTP POST

Security rights

DISTRIBUTE_COUPON

See Also

Request entity: <DistributeCouponRequest>

Response entity: none

/coupon/assignCoupon

Request method

HTTP POST

Security rights

ASSIGN_COUPON

See Also

Request entity: AssignCouponRequest

Response entity: <AssignCouponResponse>

/coupon/assignCouponToGroup

Request method

HTTP POST

Security rights

ASSIGN_COUPON

See Also

Request entity: <AssignCouponToGroupRequest>

Response entity: <AssignCouponToGroupResponse>

/coupon/listCoupon

Request method

HTTP POST

Security rights

LIST_COUPONS

See Also

Request entity: ListCouponRequest

Response entity: ListCouponResponse

/coupon/listCouponAssignment

Request method

HTTP POST

Security rights

LIST_COUPON_ASSIGNMENTS

See Also

Request entity: <ListCouponAssignmentRequest>

Response entity: <ListCouponAssignmentResponse>

/coupon/requestCouponAssignment

Request method

HTTP POST

Security rights

LIST_COUPON_ASSIGNMENTS

See Also

Request entity: RequestCouponAssignmentRequest

Response entity: <RequestCouponAssignmentResponse>

Customer

Provides functionality for the registration of customers.

/customer/createCustomer

Create a customer.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: CreateCustomerRequest

Response entity: none

/customer/registerCustomer

Register a customer.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: RegisterCustomerRequest

Response entity: RegisterCustomerResponse

/customer/registerRaffleCustomer

Register a raffle user as a new customer.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: RegisterCustomerRequest

Response entity: RegisterCustomerResponse

/customer/resetPassword

Reset the password of a user’s identifier.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: ResetPasswordRequest

Response entity: none

/customer/changePassword

Change the password of a user’s identifier.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: ChangePasswordRequest

Response entity: none

DeviceTheme

Provides functionality for DeviceTheme related actions.

/deviceTheme/getDeviceTheme

Retrieve the theme for a device

Request method

HTTP GET

Security rights

permitAll

See Also

Request entity: none

Response entity: <GetDeviceThemeResponse>

Gift

Provides functionality for gift related actions.

/gift/lock

Lock a gift.

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: LockGiftRequest

Response entity: none

/gift/claimGift

Claim a gift.

Request method

HTTP POST

Security rights

CLAIM_GIFT

See Also

Request entity: ClaimGiftRequest

Response entity: ClaimGiftResponse

/gift/claimGifts

Claim a list gift.

Request method

HTTP POST

Security rights

CLAIM_GIFT

See Also

Request entity: ClaimGiftsRequest

Response entity: none

/gift/issueGift

Issue a gift.

Request method

HTTP POST

Security rights

ISSUE_GIFT

See Also

Request entity: IssueGiftRequest

Response entity: IssueGiftResponse

/gift/issueGifts

Issue a list of gifts.

Request method

HTTP POST

Security rights

ISSUE_GIFT

See Also

Request entity: IssueGiftsRequest

Response entity: none

/gift/balance

Balance of a gift.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: BalanceGiftRequest

Response entity: BalanceGiftResponse

/gift/reversal

Reversal of a gift action.

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: ReversalRequest

Response entity: none

/gift/createGift

Creation of a gift

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: CreateGiftRequest

Response entity: CreateGiftResponse

/gift/giftUpdatePincode

Update gift pincode

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: UpdateGiftPincodeRequest

Response entity: none

/gift/giftLinkUser

Link a gift to a user

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: LinkGiftToUserRequest

Response entity: none

/gift/createGifts

Request method

HTTP POST

Security rights

CONFIGURE_GIFT

See Also

Request entity: <CreateGiftsRequest>

Response entity: CreateGiftsResponse

/gift/giftInfo

Retrieve information on a gift

Request method

HTTP POST

Security rights

BALANCE

See Also

Request entity: GiftInfoRequest

Response entity: GiftInfoResponse

LoyaltyResource

/loyalty/loyaltyRewardRedeem

Request method

HTTP POST

Security rights

REWARD

See Also

Request entity: RewardListRedeemRulesRequest

Response entity: RewardListRedeemRulesResponse

/loyalty/startLoyalty

Request method

HTTP POST

Security rights

LOYALTY_START

See Also

Request entity: StartLoyaltyRequest

Response entity: StartLoyaltyResponse

Product

The Class ProductResource.

/product/createProduct

Request method

HTTP POST

Security rights

CONFIGURE_PRODUCT

See Also

Request entity: <CreateProductRequest>

Response entity: <CreateProductResponse>

/product/listActiveProducts

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: none

Response entity: <ListProductsResponse>

/product/updateProduct

Request method

HTTP POST

Security rights

CONFIGURE_PRODUCT

See Also

Request entity: <UpdateProductRequest>

Response entity: none

/product/deleteProduct

Request method

HTTP POST

Security rights

CONFIGURE_PRODUCT

See Also

Request entity: <DeleteProductRequest>

Response entity: none

/product/listProductImages

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: <ListProductImagesRequest>

Response entity: <ListProductImagesResponse>

/product/addProductsToPrograms

Request method

HTTP POST

Security rights

CONFIGURE_PRODUCT

See Also

Request entity: AddProductsToProgramsRequest

Response entity: none

/product/removeProductsFromPrograms

Request method

HTTP POST

Security rights

CONFIGURE_PRODUCT

See Also

Request entity: <RemoveProductsFromProgramsRequest>

Response entity: none

/product/listProductsByProgram

Request method

HTTP POST

Security rights

LIST_PRODUCTS

See Also

Request entity: <ListProductsByProgramRequest>

Response entity: <ListProductsResponse>

Raffle

Provides functionality for raffle related actions.

/raffle/retrieveRaffleQuestions

Raffle Question Retrieval

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: RaffleQuestionRetrievalRequest

Response entity: RaffleQuestionRetrievalResponse

/raffle/listRaffles

Call to lists all raffles the user is assigned for

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: none

Response entity: <ListRafflesResponse>

/raffle/validateRaffleTicket

Raffle Ticket Validation

Request method

HTTP POST

Security rights

RAFFLE_VALIDATION

See Also

Request entity: RaffleTicketValidationRequest

Response entity: RaffleTicketValidationResponse

/raffle/validateRafflePrice

Raffle Price Validation

Request method

HTTP POST

Security rights

RAFFLE_PRICE

See Also

Request entity: RafflePriceValidationRequest

Response entity: RafflePriceValidationResponse

/raffle/claimRafflePrice

Raffle Price Claiming

Request method

HTTP POST

Security rights

RAFFLE_PRICE

See Also

Request entity: RaffleTicketValidationClaimRequest

Response entity: none

Redeem

Provides functionality for Redeeming.

/redeem/redeem

Redeem.

Request method

HTTP POST

Security rights

REDEEM

See Also

Request entity: RedeemRequest

Response entity: RedeemResponse

/redeem/createFixedProductQuantityRedeem

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateFixedProductRedeemRuleRequest>

Response entity: <CreateProductRedeemRuleResponse>

/redeem/createVariableProductQuantityRedeem

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateVariableProductRedeemRuleRequest>

Response entity: <CreateProductRedeemRuleResponse>

/redeem/deleteRedeem

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <DeleteRedeemRuleRequest>

Response entity: none

/redeem/listRules

List the redeem rules.

Request method

HTTP POST

Security rights

LIST_RULES

See Also

Request entity: ListRedeemRuleRequest

Response entity: ListRedeemRuleResponse

/redeem/rulesForMerchant

List the redeem rules of a merchant.

Request method

HTTP POST

Security rights

LIST_RULES_FOR_MERCHANT

See Also

Request entity: ListRuleForMerchantRequest

Response entity: ListRedeemRuleResponse

ReverseResource

/reverse/reversal

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: ReversalRequest

Response entity: none

Reward

Provides functionality for Rewarding.

/reward/reward

Reward.

Request method

HTTP POST

Security rights

REWARD

See Also

Request entity: RewardRequest

Response entity: RewardResponse

/reward/createFixedProductQuantityReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateFixedProductRewardRuleRequest>

Response entity: <CreateProductRewardRuleResponse>

/reward/updateFixedProductQuantityReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <UpdateFixedProductRewardRuleRequest>

Response entity: none

/reward/createPERCENTUALProductQuantityReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateProcentualProductRewardRuleRequest>

Response entity: <CreateProductRewardRuleResponse>

/reward/updatePERCENTUALProductQuantityReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <UpdateProcentualProductRewardRuleRequest>

Response entity: none

/reward/createFixedCouponReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateFixedCouponRewardRuleRequest>

Response entity: <CreateCouponRewardRuleResponse>

/reward/updateFixedCouponReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <UpdateFixedCouponRewardRuleRequest>

Response entity: none

/reward/createFixedCashReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <CreateFixedCashRewardRuleRequest>

Response entity: <CreateCashRewardRuleResponse>

/reward/updateFixedCashReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <UpdateFixedCashRewardRuleRequest>

Response entity: none

/reward/deleteReward

Request method

HTTP POST

Security rights

CONFIGURE_RULE

See Also

Request entity: <DeleteRewardRuleRequest>

Response entity: none

/reward/rulesForMerchant

List the reward rules of a merchant.

Request method

HTTP POST

Security rights

LIST_RULES_FOR_MERCHANT

See Also

Request entity: ListRuleForMerchantRequest

Response entity: ListRewardRuleResponse

/reward/listRewardRules

Request method

HTTP POST

Security rights

LIST_RULES

See Also

Request entity: ListRuleForCardRequest

Response entity: ListRewardRuleResponse

Serial

The Class SerialResource.

/serial/generateSerial

Request method

HTTP POST

Security rights

GENERATE_SERIAL

See Also

Request entity: none

Response entity: <GenerateSerialResponse>

Slide

Provides functionality for managing slides.

/slide/listCurrentSlides

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: ListSlideRequest

Response entity: <ListSlideResponse>

stack

Provides functionality for creating and listing stacks.

/stack/relocateStack

Request method

HTTP POST

Security rights

CONFIGURE_STACK

See Also

Request entity: <RelocateStackRequest>

Response entity: none

StatisticsResource

Provides functionality for retrieving statistics

/statistics/statistics

Request method

HTTP POST

Security rights

LIST_TRANSACTIONS

See Also

Request entity: StatisticRequest

Response entity: StatisticResponse

TopDown

Provides functionality for TopDowning

/topdown/topDown

Top down.

Request method

HTTP POST

Security rights

TOPDOWN

See Also

Request entity: TopDownRequest

Response entity: TopDownResponse

/topdown/topDownProduct

Top down product.

Request method

HTTP POST

Security rights

TOPDOWN

See Also

Request entity: TopDownRequest

Response entity: TopDownProductResponse

TopUp

The Class TopUpResource.

/topup/topUpByCash

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: TopUpByCashRequest

Response entity: TopUpResponse

/topup/topUpByUser

Request method

HTTP POST

Security rights

TOPUP

See Also

Request entity: TopUpByUserRequest

Response entity: none

User

Provides functionality for managing users.

/user/registerSerial

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <RegisterSerialRequest>

Response entity: none

/user/authenticateUser

Authenticate a user.

Request method

HTTP POST

Security rights

AUTHENTICATE_USER

See Also

Request entity: AuthenticateUserRequest

Response entity: AuthenticateUserResponse

/user/lockUser

Lock a user.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: LockUserRequest

Response entity: none

/user/cleanUser

Clean a user.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: CleanUserRequest

Response entity: none

/user/createUser

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <CreateUserRequest>

Response entity: <CreateUserResponse>

/user/updateUser

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: <UpdateUserRequest>

Response entity: <UpdateUserResponse>

/user/updateUserWithSerial

Request method

HTTP POST

Security rights

UPDATE_USER_WITH_SERIAL

See Also

Request entity: <UpdateUserWithSerialRequest>

Response entity: <UpdateUserWithSerialResponse>

/user/findUser

Find a user.

Request method

HTTP POST

Security rights

LIST_USERS

See Also

Request entity: FindUserRequest

Response entity: FindUserResponse

/user/findUsers

Find users.

Request method

HTTP POST

Security rights

LIST_USERS

See Also

Request entity: FindUsersRequest

Response entity: FindUsersResponse

/user/listAndroidUsers

Request method

HTTP POST

Security rights

LIST_USERS

See Also

Request entity: <ListUserRequest>

Response entity: <ListUserResponse>

/user/addCardToUser

Add a card to a user.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: AddCardToUserRequest

Response entity: none

/user/removeCardFromUser

Removes a card from a user.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: RemoveCardFromUserRequest

Response entity: none

/user/removeIdentifierLink

Removes the link between the User and the UserIdentifier for the given identifier.  <br/> The identifier can be an email address or a card.  Optionally the card can be locked.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: RemoveIdentifierFromUserRequest

Response entity: none

/user/listUsersByBalance

Request method

HTTP POST

Security rights

LIST_USERS_BY_BALANCE

See Also

Request entity: <ListUsersByBalanceRequest>

Response entity: <ListUsersByBalanceResponse>

/user/moveUser

Moves all details from one user to another.  <br/> Details that are moved are: - transactions - couponassignments - gifts - balances.  <br/> Boolean MoveUserAndIdentifierData indicates to move all user data and email user identifiers.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: MoveUserRequest

Response entity: none

/user/subscribeUser

Subscribes the user by it’s userIdentifier identifier.  <br/> The identifier can be an email address or a card.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: SubscribeUserRequest

Response entity: none

/user/unsubscribeUser

Unsubscribes the user by it’s userIdentifier identifier.  <br/> The identifier can be an email address or a card.

Request method

HTTP POST

Security rights

CONFIGURE_USER

See Also

Request entity: UnsubscribeUserRequest

Response entity: none

Program

The Class ProgramResource.

/program/createProgram

Request method

HTTP POST

Security rights

CONFIGURE_PROGRAM

See Also

Request entity: <CreateProgramRequest>

Response entity: <CreateProgramResponse>

/program/deleteProgram

Request method

HTTP POST

Security rights

CONFIGURE_PROGRAM

See Also

Request entity: <DeleteProgramRequest>

Response entity: none

/program/updateProgram

Request method

HTTP POST

Security rights

CONFIGURE_PROGRAM

See Also

Request entity: <UpdateProgramRequest>

Response entity: none

/program/listActivePrograms

Request method

HTTP POST

Security rights

LIST_PROGRAMS

See Also

Request entity: none

Response entity: <ListProgramResponse>

/program/listGiftPrograms

Request method

HTTP POST

Security rights

LIST_PROGRAMS

See Also

Request entity: none

Response entity: <ListProgramResponse>

Video

Provides functionality for managing videos.

/video/listCurrentVideos

Request method

HTTP POST

Security rights

permitAll

See Also

Request entity: ListVideoRequest

Response entity: <ListVideoResponse>

Close