Digital content's structure
Digital content structure
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| content | string(2500) | R | Digital content information |
| refId | string(50) | R | Reference id/code or serial id for the digital content |
| availability | object | R | Availability information (Digital content) |
Availability information structure
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| type | string(30) | R | Availability type |
| settings | object | R | Reference id/code or serial id for the digital content |
| settings.availabledAt | string(10) | O | Availabled at date format (YYYY-MM-DD) |
| settings.expiredAt | string(10) | O | Expired at date format (YYYY-MM-DD) |
| settings.expiredAt | string(10) | O | Expired at date format (YYYY-MM-DD) |
Availability information
Date range
For digital content with Date range expiration information
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| type | string(30) | R | Availability type |
| settings | object | R | Availability settings |
| settings.availableAt | string(10) | R | Availabled at date format (YYYY-MM-DD) |
| settings.expiredAt | string(10) | R | Expired at date format (YYYY-MM-DD) |
Remark
System will always expire code at the end of each day
{
"type": "DATE_RANGE",
"settings": {
"availabledAt": "2020-02-01",
"expiredAt": "2020-02-10"
}
}
Expiry date
For digital content with Expiry date expiration information
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| type | string(30) | R | Availability type |
| settings | object | R | Availability settings |
| settings.expiredAt | string(10) | R | Expired at date format (YYYY-MM-DD) |
Remark
System will always expire code at the end of each day
{
"type": "EXPIRY_DATE",
"settings": {
"expiredAt": "2020-02-10"
}
}
No expiry
For digital content with No expiry expiration information
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| type | string(30) | R | Availability type |
{
"type": "EXPIRY_DATE"
}
Period after purchased
For digital content with Period after purchased information
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| type | string(30) | R | Availability type |
| settings | object | R | Availability settings |
| settings.unit | string(10) | R | Period unit (years, quarters, months, weeks, days, hours, minutes, seconds, milliseconds) |
| settings.value | number(10) | R | Availability value which will be used with with given unit |
{
"type": "PERIOD_AFTER_PURCHASED",
"settings": {
"unit": "days",
"value": 10
}
}
Example of digital content structure
{
"content": "asdflkja",
"refId": "ADLQ-1",
"availability": {
"type": "NO_EXPIRY"
}
}