Skip to content

Service Item Protocol

Yannik Marchand edited this page Apr 8, 2023 · 2 revisions

NEX Protocols > ServiceItemProtocol (119)

Method ID Method Name
1 GetEnvironment
2 HttpGetRequest
3 HttpGetResponse
4 PurchaseServiceItemRequest
5 PurchaseServiceItemResponse
6 ListServiceItemRequest
7 ListServiceItemResponse
8 GetBalanceRequest
9 GetBalanceResponse
10 GetPrepurchaseInfoRequest
11 GetPrepurchaseInfoResponse
12 GetServiceItemRightRequest
13 GetServiceItemRightResponse
14 GetPurchaseHistoryRequest
15 GetPurchaseHistoryResponse
16 PostRightBinaryByAccount
17 UseServiceItemByAccountRequest
18 UseServiceItemByAccountResponse
19 AcquireServiceItemByAccount
20 GetSupportId
21 GetLawMessageRequest
22 GetLawMessageResponse

(1) GetEnvironment

Request

Type Name
String uniqueId
Uint8 platform

Response

Type Name
String str

(2) HttpGetRequest

Request

Type Name
ServiceItemHttpGetParam url

Response

Type Name
Uint32 requestId

(3) HttpGetResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemHttpGetResponse response

(4) PurchaseServiceItemRequest

Request

Type Name
ServiceItemPurchaseServiceItemParam purchaseServiceItemParam

Response

Type Name
Uint32 requestId

(5) PurchaseServiceItemResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemPurchaseServiceItemResponse purchaseServiceItemResponse

(6) ListServiceItemRequest

Request

Type Name
ServiceItemListServiceItemParam listServiceItemParam

Response

Type Name
Uint32 requestId

(7) ListServiceItemResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemListServiceItemResponse listServiceItemResponse

(8) GetBalanceRequest

Request

Type Name
ServiceItemGetBalanceParam getBalanceParam

Response

Type Name
Uint32 requestId

(9) GetBalanceResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemGetBalanceResponse getBalanceResponse

(10) GetPrepurchaseInfoRequest

Request

Type Name
ServiceItemGetPrepurchaseInfoParam getPrepurchaseInfoParam

Response

Type Name
Uint32 requestId

(11) GetPrepurchaseInfoResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemGetPrepurchaseInfoResponse getPrepurchaseInfoResponse

(12) GetServiceItemRightRequest

Request

Type Name
ServiceItemGetServiceItemRightParam getServiceItemRightParam
Bool withoutRightBinary

Response

Type Name
Uint32 requestId

(13) GetServiceItemRightResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemGetServiceItemRightResponse getServiceItemRightResponse

(14) GetPurchaseHistoryRequest

Request

Type Name
ServiceItemGetPurchaseHistoryParam getPurchaseHistoryParam

Response

Type Name
Uint32 requestId

(15) GetPurchaseHistoryResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemGetPurchaseHistoryResponse getPurchaseHistoryResponse

(16) PostRightBinaryByAccount

Request

Type Name
ServiceItemPostRightBinaryByAccountParam postRightBinaryByAccountParam

Response

Type Name
ServiceItemPostRightBinaryResponse postRightBinaryResponse

(17) UseServiceItemByAccountRequest

Request

Type Name
ServiceItemUseServiceItemByAccountParam useServiceItemByAccountParam

Response

Type Name
Uint32 requestId

(18) UseServiceItemByAccountResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemUseServiceItemResponse useServiceItemResponse

(19) AcquireServiceItemByAccount

Request

Type Name
ServiceItemAcquireServiceItemByAccountParam acquireServiceItemByAccountParam

Response

Type Name
ServiceItemAcquireServiceItemResponse acquireServiceItemResponse

(20) GetSupportId

Request

Type Name
ServiceItemGetSupportIdParam getSuppordIdParam

Response

Type Name
String supportId

(21) GetLawMessageRequest

Request

Type Name
ServiceItemGetLawMessageParam getLawMessageParam

Response

Type Name
Uint32 requestId

(22) GetLawMessageResponse

Request

Type Name
Uint32 requestId

Response

Type Name
ServiceItemGetLawMessageResponse getLawMessageResponse

Types

ServiceItemHttpGetParam (Structure)

Type Name
String url

ServiceItemHttpGetResponse (Structure)

Type Name
qBuffer response

ServiceItemEShopResponse (Structure)

Type Name
Uint32 httpStatus
Uint32 errorCode
String correlationId

ServiceItemAmount (Structure)

Type Name
String formattedAmount
String currency
String rawValue

ServiceItemPurchaseServiceItemParam (Structure)

Type Name
String itemCode
String priceId
String referenceId
String balance
String itemName
String ecServiceToken
String language
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemPurchaseInfo (Structure)

Type Name
String transactionId
String extTransactionId
String itemCode
ServiceItemAmount postBalance

ServiceItemPurchaseServiceItemResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemPurchaseInfo> nullablePurchaseInfo

ServiceItemListServiceItemParam (Structure)

Type Name
String language
Uint32 offset
Uint32 size
Bool isBalanceAvailable
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemLimitation (Structure)

Type Name
Uint32 limitationType
Uint32 limitationValue

ServiceItemAttribute (Structure)

Type Name
String name
String value

ServiceItemListItem (Structure)

Type Name
String itemCode
ServiceItemAmount regularPrice
Bool taxExcluded
Bool initialPurchaseOnly
ServiceItemLimitation limitation
List<ServiceItemAttribute> attributes

ServiceItemCatalog (Structure)

Type Name
Uint32 totalSize
Uint32 offset
List<ServiceItemListItem> listItems
Bool isBalanceAvailable
ServiceItemAmount balance

ServiceItemListServiceItemResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemCatalog> nullableCatalog

ServiceItemGetBalanceParam (Structure)

Type Name
String language
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemGetBalanceResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemAmount> nullableBalance

ServiceItemGetPrepurchaseInfoParam (Structure)

Type Name
String itemCode
String referenceId
ServiceItemLimitation limitation
String language
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemPrepurchaseRightInfo (Structure)

Type Name
Uint32 limitationType
Uint32 acquiredCount
Uint32 usedCount
Uint32 expiryDate
Uint32 expiredCount
List<Uint32> expiryCounts

ServiceItemPrepurchaseInfo (Structure)

Type Name
String itemCode
String priceId
ServiceItemAmount regularPrice
Bool isTaxAvailable
ServiceItemAmount taxAmount
ServiceItemAmount totalAmount
ServiceItemAmount currentBalance
ServiceItemAmount postBalance
ServiceItemPrepurchaseRightInfo currentRightInfo
ServiceItemPrepurchaseRightInfo postRightInfo

ServiceItemGetPrepurchaseInfoResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemPrepurchaseInfo> nullablePrepurchaseInfo

ServiceItemGetServiceItemRightParam (Structure)

Type Name
String referenceId
String deviceId
Uint32 uniqueId
Uint8 itemGroup

Revision 1:

Type Name
Uint8 platform

ServiceItemRightBinary (Structure)

Type Name
Uint8 useType
qBuffer rightBinary

ServiceItemAccountRight (Structure)

Type Name
PID pid
ServiceItemLimitation limitation
List<ServiceItemRightBinary> rightBinaries

ServiceItemAccountRightTime (Structure)

This structure inherits from ServiceItemAccountRight

This structure does not contain any fields.

ServiceItemAccountRightConsumption (Structure)

This structure inherits from ServiceItemAccountRight
Type Name
Uint32 usedCount
Uint32 expiredCount
List<Uint32> expiryCounts

ServiceItemRightInfo (Structure)

Type Name
String referenceId
Uint32 referenceIdType

ServiceItemRightTimeInfo (Structure)

This structure inherits from ServiceItemRightInfo
Type Name
List<ServiceItemAccountRightTime> accountRights

ServiceItemRightConsumptionInfo (Structure)

This structure inherits from ServiceItemRightInfo
Type Name
List<ServiceItemAccountRightConsumption> accountRights

ServiceItemRightInfos (Structure)

Type Name
String supportId
List<ServiceItemRightConsumptionInfo> consumptionRightInfos
List<ServiceItemRightTimeInfo> additionalTimeRightInfos
List<ServiceItemRightTimeInfo> permanentRightInfos
Bool alreadyPurchasedInitialOnlyItem

ServiceItemGetServiceItemRightResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemRightInfos> nullableRightInfos

ServiceItemGetPurchaseHistoryParam (Structure)

Type Name
String language
Uint32 offset
Uint32 size
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemTransaction (Structure)

Type Name
String transactionId
String extTransactionId
DateTime time
Uint32 transactionType
String transactionDescription
ServiceItemAmount transactionAmount
String itemCode
String referenceId
ServiceItemLimitation limitation

ServiceItemPurchaseHistory (Structure)

Type Name
Uint32 totalSize
Uint32 offset
List<ServiceItemTransaction> transactions

ServiceItemGetPurchaseHistoryResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemPurchaseHistory> nullablePurchaseHistory

ServiceItemLawMessage (Structure)

Type Name
Bool isMessageRequired
String lawMessage

ServiceItemGetLawMessageParam (Structure)

Type Name
String language
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemGetLawMessageResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemLawMessage> nullableLawMessage

ServiceItemPostRightBinaryByAccountParam (Structure)

Type Name
String referenceId
Uint8 useType
qBuffer rightBinary
String logMessage
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemPostRightBinaryResponse (Structure)

This structure inherits from ServiceItemEShopResponse

This structure does not contain any fields.

ServiceItemUseServiceItemByAccountParam (Structure)

Type Name
String referenceIdForUse
String referenceIdForRightBinary
Uint8 useType
Uint8 useNumber
qBuffer rightBinary
String logMessage
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemUsedInfo (Structure)

Type Name
Uint32 acquiredCount
Uint32 usedCount

ServiceItemUseServiceItemResponse (Structure)

This structure inherits from ServiceItemEShopResponse
Type Name
List<ServiceItemUsedInfo> nullableUsedInfo

ServiceItemAcquireServiceItemByAccountParam (Structure)

Type Name
String referenceIdForAcquisition
String referenceIdForRightBinary
Uint8 useType
Uint32 limitationType
Uint32 limitationValue
qBuffer rightBinary
String logMessage
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemAcquireServiceItemResponse (Structure)

Type Name
Uint32 limitationType
Uint32 acquiredCount
Uint32 usedCount
Uint32 expiryDate
Uint32 expiredCount
List<Uint32> expiryCounts

ServiceItemGetSupportIdParam (Structure)

Type Name
Uint32 uniqueId

Revision 1:

Type Name
Uint8 platform

ServiceItemGetNoticeParam (Structure)

Type Name
Uint32 scheduleType

ServiceItemNotice (Structure)

Type Name
Uint64 scheduleId
Uint32 scheduleType
Sint32 paramInt
String paramString
qBuffer paramBinary
DateTime timeBegin
DateTime timeEnd

ServiceItemUserInfo (Structure)

Type Name
qBuffer applicationBuffer
Clone this wiki locally