Skip to main content

Legal Service Agreement Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

Table of Contents

Operations

PUB agreement Operation

Accepts one of the following messages:

Message agreementCreated

message is sent after user accepts legal documentation

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.agreementobject---additional properties are allowed
payload.agreement.policyIdstringpolicy id---
payload.agreement.policyVersionIdstringpolicy version id---
payload.agreement.policyNamestringpolicy name---
payload.agreement.displayVersionstringdisplay version of policy version---
payload.agreement.localizedPolicyVersionIdstringlocalized policy version id---
payload.agreement.localizedDescriptionstringdescription of localized policy---
payload.agreement.isAcceptedbooleana flag indicates whether user accepted this policy---
payload.agreement.userIdstringuser id, can be publisher/game user id---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"agreement": {
"policyId": "string",
"policyVersionId": "string",
"policyName": "string",
"displayVersion": "string",
"localizedPolicyVersionId": "string",
"localizedDescription": "string",
"isAccepted": true,
"userId": "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"
}

Message agreementUpdated

message is sent after user accepts legal documentation

Payload
NameTypeDescriptionValueConstraintsNotes
(root)object allOf---additional properties are allowed
payloadobject---additional properties are allowed
payload.agreementobject---additional properties are allowed
payload.agreement.policyIdstringpolicy id---
payload.agreement.policyVersionIdstringpolicy version id---
payload.agreement.policyNamestringpolicy name---
payload.agreement.displayVersionstringdisplay version of policy version---
payload.agreement.localizedPolicyVersionIdstringlocalized policy version id---
payload.agreement.localizedDescriptionstringdescription of localized policy---
payload.agreement.isAcceptedbooleana flag indicates whether user accepted this policy---
payload.agreement.userIdstringuser id, can be publisher/game user id---
0 (allOf item)object---additional properties are allowed
idstring----
versioninteger----
namestring----
namespacestring----
parentNamespacestring----
timestampstring--format (date-time)-
clientIdstring----
userIdstring----
traceIdstring----
sessionIdstring----

Examples of payload (generated)

{
"payload": {
"agreement": {
"policyId": "string",
"policyVersionId": "string",
"policyName": "string",
"displayVersion": "string",
"localizedPolicyVersionId": "string",
"localizedDescription": "string",
"isAccepted": true,
"userId": "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"
}