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 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.
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.
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
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.
400
EntitlementsOrchestrator_E400
Bad Request
400
EntitlementsOrchestrator_E400_01
Invalid InputModel
400
EntitlementsOrchestrator_E400_02
Entitlements not found
400
EntitlementsOrchestrator_E400_03
AccessLevelCode is Purchase
400
EntitlementsOrchestrator_E400_04
AccessLevelCode is Upgrade
400
EntitlementsOrchestrator_E400_05
AccessLevelCode is not Premium
500
EntitlementsOrchestrator_E500
Internal Server Error
500
EntitlementsOrchestrator_E500_01
TemporaryEntitlement doesn't exist.
500
EntitlementsOrchestrator_E500_02
EntitlementAccess doesn't exist.
500
EntitlementsOrchestrator_E500_03
Entitlement's eEdition Url was not found.
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.
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 /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.
EntitlementCode*
String
Unique identifier of the Entitlement in the SubCon database
CustomerRegistrationId*
String
Unique identifier of the Registration in the SubCon database.
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
400
EntitlementsOrchestrator_E400
Bad Request
400
EntitlementsOrchestrator_E400_01
Invalid InputModel
400
EntitlementsOrchestrator_E400_02
Entitlements not found
500
EntitlementsOrchestrator_E500
Internal Server Error