Basic Service User Profile 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.
- Specification ID:
http://basic-service - Protobuf File Spec: profile.proto
Table of Contents
Operations
PUB userProfile Operation
Accepts one of the following messages:
Message userProfileCreated
message is sent when user profile is created
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.userId | string | user id | - | - | - |
| payload.firstName | string | first name | - | - | - |
| payload.lastName | string | last name | - | - | - |
| payload.avatarUrlSmall | string | avatar small url | - | - | - |
| payload.avatarUrl | string | avatar url | - | - | - |
| payload.avatarUrlLarge | string | avatar large url | - | - | - |
| payload.language | string | language | - | - | - |
| payload.timeZone | string | time zone | - | - | - |
| payload.dateOfBirth | string | date of birth | - | format (date) | - |
| payload.status | boolean | status | - | - | - |
| payload.zipCode | string | zip code | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "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 userProfileDeleted
message is sent when user profile is deleted
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.userId | string | user id | - | - | - |
| payload.firstName | string | first name | - | - | - |
| payload.lastName | string | last name | - | - | - |
| payload.avatarUrlSmall | string | avatar small url | - | - | - |
| payload.avatarUrl | string | avatar url | - | - | - |
| payload.avatarUrlLarge | string | avatar large url | - | - | - |
| payload.language | string | language | - | - | - |
| payload.timeZone | string | time zone | - | - | - |
| payload.dateOfBirth | string | date of birth | - | format (date) | - |
| payload.status | boolean | status | - | - | - |
| payload.zipCode | string | zip code | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "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 userProfileEnabled
message is sent when user profile is enabled
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.userId | string | user id | - | - | - |
| payload.firstName | string | first name | - | - | - |
| payload.lastName | string | last name | - | - | - |
| payload.avatarUrlSmall | string | avatar small url | - | - | - |
| payload.avatarUrl | string | avatar url | - | - | - |
| payload.avatarUrlLarge | string | avatar large url | - | - | - |
| payload.language | string | language | - | - | - |
| payload.timeZone | string | time zone | - | - | - |
| payload.dateOfBirth | string | date of birth | - | format (date) | - |
| payload.status | boolean | status | - | - | - |
| payload.zipCode | string | zip code | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "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 userProfileDisabled
message is sent when user profile is disabled
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.userId | string | user id | - | - | - |
| payload.firstName | string | first name | - | - | - |
| payload.lastName | string | last name | - | - | - |
| payload.avatarUrlSmall | string | avatar small url | - | - | - |
| payload.avatarUrl | string | avatar url | - | - | - |
| payload.avatarUrlLarge | string | avatar large url | - | - | - |
| payload.language | string | language | - | - | - |
| payload.timeZone | string | time zone | - | - | - |
| payload.dateOfBirth | string | date of birth | - | format (date) | - |
| payload.status | boolean | status | - | - | - |
| payload.zipCode | string | zip code | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "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 userProfileUpdated
message is sent when user profile is updated
Payload
| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | object allOf | - | - | - | additional properties are allowed |
| payload | object | - | - | - | additional properties are allowed |
| payload.userId | string | user id | - | - | - |
| payload.firstName | string | first name | - | - | - |
| payload.lastName | string | last name | - | - | - |
| payload.avatarUrlSmall | string | avatar small url | - | - | - |
| payload.avatarUrl | string | avatar url | - | - | - |
| payload.avatarUrlLarge | string | avatar large url | - | - | - |
| payload.language | string | language | - | - | - |
| payload.timeZone | string | time zone | - | - | - |
| payload.dateOfBirth | string | date of birth | - | format (date) | - |
| payload.status | boolean | status | - | - | - |
| payload.zipCode | string | zip code | - | - | - |
| 0 (allOf item) | object | - | - | - | additional properties are allowed |
| id | string | - | - | - | - |
| version | integer | - | - | - | - |
| name | string | - | - | - | - |
| namespace | string | - | - | - | - |
| parentNamespace | string | - | - | - | - |
| timestamp | string | - | - | format (date-time) | - |
| clientId | string | - | - | - | - |
| userId | string | - | - | - | - |
| traceId | string | - | - | - | - |
| sessionId | string | - | - | - | - |
Examples of payload (generated)
{
"payload": {
"userId": "string",
"firstName": "string",
"lastName": "string",
"avatarUrlSmall": "string",
"avatarUrl": "string",
"avatarUrlLarge": "string",
"language": "string",
"timeZone": "string",
"dateOfBirth": "2019-08-24",
"status": true,
"zipCode": "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"
}