A Right is used to issue access rights such as license key to customer upon purchase.
GetRight
This service is used to query the Right object.
Request Parameters
Node |
Required |
Data Type |
Description |
rightID |
Yes |
Integer |
The object identifier. |
Return Data
Node |
Data Type |
Description |
right |
XML |
|
adminNotes |
String |
Administrator notes not shown to customer. |
assignedUserID |
Integer |
The right may be assigned to a user. |
code |
String |
The unique code. |
createDate |
DateTime |
|
issueDate |
DateTime |
The date when the right was first issued. |
rightDefinitionID |
Integer |
The right definition object identifier associated with this right. The right definition is the template that determines type of right. |
rightID |
Integer |
The object identifier. |
salesOrderDetailID |
Integer |
The corresponding sales order detail object identifier if this right was generate from the order. |
updateDate |
DateTime |
|
GetRightByCode
This service is used to query the Right object.
Request Parameters
Node |
Required |
Data Type |
Description |
code |
Yes |
String |
The right code. |
Return Data
Same data structure as GetRight service return data.
GetRights
This service is used to query all the Right objects.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
rights |
XML |
Container node |
right |
XML |
Zero or more Right nodes with same data structure as GetRight service return data. |
GetRightsByRightDefinition
This service is used to query all the Right objects.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
rightDefinitionID |
Yes |
Integer |
The RightDefinition object identifier. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
rights |
XML |
Container node |
right |
XML |
Zero or more Right nodes with same data structure as GetRight service return data. |