Legal Service Agreement Events 0.1.0 documentation

• Protobuf File Spec: legal.proto

Published Messages (agreement)

The service publishes one of these messages below.

agreementCreated

Message is sent after user accepts legal documentation. Contains fields from event and the following payload.

Example value

{
  "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"
}

payload

Name	Type	Description
agreement	agreement	-

agreementUpdated

Message is sent after user accepts legal documentation. Contains fields from event and the following payload.

Example value

{
  "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"
}

payload

Name	Type	Description
agreement	agreement	-

Schemas

agreement

Name	Type	Description
policyId	string	policy id
policyVersionId	string	policy version id
policyName	string	policy name
displayVersion	string	display version of policy version
localizedPolicyVersionId	string	localized policy version id
localizedDescription	string	description of localized policy
isAccepted	boolean	a flag indicates whether user accepted this policy
userId	string	user id, can be publisher/game user id

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-