Skip to main content

Legal Service Policy Events 0.1.0 documentation

Published Messages (basePolicy)

The service publishes one of these messages below.

basePolicyCreated

Message is sent after base policy is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"basePolicy": {
"id": "string",
"basePolicyName": "string",
"description": "string",
"typeId": "string",
"policyTypeName": "string",
"affectedClientIds": [
"string"
],
"affectedCountries": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isMandatory": true,
"namespace": "string",
"tags": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
basePolicybasePolicy-

basePolicyUpdated

Contains fields from event and the following payload.

Example value
{
"payload": {
"basePolicy": {
"id": "string",
"basePolicyName": "string",
"description": "string",
"typeId": "string",
"policyTypeName": "string",
"affectedClientIds": [
"string"
],
"affectedCountries": [
"string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"isMandatory": true,
"namespace": "string",
"tags": [
"string"
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
basePolicybasePolicy-

Published Messages (policy)

The service publishes one of these messages below.

policyCreated

Message is sent when country based policy is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"policy": {
"id": "string",
"policyName": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shouldNotifyOnUpdate": true,
"countryGroupCode": "string",
"isMandatory": true,
"isDefaultOpted": true,
"basePolicyId": "string",
"readableId": "string",
"description": "string",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
policypolicy-

policyUpdated

Message is sent when country base policy is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"policy": {
"id": "string",
"policyName": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shouldNotifyOnUpdate": true,
"countryGroupCode": "string",
"isMandatory": true,
"isDefaultOpted": true,
"basePolicyId": "string",
"readableId": "string",
"description": "string",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
policypolicy-

defaultPolicyUpdated

Message is sent when country based policy is set to default. Contains fields from event and the following payload.

Example value
{
"payload": {
"policy": {
"id": "string",
"policyName": "string",
"countryCode": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"shouldNotifyOnUpdate": true,
"countryGroupCode": "string",
"isMandatory": true,
"isDefaultOpted": true,
"basePolicyId": "string",
"readableId": "string",
"description": "string",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
policypolicy-

Published Messages (versionedPolicy)

The service publishes one of these messages below.

versionedPolicyCreated

Message is sent when policy version is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"versionedPolicy": {
"id": "string",
"policyId": "string",
"displayVersion": "string",
"description": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isCrucial": true,
"isCommitted": true,
"isInEffect": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
versionedPolicyversionedPolicy-

versionedPolicyUpdated

Message is sent when policy version is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"versionedPolicy": {
"id": "string",
"policyId": "string",
"displayVersion": "string",
"description": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isCrucial": true,
"isCommitted": true,
"isInEffect": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
versionedPolicyversionedPolicy-

versionedPolicyPublished

Message is sent when policy version is published. Contains fields from event and the following payload.

Example value
{
"payload": {
"versionedPolicy": {
"id": "string",
"policyId": "string",
"displayVersion": "string",
"description": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isCrucial": true,
"isCommitted": true,
"isInEffect": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
versionedPolicyversionedPolicy-

Published Messages (localizedPolicy)

The service publishes one of these messages below.

localizedPolicyCreated

Message is sent when localized policy is created. Contains fields from event and the following payload.

Example value
{
"payload": {
"localizedPolicy": {
"id": "string",
"versionedPolicyId": "string",
"description": "string",
"localeCode": "string",
"contentType": "string",
"attachmentLocation": "string",
"attachmentChecksum": "string",
"attachmentVersionIdentifier": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
localizedPolicylocalizedPolicy-

localizedPolicyUpdated

Message is sent when localized policy is updated. Contains fields from event and the following payload.

Example value
{
"payload": {
"localizedPolicy": {
"id": "string",
"versionedPolicyId": "string",
"description": "string",
"localeCode": "string",
"contentType": "string",
"attachmentLocation": "string",
"attachmentChecksum": "string",
"attachmentVersionIdentifier": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
localizedPolicylocalizedPolicy-

defaultLocalizedPolicyUpdated

Contains fields from event and the following payload.

Example value
{
"payload": {
"localizedPolicy": {
"id": "string",
"versionedPolicyId": "string",
"description": "string",
"localeCode": "string",
"contentType": "string",
"attachmentLocation": "string",
"attachmentChecksum": "string",
"attachmentVersionIdentifier": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"publishedDate": "2019-08-24T14:15:22Z",
"isDefaultSelection": true
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}

payload

NameTypeDescription
localizedPolicylocalizedPolicy-

Schemas

basePolicy

NameTypeDescription
idstringbase policy id
basePolicyNamestringname of the base policy
descriptionstringdescription of the base policy
typeIdstringpolicy type id
policyTypeNamestringpolicy type name, value can be Legal Document or Marketing Preference
affectedClientIdsarrayaffected oauth clients
affectedCountriesarraycountries included in the base policy
createdAtstring (date-time)time when the base policy is created
updatedAtstring (date-time)time when the base policy is updated
isMandatorybooleana flag indicates whether this base policy is mandatory
namespacestringnamespace of the base policy
tagsarraytags of this base policy

policy

NameTypeDescription
idstringpolicy id
policyNamestringpolicy name
countryCodestringcountry code
createdAtstring (date-time)time when the policy is created
updatedAtstring (date-time)time when the policy is updated
shouldNotifyOnUpdatebooleana flag indicates whether need to notify users if this policy is updated
countryGroupCodestring-
isMandatorybooleana flag indicates whether this policy is mandatory
isDefaultOptedboolean-
basePolicyIdstring-
readableIdstring-
descriptionstringdescription of this policy
isDefaultSelectionbooleana flag indicates whether this country based policy is the default selected

versionedPolicy

NameTypeDescription
idstringpolicy version id
policyIdstringpolicy id this policy version belongs to
displayVersionstringdisplay version of this policy version
descriptionstringdescription of this policy version
statusstringstatus of this policy version, values can be empty string if never published or PUBLISHED/ACTIVE
createdAtstring (date-time)time when this version is created
updatedAtstring (date-time)time when this version is updated
publishedDatestring (date-time)time when this version is published
isCrucialboolean-
isCommittedboolean-
isInEffectbooleana flag indicates whether this version is currently published

localizedPolicy

NameTypeDescription
idstringlocalized policy version id
versionedPolicyIdstringpolicy version id
descriptionstringdescription of localized policy version
localeCodestringlocale/language code
contentTypestringtype of the source file, text/html or text/markdown
attachmentLocationstringlocation of the source file in the storage
attachmentChecksumstringchecksum of the source file
attachmentVersionIdentifierstringidentifier of the source file
statusstring-
createdAtstring (date-time)time when this localized version was created
updatedAtstring (date-time)time when this localized version was updated
publishedDatestring (date-time)-
isDefaultSelectionboolean-

event

NameTypeDescription
idstring-
versioninteger-
namestring-
namespacestring-
parentNamespacestring-
timestampstring (date-time)-
clientIdstring-
userIdstring-
traceIdstring-
sessionIdstring-