ECG Addison Module API (1.0)

Download OpenAPI specification:Download

Documentation for addison module

Authentication

bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Subscribers

Adds the Subscriber.

Request
Security:
bearer
Request Body schema: application/json
subscriberId
required
string
organizationId
string
callName
required
string
timezoneId
string
locale
string
required
object (AddActivityDateRangeDto)
contactEmailAddress
required
string
preferredVoiceId
string
Responses
201
post/api/subscribers
Request samples
application/json
{
  • "subscriberId": "363e32db-0679-404d-bb73-3bb769bc46f7",
  • "organizationId": "744d5085-e7f6-4677-84cd-26e6a6ccb121",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDateRange": {
    },
  • "contactEmailAddress": "string@gmail.com",
  • "preferredVoiceId": "d0d1362d-2861-4fd8-9266-f12cc568c9e6"
}
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

Lists all the available Subscribers.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search on the basis of callName, timezoneId or locale

sort_by
string

Default value : subscriberId

Example: sort_by=subscriberId
Responses
200
get/api/subscribers
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers?order_by=ASC&skip=0&take=10&searchTerm=string&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Subscriber information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
mode
required
string
Default: "subscriberId"
Enum: "subscriberId" "hardwareId"
Responses
200
get/api/subscribers/{subscriberId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}?mode=subscriberId' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

Deletes the Subscriber information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
delete/api/subscribers/{subscriberId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Subscriber information by updating the items they were provided.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
required
Array of objects (JsonPatchDocumentDto)
Responses
200
patch/api/subscribers/{subscriberId}
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

Save user color choices

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
favoriteColor
required
string
Responses
201
post/api/subscribers/{subscriberId}/favorite-color
Request samples
application/json
{
  • "favoriteColor": "string"
}
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

update/append subscriber settings information

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
settingName
required
string
Enum: "verificationMode" "disableCallSettings" "favoriteColor" "reminderClock" "reminderSound" "subtitleSizeCode" "wasAlreadyInMedicationManagement" "buttonLabelFontSize" "voiceAudioLevel" "musicAudioLevel" "effectAudioLevel" "isNicknamePreferred" "userNickname" "IsVerificationSetupFinished" "completedUIIntroduction" "faeCompleted" "lastOpenedScreenName" "savedClothes" "reminderClockSetup" "IsFaceVerificationSetupFinished" "environmentName" "fontSize" "avatarName" "uiEffectAudioLevel" "selectedDecorations" "sleepModeStartTime" "sleepModeEndTime" "gameAudioLevel" "webcamDeviceName" "userNameType" "wakeWord"
settingValue
required
string
Responses
200
patch/api/subscribers/{subscriberId}/settings
Request samples
application/json
{
  • "settingName": "favoriteColor",
  • "settingValue": "red"
}
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

Adds/Updates the Subscriber Settings Information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
code
required
string
Enum: "verificationMode" "disableCallSettings" "favoriteColor" "reminderClock" "reminderSound" "subtitleSizeCode" "wasAlreadyInMedicationManagement" "buttonLabelFontSize" "voiceAudioLevel" "musicAudioLevel" "effectAudioLevel" "isNicknamePreferred" "userNickname" "IsVerificationSetupFinished" "completedUIIntroduction" "faeCompleted" "lastOpenedScreenName" "savedClothes" "reminderClockSetup" "IsFaceVerificationSetupFinished" "environmentName" "fontSize" "avatarName" "uiEffectAudioLevel" "selectedDecorations" "sleepModeStartTime" "sleepModeEndTime" "gameAudioLevel" "webcamDeviceName" "userNameType" "wakeWord"
value
required
string
Responses
200
post/api/subscribers/{subscriberId}/settings
Request samples
application/json
{
  • "code": "string",
  • "value": "string"
}
Response samples
application/json
{
  • "subscriberId": "7f97863c-e440-4ab2-b19c-38e4bb1e289f",
  • "organizationId": "3c26de96-df96-4a75-ba04-56e2ea63efbd",
  • "callName": "string",
  • "timezoneId": "string",
  • "locale": "string",
  • "activityDurationStart": "string",
  • "activityDurationEnd": "string",
  • "contactEmailAddress": "string@gmail.com",
  • "settings": [
    ],
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "nickName": "string",
  • "phoneNumber": "string",
  • "dateOfBirth": "string",
  • "faceUrl": "string",
  • "media": {
    },
  • "twilioVoipNumber": "string",
  • "rrmsXmitId": "string",
  • "preferredVoiceId": "75a7b58c-75ce-419c-a9b2-1318488add62"
}

Lists the Addison Subscriber Settings.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
get/api/subscribers/{subscriberId}/settings
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/settings' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Saving User's personal information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
field
required
string
Enum: "first-name" "last-name" "nick-name" "phone-number" "date-of-birth"
Request Body schema: application/json
value
required
string
Responses
200
post/api/subscribers/{subscriberId}/info
Request samples
application/json
{
  • "value": "string"
}
Response samples
application/json
{
  • "value": true
}

Gets the Subscriber personal information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
field
required
string
Enum: "first-name" "last-name" "nick-name" "phone-number" "date-of-birth"
Responses
200
get/api/subscribers/{subscriberId}/info
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/info?field=first-name' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": "string"
}

Update Subscriber's personal information

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/subscribers/{subscriberId}/info
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

Gets the Subscriber's media file url.

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
voiceId
string
Example: voiceId=dbd2bfd3-a177-4fe5-b294-876b75ae5797
Responses
200
get/api/subscribers/{subscriberId}/info/media
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/info/media?voiceId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "firstName": {
    },
  • "fullName": {
    },
  • "nickName": {
    }
}

Adds the Addison Subscriber's Verification Mode.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
mode
required
string
Default: "face-recognition"
Enum: "face-recognition" "pin-code"
Responses
200
post/api/subscribers/{subscriberId}/verification-modes
Request samples
application/json
{
  • "mode": "face-recognition"
}
Response samples
application/json
{
  • "value": true
}

Adds the Addison Subscriber's Disable Call Settings.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
value
required
string
Enum: "true" "false"
Responses
200
post/api/subscribers/{subscriberId}/disable-calls
Request samples
application/json
{
  • "value": "true"
}
Response samples
application/json
{
  • "value": true
}

ReSyncs the Addison Subscriber information from the Organizations API.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
post/api/subscribers/{subscriberId}/re-sync
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

ReSyncs All the Addison Subscribers information from the Organizations API.

Request
Security:
bearer
Responses
200
post/api/subscribers/re-sync
Request samples
curl -i -X POST \
  https://addison.ecg-api.com/api/subscribers/re-sync \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Generates the Master Key for all the Subscribers in the system.

Request
Security:
bearer
Responses
200
post/api/subscribers/master-keys
Request samples
curl -i -X POST \
  https://addison.ecg-api.com/api/subscribers/master-keys \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Generates the Master Key for the Given Subscriber if not Exists.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
post/api/subscribers/{subscriberId}/master-keys
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/master-keys' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

SubscriberConsoles

create Addison console record.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
hardwareIdentifier
required
string
deviceLabel
required
string
Responses
201
post/api/subscribers/{subscriberId}/addison-consoles
Request samples
application/json
{
  • "hardwareIdentifier": "098c16dc-e413-490f-b0b3-f1aca454fe62",
  • "deviceLabel": "string"
}
Response samples
application/json
{
  • "id": "cf4840e8-9145-4e87-b4d5-fe010d19fdfa",
  • "subscriberId": "2902aea4-35c2-463b-a82c-20f20bc009eb",
  • "hardwareIdentifier": "e4b142ae-0456-48d3-9408-37227a7b039e",
  • "deviceLabel": "string",
  • "provisionedAt": "timestamp without time zone",
  • "provisionedBy": "string",
  • "paired": "boolean",
  • "pairedAt": "timestamp without time zone",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Activate Addison console record.

Request
Security:
bearer
path Parameters
subscriberId
required
string
consoleId
required
string
Responses
200
post/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/activate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivate Addison console record.

Request
Security:
bearer
path Parameters
subscriberId
required
string
consoleId
required
string
Responses
200
post/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/deactivate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Archive Addison console record.

Request
Security:
bearer
path Parameters
subscriberId
required
string
consoleId
required
string
Responses
200
post/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/archive
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restore Addison console record.

Request
Security:
bearer
path Parameters
subscriberId
required
string
consoleId
required
string
Responses
200
post/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/restore
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/addison-consoles/{consoleId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Reset console pairing

Request
Security:
bearer
path Parameters
subscriberId
required
string
hardwareIdentifier
required
string
Responses
200
post/api/subscribers/{subscriberId}/addison-consoles/{hardwareIdentifier}/reset-pairing
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/addison-consoles/{hardwareIdentifier}/reset-pairing' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Heartbeats

Lists the Console Heartbeats for a given SubscriberId

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
hardwareIds
Array of strings
take
required
string
Default: 25
dateRangeType
required
string
Default: "custom"
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2025-02-28T02:11:15.905Z
to
string
Example: to=2025-02-28T02:11:15.905Z
Responses
200
get/api/subscribers/{subscriberId}/heartbeats
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/heartbeats?hardwareIds=string&take=25&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "dateRange": {
    },
  • "heartbeats": {
    }
}

SubscriberAccessCodes

Get the Subscriber Access Code.

Request
Security:
bearer
path Parameters
hardwareIdentifier
required
string
query Parameters
channel
string

Default value: email

Enum: "sms" "email"
Example: channel=email
Responses
200
get/api/addison-consoles/{hardwareIdentifier}/codes
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/addison-consoles/{hardwareIdentifier}/codes?channel=sms' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Verify Subscriber Access Code.

Request
Security:
bearer
path Parameters
hardwareIdentifier
required
string
Request Body schema: application/json
accessCode
required
string
Responses
200
post/api/addison-consoles/{hardwareIdentifier}/verify-access-code
Request samples
application/json
{
  • "accessCode": "000000"
}
Response samples
application/json
{
  • "value": true
}

UserInteractions

Adds the User Interaction Information.

Request
Security:
bearer
Request Body schema: application/json
subscriberId
required
string
hardwareIdentifier
required
string
action
required
string
Enum: "button.click" "voice.command"
actionTarget
required
string
Enum: "login-button" "login-command"
voiceCommandFile
string
actionAt
string <date-time>
Responses
201
post/api/user-interactions
Request samples
application/json
{
  • "subscriberId": "00024d5d-ba95-4921-a7f6-27f4273eb4a2",
  • "hardwareIdentifier": "4b3d2452-fd63-4ff0-b6ea-e36e33854b39",
  • "action": "button.click",
  • "actionTarget": "login-button",
  • "voiceCommandFile": "string",
  • "actionAt": "2025-02-28T02:11:16.613Z"
}
Response samples
application/json
{
  • "id": "c2f8d074-0203-4262-90d8-dff7d1cd6972",
  • "subscriberId": "861e2b39-fddd-496d-b937-bc57453f928d",
  • "hardwareIdentifier": "f7f656e6-6cbc-428d-9ea1-4b61ae304bc4",
  • "action": "string",
  • "actionTarget": "string",
  • "voiceCommandFile": "string",
  • "actionAt": "2025-02-28T02:11:16.612Z",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Biometrics

face-detection for given subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
faceData
required
string
Responses
200
post/api/subscribers/{subscriberId}/face-detection
Request samples
application/json
{
  • "faceData": "string"
}
Response samples
application/json
{
  • "value": true
}

Facial recognition for given subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
faceData
required
string
Responses
200
post/api/subscribers/{subscriberId}/face-recognition
Request samples
application/json
{
  • "faceData": "string"
}
Response samples
application/json
{
  • "value": true
}

Addison Face Detection Test

Request
Security:
bearer
Request Body schema: application/json
faceData
required
string
Responses
200
post/api/biometrics/face-detection
Request samples
application/json
{
  • "faceData": "string"
}
Response samples
application/json
{
  • "biometricId": "fa9f023b-c71b-4bd1-ad0f-55616a07ce8f"
}

Addison Face Recognition Test

Request
Security:
bearer
path Parameters
biometricId
required
string
Request Body schema: application/json
faceData
required
string
Responses
200
post/api/biometrics/{biometricId}/face-recognition
Request samples
application/json
{
  • "faceData": "string"
}
Response samples
application/json
{
  • "value": true
}

Health-check

Checks health of the server

Responses
200

The Health Check is successful

503

The Health Check is not successful

get/healthcheck
Request samples
curl -i -X GET \
  https://addison.ecg-api.com/healthcheck
Response samples
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

SeedData

List the hardware Identifiers

Request
Security:
bearer
Responses
200
get/api/seed-data/hardware-identifier
Request samples
curl -i -X GET \
  https://addison.ecg-api.com/api/seed-data/hardware-identifier \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
[
  • {
    }
]

List the Weather Forecast Information

Request
Security:
bearer
query Parameters
zipCode
required
string
Example: zipCode=94040
countryCode
required
string
Example: countryCode=US
unit
string
Default: "Kelvin"
Enum: "Kelvin" "Celsius" "Fahrenheit"
Responses
200
get/api/seed-data/weather
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/seed-data/weather?zipCode=string&countryCode=string&unit=Kelvin' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "city": "London",
  • "country": "GB",
  • "timezone": 0,
  • "sunrise": "2025-02-28T02:11:16.501Z",
  • "sunset": "2025-02-28T02:11:16.501Z",
  • "weather": [
    ],
  • "data": {
    }
}

List the Weather Forecast Information based on the co-ordinates

Request
Security:
bearer
query Parameters
lat
required
number

Latitude (if using coordinates)

Example: lat=40.7128
lon
required
number

Longitude (if using coordinates)

Example: lon=-74.006
unit
string
Default: "Kelvin"
Enum: "Kelvin" "Celsius" "Fahrenheit"
Responses
200
get/api/seed-data/weather/coordinates
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/seed-data/weather/coordinates?lat=0&lon=0&unit=Kelvin' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "city": "London",
  • "country": "GB",
  • "timezone": 0,
  • "sunrise": "2025-02-28T02:11:16.501Z",
  • "sunset": "2025-02-28T02:11:16.501Z",
  • "weather": [
    ],
  • "data": {
    }
}

List the User Settings.

https://ecg.atlassian.net/wiki/x/CgBQkg
Request
Security:
bearer
Responses
200
get/api/seed-data/settings
Request samples
curl -i -X GET \
  https://addison.ecg-api.com/api/seed-data/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

login

Enter the mobile Number.

Request
Security:
bearer
path Parameters
phoneNumber
required
string
Responses
200
get/api/login/username/{phoneNumber}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/login/username/{phoneNumber}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "userName": "xyz@company.com"
}

Terms of Use

Adds the Addison Subscriber's Terms of Use.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
201
post/api/subscribers/{subscriberId}/terms-of-use
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/terms-of-use' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Addison Subscriber's Terms of Use.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
get/api/subscribers/{subscriberId}/terms-of-use
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/terms-of-use' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "acceptedAt": "2025-02-28T02:11:16.578Z",
  • "subscriber": {
    }
}

Deletes the Addison Subscriber's Terms of Use.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
delete/api/subscribers/{subscriberId}/terms-of-use
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/terms-of-use' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

SubscriberPinCodes

Adds the Addison Subscriber's Pin Code.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
code
required
string
Responses
201
post/api/subscribers/{subscriberId}/pin-codes
Request samples
application/json
{
  • "code": "0000"
}
Response samples
application/json
{
  • "value": true
}

Updates the Addison Subscriber's Pin Code.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
code
required
string
Responses
200
patch/api/subscribers/{subscriberId}/pin-codes
Request samples
application/json
{
  • "code": "0000"
}
Response samples
application/json
{
  • "value": true
}

Gets the Addison Subscriber's Pin Code Status Information.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
get/api/subscribers/{subscriberId}/pin-codes
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/pin-codes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Verifies the Addison Subscriber's Pin Code.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
code
required
string
Responses
200
post/api/subscribers/{subscriberId}/pin-codes/verify
Request samples
application/json
{
  • "code": "0000"
}
Response samples
application/json
{
  • "value": true
}

Versions

Adds the Addison Software Version.

Request
Security:
bearer
Request Body schema: application/json
versionNumber
required
string
downloadLocation
required
string
availableAt
required
string <date-time>
releaseNotes
string
Responses
201
post/api/software-versions
Request samples
application/json
{
  • "versionNumber": "v1.1",
  • "downloadLocation": "https://something.com/v1.1",
  • "availableAt": "2025-02-28T02:11:16.519Z",
  • "releaseNotes": "contains HTML or Markdown of release notes"
}
Response samples
application/json
{
  • "id": "30e0d4f1-e503-4454-ac23-42f8e2571090",
  • "versionNumber": "v1.1",
  • "downloadLocation": "https://something.com/v1.1",
  • "availableAt": "2025-02-28T02:11:16.520Z",
  • "releaseNotes": "contains HTML or Markdown of release notes",
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Lists the Addison Software Version.

Request
Security:
bearer
query Parameters
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

search
Array of strings

Search By: versionNumbers

Responses
200
get/api/software-versions
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/software-versions?skip=0&take=10&search=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Addison Software Version.

Request
Security:
bearer
path Parameters
versionId
required
string
Responses
200
get/api/software-versions/{versionId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/software-versions/{versionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "30e0d4f1-e503-4454-ac23-42f8e2571090",
  • "versionNumber": "v1.1",
  • "downloadLocation": "https://something.com/v1.1",
  • "availableAt": "2025-02-28T02:11:16.520Z",
  • "releaseNotes": "contains HTML or Markdown of release notes",
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Deletes the Addison Software Version.

Request
Security:
bearer
path Parameters
versionId
required
string
Responses
200
delete/api/software-versions/{versionId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/software-versions/{versionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the Addison Software Version by updating the items.

Request
Security:
bearer
path Parameters
versionId
required
string
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/software-versions/{versionId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "30e0d4f1-e503-4454-ac23-42f8e2571090",
  • "versionNumber": "v1.1",
  • "downloadLocation": "https://something.com/v1.1",
  • "availableAt": "2025-02-28T02:11:16.520Z",
  • "releaseNotes": "contains HTML or Markdown of release notes",
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Activates the Addison Software Version information.

Request
Security:
bearer or bearer
path Parameters
versionId
required
string
Responses
200
post/api/software-versions/{versionId}/activate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/software-versions/{versionId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Addison Software Version information.

Request
Security:
bearer or bearer
path Parameters
versionId
required
string
Responses
200
post/api/software-versions/{versionId}/deactivate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/software-versions/{versionId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

UserCredentials

Gets the User Credentials by username.

Request
Security:
bearer
path Parameters
username
required
string
Example: ce837eaa-e340-4ae0-bfd3-4ea13874e973
Responses
200
get/api/downloads/user-credentials/{username}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/downloads/user-credentials/{username}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "username": "e204f957-2e2f-433d-a5d1-27fc2abe8dbd",
  • "passwordReference": "string",
  • "secretsManagerArn": "string",
  • "auditInfo": {
    }
}

Call-Logs

Adds the Call Log information for the given Subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
callDuration
required
string
dialedNumber
required
string
timeOfCall
required
string <date-time>
transcript
string
Responses
201
post/api/subscribers/{subscriberId}/call-logs
Request samples
application/json
{
  • "callDuration": "12:00:00",
  • "dialedNumber": "987654321",
  • "timeOfCall": "2025-02-28T02:11:15.709Z",
  • "transcript": "string"
}
Response samples
application/json
{
  • "id": "c4b5516f-f36c-432f-96ec-c3d435c61996",
  • "subscriber": "694aa2cd-1582-4066-8e80-24118fdce321",
  • "callDuration": "12:00:00",
  • "dialedNumber": "987654321",
  • "timeOfCall": "2025-02-28T02:11:15.710Z",
  • "transcript": "string",
  • "auditInfo": {
    }
}

Lists the Call Log information for the given Subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

dialedNumber
string
dateRangeType
string

Searches Based on timeOfCall

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>

Searches Based on timeOfCall

Example: from=2025-02-28T02:11:15.711Z
to
string <date-time>

Searches Based on timeOfCall

Example: to=2025-02-28T02:11:15.711Z
Responses
200
get/api/subscribers/{subscriberId}/call-logs
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/call-logs?order_by=ASC&skip=0&take=10&dialedNumber=string&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Device-Keys

Gets the Device Key Information based on the Hardware Identifier

Request
Security:
bearer
query Parameters
hardwareId
required
string
Example: hardwareId=13d1cbc8-5e5e-4794-98f4-82e37e59264a
deviceIdentifier
required
string
Example: deviceIdentifier=B42E9969B9B7
deviceIdentifierType
required
string
Value: "mac-address"
Responses
200
get/api/device-keys
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/device-keys?hardwareId=string&deviceIdentifier=string&deviceIdentifierType=mac-address' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "deviceKey": "57fea491-7960-4b5f-a9ac-5edb0a299295",
  • "auditInfo": {
    }
}

HelpCalls

Adds the Help Call Log information for a given Subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
organizationId
string
hardwareIdentifier
required
string
recordedAt
required
string <date-time>
Responses
200
post/api/subscribers/{subscriberId}/help-calls
Request samples
application/json
{
  • "organizationId": "d2a14920-c681-4c46-9854-8867c5273a27",
  • "hardwareIdentifier": "bc8c6f72-641c-4783-8035-af135cb63a09",
  • "recordedAt": "2025-02-28T02:11:16.257Z"
}
Response samples
application/json
{
  • "id": "6b9398cb-7fd2-4d49-948b-08f3a50bf877",
  • "subscriberId": "96e0d15f-6477-4e85-b402-cd80936c1ec8",
  • "organizationId": "9adf368e-a4eb-4938-a847-e1283ea3bce6",
  • "hardwareId": "eb98f3c0-7c65-4aca-95a8-110cd6eb0c12",
  • "createdAt": "2025-02-28T02:11:16.262Z",
  • "createdBy": "89d5327a-5d0a-4284-8f67-de40d8cee58c",
  • "rrmsRegion": "string",
  • "rrmsResponse": {
    },
  • "recordedAt": "2025-02-28T02:11:16.262Z"
}

This API serves the purpose of listing the Help Call Logs information based on the filters

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

organizationId
string
hardwareIdentifier
string
rrmsRegion
string
Enum: "east" "west"
dateRangeType
string

Searches Based on recordedAt (UTC Date-Time)

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string

Searches Based on recordedAt (UTC Date-Time)

Example: from=2025-02-28T02:11:15.711Z
to
string

Searches Based on recordedAt (UTC Date-Time)

Example: to=2025-02-28T02:11:15.711Z
Responses
200
get/api/subscribers/{subscriberId}/help-calls
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/help-calls?skip=0&take=10&organizationId=string&hardwareIdentifier=string&rrmsRegion=east&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Rrms-Regions

Lists the RRMS Regions.

Responses
200
get/rrms-regions
Request samples
curl -i -X GET \
  https://addison.ecg-api.com/rrms-regions
Response samples
application/json
null

This Dummy API serves the purpose of switching the RRMS Region's primary status, for testing purpose.

Request
Security:
bearer
Responses
200
post/rrms-regions/switch
Request samples
curl -i -X POST \
  https://addison.ecg-api.com/rrms-regions/switch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Rrms-Heartbeat-Activities

Adds the RRMS Heartbeat Activities and updates the Redis Cache if RRMS Region primary status has been changed.

Request
Security:
bearer
Responses
200
post/api/rrms-heartbeat-activities
Request samples
curl -i -X POST \
  https://addison.ecg-api.com/api/rrms-heartbeat-activities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

List the RRMS Heartbeat Activities for both RRMS Regions.

Request
Security:
bearer
query Parameters
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

region
string

Searches Based on RRMS Region type

Enum: "east" "west"
status
string

Searches Based on RRMS Status

Enum: "SUCCESS" "ERROR"
dateRangeType
string

Searches Based on timeOfCall

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string <date-time>

Searches Based on timeOfCall

Example: from=2025-02-28T02:11:15.711Z
to
string <date-time>

Searches Based on timeOfCall

Example: to=2025-02-28T02:11:15.711Z
Responses
200
get/api/rrms-heartbeat-activities
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/rrms-heartbeat-activities?skip=0&take=10&region=east&status=SUCCESS&dateRangeType=custom&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Voice-Profiles

The purpose of this API to add the voice profile options for each avatar.

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | API - ADD VOICE PROFILE OPTIONS
Request
Security:
bearer
Request Body schema: application/json
name
required
string

Addison Avatar name should be unique

language
required
string
pollyVoice
required
string
description
string
gender
required
string
Enum: "male" "female"
locale
required
string
Enum: "en-US" "de-DE" "es-US"
ssmlTag
string
isDefault
boolean
Responses
201
post/api/voice-profiles
Request samples
application/json
{
  • "name": "Ashton",
  • "language": "English, US",
  • "pollyVoice": "Salli",
  • "description": "description",
  • "gender": "male",
  • "locale": "en-US",
  • "ssmlTag": "<speak><prosody rate='+10%' pitch='+15%'>INSERT_TEXT_HERE</prosody></speak>",
  • "isDefault": false
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to list all the Voice Profiles in the paginated form

Permissions needed - setup.data.read,ecg-api-key

Visit the confluence story for more information - AVA | API - LIST VOICE PROFILE OPTIONS
Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Searches on the basis of voice-profile Name and Description

gender
string
Enum: "male" "female"
locale
Array of strings
Items Enum: "en-US" "de-DE" "es-US"
Responses
200
get/api/voice-profiles
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/voice-profiles?order_by=ASC&skip=0&take=10&searchTerm=string&gender=male&locale=en-US' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API to update the voice profile options for each avatar.

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | API - UPDATE VOICE PROFILE OPTIONS
Request
Security:
bearer
path Parameters
voiceId
required
string
Example: dbd2bfd3-a177-4fe5-b294-876b75ae5797
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/voice-profiles/{voiceId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to get the Voice Profile Option

Permissions needed - setup.data.read,ecg-api-key

Visit the confluence story for more information - AVA | GET VOICE PROFILE OPTIONS
Request
Security:
bearer
path Parameters
voiceId
required
string
Example: dbd2bfd3-a177-4fe5-b294-876b75ae5797
Responses
200
get/api/voice-profiles/{voiceId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/voice-profiles/{voiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "a6444070-4c2d-4d2d-a4e0-f1eefa27a166",
  • "name": "Ashton",
  • "language": "English, US",
  • "pollyVoice": "Salli",
  • "description": "description",
  • "gender": "male",
  • "locale": "en-US",
  • "ssmlTag": "<speak><prosody rate='+10%' pitch='+15%'>INSERT_TEXT_HERE</prosody></speak>",
  • "isDefault": false,
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

The purpose of this API is to activate the Voice Profile Option

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | ACTIVATE VOICE PROFILE OPTIONS
Request
Security:
bearer
path Parameters
voiceId
required
string
Example: dbd2bfd3-a177-4fe5-b294-876b75ae5797
Responses
200
post/api/voice-profiles/{voiceId}/activate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/voice-profiles/{voiceId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to deactivate the Voice Profile Option

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | DEACTIVATE VOICE PROFILE OPTIONS
Request
Security:
bearer
path Parameters
voiceId
required
string
Example: dbd2bfd3-a177-4fe5-b294-876b75ae5797
Responses
200
post/api/voice-profiles/{voiceId}/deactivate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/voice-profiles/{voiceId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to re-sync the Voice Profile Option to all the different micro-services using the SNS

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | RE-SYNC VOICE PROFILE OPTIONS
Request
Security:
bearer
path Parameters
voiceId
required
string
Example: dbd2bfd3-a177-4fe5-b294-876b75ae5797
Responses
200
post/api/voice-profiles/{voiceId}/re-sync
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/voice-profiles/{voiceId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to re-sync ALL the Voice Profile Option to all the different micro-services using the SNS

Permissions needed - setup.data.admin

Visit the confluence story for more information - AVA | RE-SYNC ALL VOICE PROFILE OPTIONS
Request
Security:
bearer
Responses
200
post/api/voice-profiles/re-sync
Request samples
curl -i -X POST \
  https://addison.ecg-api.com/api/voice-profiles/re-sync \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Organization Service Settings

The API is designed to facilitate the addition of service settings information for an organization

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | API - ADD Organization Service Settings
Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
status
required
string
Default: "disabled"
  status: enabled indicates "enabled",
  status: disabled indicates "disabled"
Responses
201
post/api/organizations/{organizationId}/service-settings
Request samples
application/json
{
  • "status": "disabled"
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to get the service settings information for a given organization

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | API - GET Program Service for an Organization
Request
Security:
bearer
path Parameters
organizationId
required
string
Responses
200
get/api/organizations/{organizationId}/service-settings
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/service-settings' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "status": "enabled",
  • "auditInfo": {
    }
}

The purpose of this API is to update the service settings information for a given organization

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | API - UPDATE Service Settings for an Organization
Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/service-settings
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

Subscriber Service Request

The purpose of this API to add the Subscriber Service Request for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
Request Body schema: application/json
serviceId
required
string
notes
string
serviceRequestDate
string <date-time>
Responses
201
post/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests
Request samples
application/json
{
  • "serviceId": "356bd29b-5ecc-4c6c-90b2-8d9035a4fa80",
  • "notes": "string",
  • "serviceRequestDate": "2025-02-28T02:11:16.560Z"
}
Response samples
application/json
{
  • "id": "26c82f1f-9f2e-4a23-bd04-866540e22c9b",
  • "subscriber": {
    },
  • "organizationId": "ab9a5f73-9105-4565-9bf9-4649a0013e1a",
  • "programService": {
    },
  • "status": "new",
  • "notes": "string",
  • "serviceRequestDate": "2025-02-28T02:11:16.562Z",
  • "serviceCompletedDate": "2025-02-28T02:11:16.562Z",
  • "messageDeliveryInfo": [
    ],
  • "activeInfo": {
    },
  • "auditInfo": {
    }
}

The purpose of this API to list all Subscriber Service Requests for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search on the basis of title, code and description of program service

include
Array of strings
Items Enum: "subscriber" "program-service" "service-delivery-rule"
Responses
200
get/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests?order_by=ASC&skip=0&take=10&searchTerm=string&include=subscriber' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API to list all Subscriber Service Requests for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: eb7c4d9b-e729-4755-8d9c-3644e10a6e78
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search on the basis of title, code and description of program service

include
Array of strings
Items Enum: "subscriber" "program-service" "service-delivery-rule"
subscriberIds
Array of strings
Example: subscriberIds=d879185d-f7e3-45ff-8e93-4334b5632e8a
Responses
200
get/api/organizations/{organizationId}/service-requests
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/service-requests?order_by=ASC&skip=0&take=10&searchTerm=string&include=subscriber&subscriberIds=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API is to get the information for subscriber service request by Id

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
requestId
required
string
Example: 90c955d4-a267-4c77-92e9-79a23e28d6ba
query Parameters
include
Array of strings
Items Enum: "subscriber" "program-service" "service-delivery-rule"
Responses
200
get/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}?include=subscriber' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "26c82f1f-9f2e-4a23-bd04-866540e22c9b",
  • "subscriber": {
    },
  • "organizationId": "ab9a5f73-9105-4565-9bf9-4649a0013e1a",
  • "programService": {
    },
  • "status": "new",
  • "notes": "string",
  • "serviceRequestDate": "2025-02-28T02:11:16.562Z",
  • "serviceCompletedDate": "2025-02-28T02:11:16.562Z",
  • "messageDeliveryInfo": [
    ],
  • "activeInfo": {
    },
  • "auditInfo": {
    }
}

The purpose of this API to update the Subscriber Service Request for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
requestId
required
string
Example: 90c955d4-a267-4c77-92e9-79a23e28d6ba
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

The purpose of this API to resync the Subscriber Service Request for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
requestId
required
string
Example: 90c955d4-a267-4c77-92e9-79a23e28d6ba
Responses
200
post/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/re-sync
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/re-sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to activate the Subscriber Service Request for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
requestId
required
string
Example: 90c955d4-a267-4c77-92e9-79a23e28d6ba
Responses
200
post/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/activate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to deactivate the Subscriber Service Request for an Organization.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - ADDISRV | Subscriber Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: 878629a4-2a52-43a4-8a27-cd15b300316f
subscriberId
required
string
Example: d85a4c1e-568c-415a-a63c-24cb942b2908
requestId
required
string
Example: 90c955d4-a267-4c77-92e9-79a23e28d6ba
Responses
200
post/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/deactivate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Program-Services

The purpose of this API to add the program service information for an Organization.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
required
Array of objects (AddProgramServiceDto)
Responses
201
post/api/organizations/{organizationId}/program-services
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
null

The purpose of this API to list all program services for an Organization.

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Searches the text based on the “title”, “code“, “description”

locale
string

Retrieves translated text based on the provided locale in the query parameter. If the locale is not specified, it defaults to locale set while adding program service

Enum: "en-US" "de-DE" "es-US"
include
Array of strings
Items Value: "service-delivery-rules"
Responses
200
get/api/organizations/{organizationId}/program-services
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services?order_by=ASC&skip=0&take=10&searchTerm=string&locale=en-US&include=service-delivery-rules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API is to add the program service translation information for an Organization based on the locale.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Request Body schema: application/json
required
Array of objects (ProgramServiceTranslationDto)
Responses
200
post/api/organizations/{organizationId}/program-services/{serviceId}/translations
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to update the program service translation information for an Organization based on the locale.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Request Body schema: application/json
title
required
string
description
string
locale
required
string
Default: "en-US"
Enum: "en-US" "de-DE" "es-US"
Responses
200
patch/api/organizations/{organizationId}/program-services/{serviceId}/translations
Request samples
application/json
{
  • "title": "title",
  • "description": "description",
  • "locale": "en-US"
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API to get program service by id for an Organization.

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
query Parameters
include
Array of strings
Items Value: "service-delivery-rules"
Responses
200
get/api/organizations/{organizationId}/program-services/{serviceId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}?include=service-delivery-rules' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "82413b30-1efa-43fa-a8e4-6447fa67cb9c",
  • "organizationId": "12e92bb4-1aae-4dc7-9576-3b30ed54f5a1",
  • "title": "title",
  • "description": "description",
  • "code": "code",
  • "locale": "en-US",
  • "media": [
    ],
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "serviceDeliveryRules": [
    ]
}

The purpose of this API to delete the program service for an Organization.

Permissions needed - organizations.admin

Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Responses
200
delete/api/organizations/{organizationId}/program-services/{serviceId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to update the program service for an Organization.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/program-services/{serviceId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

The purpose of this API to activate the program service for an Organization.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Responses
200
post/api/organizations/{organizationId}/program-services/{serviceId}/activate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to deactivate the program service for an Organization.

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
Responses
200
post/api/organizations/{organizationId}/program-services/{serviceId}/deactivate
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

The purpose of this API to preview program service by id for an Organization.

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | Program Service API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
serviceId
required
string
query Parameters
voiceId
string
Example: voiceId=f604b6cb-0438-4660-972c-2765cb60d057
locale
string

Retrieves media preview on the provided locale in the query parameter. If the locale is not specified, it defaults to locale set while adding program service

Enum: "en-US" "de-DE" "es-US"
Responses
200
post/api/organizations/{organizationId}/program-services/{serviceId}/preview
Request samples
curl -i -X POST \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/preview?voiceId=string&locale=en-US' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "locale": "en-US",
  • "audioUrl": "string",
  • "ssmlUrl": "string",
  • "voiceId": "string"
}

Service Delivery Rules

The API is designed to facilitate the addition of service delivery rule information

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Service Delivery Rules API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: e453c95b-da87-4a4e-b310-6ea8e47cb162
serviceId
required
string
Example: 43a88fb5-21d2-4aa7-9ec5-df1026372b40
Request Body schema: application/json
deliveryType
required
string
Value: "email"
required
object (EmailSettingDto)
Responses
201
post/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules
Request samples
application/json
{
  • "deliveryType": "email",
  • "emailSetting": {
    }
}
Response samples
application/json
{
  • "id": "75df3397-fc1a-4abb-9142-8ac044a34432",
  • "serviceId": "d67fa457-d7f0-4ab1-8c24-22b89d575dbb",
  • "deliveryType": "email",
  • "emailSetting": {
    },
  • "smsSetting": { },
  • "auditInfo": {
    }
}

The purpose of this API is to list the information for service delivery rules.

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | Service Delivery Rules API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: e453c95b-da87-4a4e-b310-6ea8e47cb162
serviceId
required
string
Example: 43a88fb5-21d2-4aa7-9ec5-df1026372b40
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

deliveryType
string
Value: "email"
Responses
200
get/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules?order_by=ASC&skip=0&take=10&deliveryType=email' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API is to get the service delivery rule information

Permissions needed - organizations.read

Visit the confluence story for more information - ADDISRV | Service Delivery Rules API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: e453c95b-da87-4a4e-b310-6ea8e47cb162
serviceId
required
string
Example: 43a88fb5-21d2-4aa7-9ec5-df1026372b40
deliveryId
required
string
Example: d7e49e27-4b48-45d7-b7e9-b1673892c473
Responses
200
get/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "75df3397-fc1a-4abb-9142-8ac044a34432",
  • "serviceId": "d67fa457-d7f0-4ab1-8c24-22b89d575dbb",
  • "deliveryType": "email",
  • "emailSetting": {
    },
  • "smsSetting": { },
  • "auditInfo": {
    }
}

The API is designed to to update the service delivery rule information

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Service Delivery Rules API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: e453c95b-da87-4a4e-b310-6ea8e47cb162
serviceId
required
string
Example: 43a88fb5-21d2-4aa7-9ec5-df1026372b40
deliveryId
required
string
Example: d7e49e27-4b48-45d7-b7e9-b1673892c473
Request Body schema: application/json
Array
required
string or null or number or boolean or object or (Array of strings or numbers or booleans)
path
required
string
op
required
string
Enum: "replace" "add" "remove"
Responses
200
patch/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

The API is designed to facilitate the deletion of service delivery rule information

Permissions needed - organizations.admin

Visit the confluence story for more information - ADDISRV | Service Delivery Rules API Specifications
Request
Security:
bearer
path Parameters
organizationId
required
string
Example: e453c95b-da87-4a4e-b310-6ea8e47cb162
serviceId
required
string
Example: 43a88fb5-21d2-4aa7-9ec5-df1026372b40
deliveryId
required
string
Example: d7e49e27-4b48-45d7-b7e9-b1673892c473
Responses
200
delete/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

AI-Prompts

The purpose of this API is to return a system prompt based on the provided prompt code, personalized with the users nickname or first name.

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - AI PROMPT | AI Prompt API Specifications
Request
Security:
bearer
path Parameters
promptCode
required
string
Example: general-chat
query Parameters
subscriberId
string
Example: subscriberId=string
Responses
200
get/api/ai-prompts/{promptCode}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/ai-prompts/{promptCode}?subscriberId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": "string",
  • "id": "504c3f4a-2801-4747-a678-a3a58a2ce426",
  • "promptCode": "general-chat",
  • "promptText": "string",
  • "auditInfo": {
    }
}

The purpose of this API is to update the ai prompt based on the prompt code

Permissions needed - setup.data.admin

Visit the confluence story for more information - AI PROMPT | AI Prompt API Specifications
Request
Security:
bearer
path Parameters
promptCode
required
string
Example: general-chat
Request Body schema: application/json
promptText
required
string
Responses
200
patch/api/ai-prompts/{promptCode}
Request samples
application/json
{
  • "promptText": "string"
}
Response samples
application/json
{
  • "value": true
}

The purpose of this API is to add the ai prompt based in the system

Permissions needed - setup.data.admin

Visit the confluence story for more information - AI PROMPT | AI Prompt API Specifications
Request
Security:
bearer
Request Body schema: application/json
promptCode
required
string
promptText
required
string
Responses
201
post/api/ai-prompts
Request samples
application/json
{
  • "promptCode": "general-chat",
  • "promptText": "string"
}
Response samples
application/json
{
  • "value": true
}

Reward-Collections

The purpose of this API is to add a new Reward Collection

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - PART | Reward Collection API Specifications
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
Request Body schema: application/json
required
Array of objects (AddRewardCollectionDto)
Responses
201
post/api/subscribers/{subscriberId}/reward-collections
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
null

The purpose of this API is to view all Reward Collections

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Reward Collections
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

include
Array of strings
Items Value: "reward-category"
searchTerm
string

Search By: Reward Name

rewardCategoryIds
Array of strings
Example: rewardCategoryIds=7caabed8-bd87-4f5c-8258-0e25d7f29dec
dateRangeType
string
Default: "custom"

Based on "Claimed At"

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2025-02-28T02:11:16.787Z
to
string
Example: to=2025-02-28T02:11:16.787Z
Responses
200
get/api/subscribers/{subscriberId}/reward-collections
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/reward-collections?order_by=ASC&skip=0&take=10&include=reward-category&searchTerm=string&rewardCategoryIds=string&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

This API will delete the Reward Collection.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - PART | Reward Collection API Specifications
Request
Security:
bearer
path Parameters
rewardCollectionId
required
string
Example: 1b22b552-2ed8-481f-92de-9aab4198510b
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
Responses
200
delete/api/subscribers/{subscriberId}/reward-collections/{rewardCollectionId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/reward-collections/{rewardCollectionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Event Point Mappings

This API will get the Event Point Mapping details

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Event Point Mapping API Specifications
Request
Security:
bearer
path Parameters
eventId
required
string
Example: 3e1296f0-2506-4f03-bfe6-b74f627c3dc8
Responses
200
get/api/event-points/{eventId}
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/event-points/{eventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "6243f6f0-3433-4d56-8daa-23a9f2f7d978",
  • "name": "string",
  • "code": "string",
  • "points": 40,
  • "auditInfo": {
    }
}

The purpose of this API is to view all Event Point Logs

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Event Point Logs
Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: title or code

Responses
200
get/api/event-points
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/event-points?order_by=ASC&skip=0&take=10&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Reward Categories

The purpose of this API is to view Reward Categories

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Reward Category
Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

searchTerm
string

Search By: title, code

Responses
200
get/api/reward-categories
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/reward-categories?order_by=ASC&skip=0&take=10&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Subscriber Event Audits

The purpose of this API is to add a new Subscriber Event Audit

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - PART | Subscriber Event Audit API Specifications
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
Request Body schema: application/json
required
Array of objects (AddSubscriberEventAuditDto)
Responses
201
post/api/subscribers/{subscriberId}/event-audits
Request samples
application/json
{
  • "items": [
    ]
}
Response samples
application/json
null

The purpose of this API is to view all Subscriber Event Audit Mappings

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Subscriber Event Audit
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

include
Array of strings
Items Value: "event-id"
eventId
string

Search By: eventIds

dateRangeType
string
Default: "custom"
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2025-02-28T02:11:16.828Z
to
string
Example: to=2025-02-28T02:11:16.828Z
Responses
200
get/api/subscribers/{subscriberId}/event-audits
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/event-audits?order_by=ASC&skip=0&take=10&include=event-id&eventId=string&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

This API will delete the Subscriber Event Audit.

Permissions needed - subscribers.phi.admin

Visit the confluence story for more information - PART | Subscriber Event Audit API Specifications
Request
Security:
bearer
path Parameters
subscriberEventAuditId
required
string
Example: 329b228d-e563-499c-a72a-63155bbc095c
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
Responses
200
delete/api/subscribers/{subscriberId}/event-audits/{subscriberEventAuditId}
Request samples
curl -i -X DELETE \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/event-audits/{subscriberEventAuditId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Reward Pools

The purpose of this API is to view Reward Pools

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Reward Pool
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
number
Default: 0

Number of Pages to skip, Default value : 0

take
number
Default: 10

Number of Records per page, Default value : 10

rewardCategoryIds
Array of strings
Example: rewardCategoryIds=5f4d032e-630e-4019-aae4-8ff40d25ef1d
include
Array of strings
Items Value: "reward-category"
dateRangeType
string
Default: "custom"
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2025-02-28T02:11:16.792Z
to
string
Example: to=2025-02-28T02:11:16.792Z
searchTerm
string

Search By: Reward Category title or code

Responses
200
get/api/subscribers/{subscriberId}/reward-pools
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/reward-pools?order_by=ASC&skip=0&take=10&rewardCategoryIds=string&include=reward-category&dateRangeType=custom&from=string&to=string&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

The purpose of this API is to view Reward Pool Statistics data for a given Subscriber.

Permissions needed - subscribers.phi.read

Visit the confluence story for more information - PART | Reward Pool
Request
Security:
bearer
path Parameters
subscriberId
required
string
Example: 1073bc88-0edc-4f37-a4db-d58296f49c0d
Responses
200
get/api/subscribers/{subscriberId}/reward-pools/statistics
Request samples
curl -i -X GET \
  'https://addison.ecg-api.com/api/subscribers/{subscriberId}/reward-pools/statistics' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null