Access
Digital Access
Introduction
This endpoint is used to create Digital Access for the User based on the provided EntitlementCode and CustomerRegistrationId and create an Access Log record in the database.
Comparison
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/DigitalAccess
/v4/Access
Method
POST
POST
Request
Response
Note:– The parameters subscriptionId and accessLevelCode are available only from version 3.17.0.3 onwards.
Digital Access
POST /v4/Access
This endpoint is used to create Digital Access for the User based on the provided EntitlementCode and CustomerRegistrationId and create an Access Log record in the database.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
Headers
Authorization*
String
JSON Web Token used for security purposes
X-SourceSystem*
String
To identify the consumer or the Source System
X-ClientCode*
String
Client Code of the Tenant
X-PaperCode*
String
Paper Code of the Tenant
X-ClientGroupCode*
String
Client Group Code of the Tenant
Request Body
EntitlementCode*
String
Unique identifier of the Entitlement in the SubCon database
CustomerRegistrationId*
String
Unique identifier of the Registration in the SubCon database.
Device*
String
Caller’s Device
ReturnUrl
String
URL to which users must be redirected after the access has been created.
FromUrl
String
URL to which users will be directed to create access.
Note:– The parameters subscriptionId and accessLevelCode are available only from version 3.17.0.3 onwards.
Get Access
Introduction
This endpoint is used to return the current access level (Premium, Upgrade, Purchase) based on the provided EntitlementCode and CustomerRegistrationId.
Note:– The GET method creates an entry in the Access_log table only from version 3.17.0.3 onwards.
Comparison
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/DigitalAccess
/v4/Access?CustomerRegistrationId={string}&EntitlementCode={string}
Method
POST
GET
RequestBody
Response
Get Access
GET /v4/Access?CustomerRegistrationId={string}&EntitlementCode={string}
This endpoint is used to return the current access level (Premium, Upgrade, Purchase) based on the provided EntitlementCode and CustomerRegistrationId.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
Query Parameters
EntitlementCode*
String
Unique identifier of the Entitlement in the SubCon database
CustomerRegistrationId*
String
Unique identifier of the Registration in the SubCon database.
Headers
Authorization*
String
JSON Web Token used for security purposes
X-SourceSystem*
String
To identify the consumer or the Source System
X-ClientCode*
String
Client Code of the Tenant
X-PaperCode*
String
Paper Code of the Tenant
X-ClientGroupCode*
String
Client Group Code of the Tenant
Last updated