Registration Role Context
GET {url}/api/account/registration/{roleIdentifier}/context
Provides registration related information for a given role. The response is useful to determine what attributes and features are tied to a given Partner role definition.
Request Requirements:
| Property | Required? | Description |
|---|---|---|
| roleIdentifier | YES | Unique identifier assigned to the PRIVO role (provided by a PRIVO Administrator) |
| featureIdentifiers | NO | Comma-separated list of feature identifiers (provided by a PRIVO Administrator). If omitted, all features will be retrieved. |
Response Notes:
The attributes property in the response contains all the data fields that can be collected about the User for the given role. Attributes may show twice depending on whether they are associated to both the role and a feature associated to the role. The "entityType" value defines how the attribute is tied to the resource. For an example of an attribute showing twice, notice "gender" in the sample response.
The features property in the response contains all the features that are associated to a User who registers for the given role.
API Endpoint:
/api/account/registration/{roleIdentifier}/context
Sample Request:
{{url}}/api/account/registration/someRoleIdentifier
/context?
featureIdentifiers=someFeatureIdentifier,
someOtherFeature
Sample Response:
{
"validationErrors": [],
"status": "success",
"message": null,
"resultCount": -1,
"totalCount": -1,
"entity": {
"role": null,
"profile": null,
"attributes": [
{
"@class": "com.privo.ws.domain.partner.RoleAttribute",
"pii": false,
"collectPostConsent": false,
"rank": 0,
"required": true,
"label": "First Name",
"readOnly": false,
"attribute": {
"@class": "com.privo.ws.domain.partner.AttributeDef",
"added": 1415040943000,
"modified": null,
"id": 20,
"version": 1,
"attribute": "firstName",
"attDefIdentifier": "PRIVOLOCK_firstName",
"label": "First Name",
"rank": -1,
"regex": null,
"maxLength": 50,
"cssClass": null,
"systemAttribute": false,
"placeholderText": "First Name",
"standardAttributeType": "FIRSTNAME",
"categoryType": "STANDARD_ATTRIBUTE",
"widgetType": "TEXT",
"validationType": null,
"optionsType": null,
"optionsDef": null,
"partnerConfigId": 1,
"options": [],
"readOnly": false,
"identifier": "firstName",
"attributeName": "firstName",
"standardAddressAttribute": false,
"referenceDef": null,
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"attributeId": 20,
"standardAttribute": true,
"_name": "attributeDef"
},
"added": 1587658550000,
"modified": null,
"version": 1,
"identifier": "firstName.someRoleIdentifier",
"roleId": 91,
"entityIdentifier": "someRoleIdentifier",
"entityId": 91,
"appliedTo": "REQUESTER",
"entityType": "RoleAttribute",
"attributeName": "firstName",
"attributeId": 20,
"standardAttribute": true,
"systemAttribute": false,
"standardAttributeType": "FIRSTNAME",
"auditString": "RoleAttribute[PrivoRole[91]: someRoleIdentifier 20]: ",
"options": [],
"maxLength": 50,
"attDefIdentifier": "PRIVOLOCK_firstName",
"placeholderText": "First Name",
"regex": null,
"categoryType": "STANDARD_ATTRIBUTE",
"cssClass": null,
"optionsDef": null,
"referenceDef": null,
"optionsType": null,
"validationType": null,
"widgetType": "TEXT",
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"_name": "attributeDef"
},
{
"@class": "com.privo.ws.domain.partner.RoleAttribute",
"pii": false,
"collectPostConsent": false,
"rank": 2,
"required": false,
"label": "Gender",
"readOnly": false,
"attribute": {
"@class": "com.privo.ws.domain.partner.AttributeDef",
"added": 1415040943000,
"modified": 1541709803000,
"id": 17,
"version": 11375,
"attribute": "gender",
"attDefIdentifier": "PRIVOLOCK_gender",
"label": "Gender",
"rank": 3,
"regex": null,
"maxLength": 100,
"cssClass": null,
"systemAttribute": false,
"placeholderText": "Gender",
"standardAttributeType": "GENDER",
"categoryType": "STANDARD_ATTRIBUTE",
"widgetType": "RADIO",
"validationType": null,
"optionsType": "USER_DEFINED",
"optionsDef": null,
"partnerConfigId": 1,
"options": [
{
"_id": 5135,
"id": "1",
"value": "Male"
},
{
"_id": 5134,
"id": "2",
"value": "Female"
}
],
"readOnly": false,
"identifier": "gender",
"attributeName": "gender",
"standardAddressAttribute": false,
"referenceDef": null,
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"attributeId": 17,
"standardAttribute": true,
"_name": "attributeDef"
},
"added": 1587658550000,
"modified": null,
"version": 1,
"identifier": "gender.someRoleIdentifier",
"roleId": 91,
"entityIdentifier": "someRoleIdentifier",
"entityId": 91,
"appliedTo": "REQUESTER",
"entityType": "RoleAttribute",
"attributeName": "gender",
"attributeId": 17,
"standardAttribute": true,
"systemAttribute": false,
"standardAttributeType": "GENDER",
"auditString": "RoleAttribute[PrivoRole[91]: someRoleIdentifier 17]: ",
"options": [
{
"_id": 5135,
"id": "1",
"value": "Male"
},
{
"_id": 5134,
"id": "2",
"value": "Female"
}
],
"maxLength": 100,
"attDefIdentifier": "PRIVOLOCK_gender",
"placeholderText": "Gender",
"regex": null,
"categoryType": "STANDARD_ATTRIBUTE",
"cssClass": null,
"optionsDef": null,
"referenceDef": null,
"optionsType": "USER_DEFINED",
"validationType": null,
"widgetType": "RADIO",
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"_name": "attributeDef"
},
{
"@class": "com.privo.ws.domain.partner.FeatureAttribute",
"pii": false,
"collectPostConsent": false,
"rank": 1,
"required": true,
"label": "Email",
"readOnly": false,
"attribute": {
"@class": "com.privo.ws.domain.partner.AttributeDef",
"added": 1416431583000,
"modified": 1452718502000,
"id": 491,
"version": 1,
"attribute": "email",
"attDefIdentifier": "PRIVOLOCK_email",
"label": "Email",
"rank": 0,
"regex": "",
"maxLength": 255,
"cssClass": "",
"systemAttribute": false,
"placeholderText": "Email",
"standardAttributeType": "EMAIL",
"categoryType": "STANDARD_ATTRIBUTE",
"widgetType": "EMAIL",
"validationType": null,
"optionsType": null,
"optionsDef": null,
"partnerConfigId": 1,
"options": [],
"readOnly": false,
"identifier": "email",
"attributeName": "email",
"standardAddressAttribute": false,
"referenceDef": null,
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"attributeId": 491,
"standardAttribute": true,
"_name": "attributeDef"
},
"added": 1569604397000,
"modified": null,
"version": 1,
"appliedTo": "REQUESTER",
"identifier": "email.someOtherFeature",
"entityIdentifier": "someOtherFeature",
"entityId": 74808,
"entityType": "FeatureAttribute",
"featureId": 74808,
"attributeName": "email",
"attributeId": 491,
"standardAttribute": true,
"systemAttribute": false,
"standardAttributeType": "EMAIL",
"auditString": "FeatureAttribute[PrivoFeature[7808]: someOtherFeature Critter Newsletter 491]: ",
"options": [],
"maxLength": 255,
"attDefIdentifier": "PRIVOLOCK_email",
"placeholderText": "Email",
"regex": "",
"categoryType": "STANDARD_ATTRIBUTE",
"cssClass": "",
"optionsDef": null,
"referenceDef": null,
"optionsType": null,
"validationType": null,
"widgetType": "EMAIL",
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"_name": "attributeDef"
},
{
"@class": "com.privo.ws.domain.partner.FeatureAttribute",
"pii": false,
"collectPostConsent": false,
"rank": 0,
"required": true,
"label": "Gender",
"readOnly": false,
"attribute": {
"@class": "com.privo.ws.domain.partner.AttributeDef",
"added": 1415040943000,
"modified": 1541709803000,
"id": 17,
"version": 11375,
"attribute": "gender",
"attDefIdentifier": "PRIVOLOCK_gender",
"label": "Gender",
"rank": 3,
"regex": null,
"maxLength": 100,
"cssClass": null,
"systemAttribute": false,
"placeholderText": "Gender",
"standardAttributeType": "GENDER",
"categoryType": "STANDARD_ATTRIBUTE",
"widgetType": "RADIO",
"validationType": null,
"optionsType": "USER_DEFINED",
"optionsDef": null,
"partnerConfigId": 1,
"options": [
{
"_id": 58135,
"id": "1",
"value": "Male"
},
{
"_id": 58134,
"id": "2",
"value": "Female"
}
],
"readOnly": false,
"identifier": "gender",
"attributeName": "gender",
"standardAddressAttribute": false,
"referenceDef": null,
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"attributeId": 17,
"standardAttribute": true,
"_name": "attributeDef"
},
"added": 1569604397000,
"modified": null,
"version": 1,
"appliedTo": "REQUESTER",
"identifier": "gender.someFeatureIdentifier",
"entityIdentifier": "someFeatureIdentifier",
"entityId": 16851,
"entityType": "FeatureAttribute",
"featureId": 16851,
"attributeName": "gender",
"attributeId": 17,
"standardAttribute": true,
"systemAttribute": false,
"standardAttributeType": "GENDER",
"auditString": "FeatureAttribute[PrivoFeature[74808]: someFeatureIdentifier Critterboard Catchers 17]: ",
"options": [
{
"_id": 58135,
"id": "1",
"value": "Male"
},
{
"_id": 58134,
"id": "2",
"value": "Female"
}
],
"maxLength": 100,
"attDefIdentifier": "PRIVOLOCK_gender",
"placeholderText": "Gender",
"regex": null,
"categoryType": "STANDARD_ATTRIBUTE",
"cssClass": null,
"optionsDef": null,
"referenceDef": null,
"optionsType": "USER_DEFINED",
"validationType": null,
"widgetType": "RADIO",
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"_name": "attributeDef"
},
{
"@class": "com.privo.ws.domain.partner.RoleAttribute",
"pii": false,
"collectPostConsent": false,
"rank": 1,
"required": true,
"label": "Birth Date",
"readOnly": false,
"attribute": {
"@class": "com.privo.ws.domain.partner.AttributeDef",
"added": 1439217831000,
"modified": 1466086315000,
"id": 441,
"version": 2,
"attribute": "birthDate",
"attDefIdentifier": "PRIVOLOCK_birthDate",
"label": "Birth Date",
"rank": 1,
"regex": null,
"maxLength": 1,
"cssClass": "",
"systemAttribute": false,
"placeholderText": "Birth Date",
"standardAttributeType": "BIRTHDATE",
"categoryType": "STANDARD_ATTRIBUTE",
"widgetType": "DATE",
"validationType": null,
"optionsType": null,
"optionsDef": null,
"partnerConfigId": 1,
"options": [],
"readOnly": false,
"identifier": "birthDate",
"attributeName": "birthDate",
"standardAddressAttribute": false,
"referenceDef": null,
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"attributeId": 441,
"standardAttribute": true,
"_name": "attributeDef"
},
"added": 1587658550000,
"modified": null,
"version": 1,
"identifier": "birthDate.someRoleIdentifier",
"roleId": 91,
"entityIdentifier": "someRoleIdentifier",
"entityId": 91,
"appliedTo": "REQUESTER",
"entityType": "RoleAttribute",
"attributeName": "birthDate",
"attributeId": 441,
"standardAttribute": true,
"systemAttribute": false,
"standardAttributeType": "BIRTHDATE",
"auditString": "RoleAttribute[PrivoRole[91]: someRoleIdentifier 441]: ",
"options": [],
"maxLength": 1,
"attDefIdentifier": "PRIVOLOCK_birthDate",
"placeholderText": "Birth Date",
"regex": null,
"categoryType": "STANDARD_ATTRIBUTE",
"cssClass": "",
"optionsDef": null,
"referenceDef": null,
"optionsType": null,
"validationType": null,
"widgetType": "DATE",
"personSiteAttribute": false,
"attributeEntityType": "com.privo.ws.domain.account.PrivoPerson",
"personAttribute": true,
"personAddressAttribute": false,
"_name": "attributeDef"
}
],
"features": [
{
"id": 16851,
"identifier": "someFeatureIdentifier",
"featureAttributes": [],
"category": "Standard",
"access": "Gated",
"featurePromotion": "Standard",
"activeByDefault": false,
"termsOfServiceUrl": "https://partner.com/terms-of-use/",
"privacyPolicyUrl": "https://partner.com/privacy-policy/",
"dataUsagePolicyUrl": "https://partner.com/terms-of-use/",
"title": "Critterboard Catchers",
"summary": "Critter Chase Leaderboard",
"description": "Want to be on the leaderboard? Get a high score and we will share your accomplishment with the Critter Chase World. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam ultricies mauris at dui eleifend tincidunt. Donec quis est ac leo dapibus egestas. Aenean pellentesque eget tellus non lobortis. Nam eget maximus eros, non pharetra purus. Fusce eget sapien pretium, condimentum lectus et, egestas lectus. Donec vel diam ut velit posuere placerat ut maximus tellus.",
"dataUseDescription": "Gender will be used to fulfill this feature.",
"active": true,
"startDate": 1431302400000,
"endDate": null,
"promoteAtRegistration": false,
"displayOrder": 2,
"price": 0.0,
"freemium": false,
"premium": false,
"premiumOptIn": false,
"site": {
"_id": 1,
"siteIdentifier": "siteIdentifier",
"siteToken": null,
"partnerConfigId": null,
"shortDescription": null,
"siteInfo": null,
"features": [],
"roles": [],
"added": 1587660048396,
"modified": null,
"name": null,
"displayNamePolicy": null,
"description": null,
"active": false,
"roleGateEnabled": false,
"ageGateEnabled": false,
"ageMode": null,
"groupEnabled": false,
"consentExpireDays": 365,
"verificationExpireDays": 30,
"lgsCookieHours": 0,
"lgsCookieDays": 0,
"saveVerificationAddressEnabled": false,
"redirectDelay": 0,
"playNowEnabled": true,
"lgsSignIn": false,
"hidden": false,
"prospectPurgeDays": 3,
"webUrl": null,
"loginUrl": null,
"requireConfirmedEmail": false,
"socialLogin": false,
"socialAttributes": [],
"logoUrl": null,
"emailLogoUrl": null,
"minIntendedAge": 2,
"maxIntendedAge": 13,
"organization": null,
"verificationMethods": [],
"emailFromName": null,
"signInOption": false,
"defaultJurisdictionId": null,
"useCompanyJurisdiction": false,
"useDefaultJurisdiction": false,
"maxChildAge": 0,
"maxTeenAge": 0,
"id": 9999,
"version": null,
"identifier": "siteIdentifier",
"auditString": "Site[9999]: null",
"defaultPrivoSite": false
},
"siteId": 9999,
"featureId": 16851
},
{
"id": 74808,
"identifier": "someOtherFeature",
"featureAttributes": [],
"category": "Optional",
"access": "NonGated",
"featurePromotion": "Optional",
"activeByDefault": false,
"termsOfServiceUrl": "https://partner.com/terms-of-use/",
"privacyPolicyUrl": "https://partner.com/privacy-policy/",
"dataUsagePolicyUrl": "https://partner.com/terms-of-use/",
"title": "Critter Newsletter",
"summary": "Critter Chase Newsletter Membership",
"description": "When an email address is provided then you can start to receive the Critter Newsletter. The monthly newsletter is packed full of activities and information that will keep you engaged and entertained the whole month through. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam ultricies mauris at dui eleifend tincidunt. Donec quis est ac leo dapibus egestas. Aenean pellentesque eget tellus non lobortis. Nam eget maximus eros, non pharetra purus. Fusce eget sapien pretium, condimentum lectus et, egestas lectus. Donec vel diam ut velit posuere placerat ut maximus tellus.",
"dataUseDescription": "Email address and gender will be used to fulfill this feature.",
"active": true,
"startDate": 1531612800000,
"endDate": null,
"promoteAtRegistration": false,
"displayOrder": 3,
"price": 0.0,
"freemium": false,
"premium": false,
"premiumOptIn": false,
"site": {
"_id": 2,
"siteIdentifier": "siteIdentifier",
"siteToken": null,
"partnerConfigId": null,
"shortDescription": null,
"siteInfo": null,
"features": [],
"roles": [],
"added": 1587660048400,
"modified": null,
"name": null,
"displayNamePolicy": null,
"description": null,
"active": false,
"roleGateEnabled": false,
"ageGateEnabled": false,
"ageMode": null,
"groupEnabled": false,
"consentExpireDays": 365,
"verificationExpireDays": 30,
"lgsCookieHours": 0,
"lgsCookieDays": 0,
"saveVerificationAddressEnabled": false,
"redirectDelay": 0,
"playNowEnabled": true,
"lgsSignIn": false,
"hidden": false,
"prospectPurgeDays": 3,
"webUrl": null,
"loginUrl": null,
"requireConfirmedEmail": false,
"socialLogin": false,
"socialAttributes": [],
"logoUrl": null,
"emailLogoUrl": null,
"minIntendedAge": 2,
"maxIntendedAge": 13,
"organization": null,
"verificationMethods": [],
"emailFromName": null,
"signInOption": false,
"defaultJurisdictionId": null,
"useCompanyJurisdiction": false,
"useDefaultJurisdiction": false,
"maxChildAge": 0,
"maxTeenAge": 0,
"id": 9999,
"version": null,
"identifier": "siteIdentifier",
"auditString": "Site[9999]: null",
"defaultPrivoSite": false
},
"siteId": 9999,
"featureId": 74808
}
]
},
"responseTimestamp": 1587660048540
}