Enables scripted content fragments to use PointTransactions
Methods
Create
Create a Point Transaction
Usage
#set($pointTransactionResponse = $core_v2_pointTransaction.Create($description, $userId, $value, $contentId, $contentTypeId, "%{CreatedDate = $createdDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
description | string | Why the point transaction was created. | Required | ||
userId | int | Id of the user the transaction is for. | Required | ||
value | int | Number of points being awarded (negative number = points being removed). | Required | ||
contentId | Guid | Id of the content related to this point transaction. | Required | ||
contentTypeId | Guid | Type Id of the content related to this point transaction. | Required | ||
CreatedDate | DateTime | Specify when this point transaction should occur. | Optional |
Return Type
Delete
Delete a Point Transaction
Usage
#set($additionalInfoResponse = $core_v2_pointTransaction.Delete($pointTransactionId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
pointTransactionId | Int64 | Id of the point transaction. | Required |
Return Type
Get
Get a Point Transaction
Usage
#set($pointTransactionResponse = $core_v2_pointTransaction.Get($pointTransactionId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
pointTransactionId | Int64 | Id of the point transaction. | Required |
Return Type
List
List Point Transactions
Usage
#set($pagedListResponse = $core_v2_pointTransaction.List("%{ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeId = $contentTypeIdArg, EndDate = $endDateArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, StartDate = $startDateArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Filter point transactions by Application Id. Optional. | Optional | ||
ContainerId | Guid | Filter point transactions by Container Id. Optional. | Optional | ||
ContentId | Guid | Filter point transactions by Content Id. Optional. | Optional | ||
ContentTypeId | Guid | Filter point transactions by Content Type Id. Optional. | Optional | ||
EndDate | DateTime | Only show point transactions before this date. Optional. | Optional | ||
PageIndex | int | Which page of results to retrieve. Optional. | Optional | ||
PageSize | int | Number of results to display per page. Default is 10. Optional. | Optional | ||
SortBy | string | Sort transactions by a certain field. Default is Date. Optional. | Optional | Date, Value | |
SortOrder | string | Order transactions. Default is Descending.Optional. | Optional | Ascending, Descending | |
StartDate | DateTime | Only show point transactions after this date. Optional. | Optional | ||
UserId | int | Filter point transactions by User Id. Optional. | Optional |