# ECG Addison Module API Documentation for addison module Version: 1.0 ## Servers ``` https://addison.ecg-api.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [ECG Addison Module API](https://ecg-api-documentation.redocly.app/_bundle/products/addison/apis/addison.yaml) ## Subscribers ### Adds the Subscriber. - [POST /api/subscribers](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_create.md) ### Lists all the available Subscribers. - [GET /api/subscribers](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_getall.md) ### Gets the Subscriber information. - [GET /api/subscribers/{subscriberId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_getbyid.md) ### Deletes the Subscriber information. - [DELETE /api/subscribers/{subscriberId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_deletebyid.md) ### Patches the Subscriber information by updating the items they were provided. - [PATCH /api/subscribers/{subscriberId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_updatesubscriberbyid.md) ### Save user color choices - [POST /api/subscribers/{subscriberId}/favorite-color](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_addfavoritecolor.md) ### update/append subscriber settings information - [PATCH /api/subscribers/{subscriberId}/settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_updatesubscribersettings.md) ### Adds/Updates the Subscriber Settings Information. - [POST /api/subscribers/{subscriberId}/settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_subscribersettings.md) ### Lists the Addison Subscriber Settings. - [GET /api/subscribers/{subscriberId}/settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_listsettings.md) ### Batch update subscriber settings using JSON Patch format - For ADDI use - [PATCH /api/subscribers/{subscriberId}/batch-settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_batchupdatesubscribersettings.md) ### Saving User's personal information. - [POST /api/subscribers/{subscriberId}/info](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_saveinfo.md) ### Gets the Subscriber personal information. - [GET /api/subscribers/{subscriberId}/info](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_getinfo.md) ### Update Subscriber's personal information - [PATCH /api/subscribers/{subscriberId}/info](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_patchinfo.md) ### Gets the Subscriber's media file url. - [GET /api/subscribers/{subscriberId}/info/media](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_getinfomedia.md) ### Adds the Addison Subscriber's Verification Mode. - [POST /api/subscribers/{subscriberId}/verification-modes](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_addverificationmode.md) ### Adds the Addison Subscriber's Disable Call Settings. - [POST /api/subscribers/{subscriberId}/disable-calls](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_adddisablecalls.md) ### ReSyncs the Addison Subscriber information from the Organizations API. - [POST /api/subscribers/{subscriberId}/re-sync](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_resyncsubscriber.md) ### ReSyncs All the Addison Subscribers information from the Organizations API. - [POST /api/subscribers/re-sync](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_resyncall.md) ### Generates the Master Key for all the Subscribers in the system. - [POST /api/subscribers/master-keys](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_generatemasterkeyforall.md) ### Generates the Master Key for the Given Subscriber if not Exists. - [POST /api/subscribers/{subscriberId}/master-keys](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscribers/subscriberscontroller_generatemasterkey.md) ## SubscriberConsoles ### create Addison console record. - [POST /api/subscribers/{subscriberId}/addison-consoles](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_createsubscriberconsole.md) ### Activate Addison console record. - [POST /api/subscribers/{subscriberId}/addison-consoles/{consoleId}/activate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_activateaddisonconsole.md) ### Deactivate Addison console record. - [POST /api/subscribers/{subscriberId}/addison-consoles/{consoleId}/deactivate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_deactivateaddisonconsole.md) ### Archive Addison console record. - [POST /api/subscribers/{subscriberId}/addison-consoles/{consoleId}/archive](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_archiveaddisonconsole.md) ### Restore Addison console record. - [POST /api/subscribers/{subscriberId}/addison-consoles/{consoleId}/restore](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_restoreaddisonconsole.md) ### Reset console pairing - [POST /api/subscribers/{subscriberId}/addison-consoles/{hardwareIdentifier}/reset-pairing](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberconsoles/subscriberconsolescontroller_resetpairing.md) ## Heartbeats ### Lists the Console Heartbeats for a given SubscriberId - [GET /api/subscribers/{subscriberId}/heartbeats](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/heartbeats/consoleheartbeatscontroller_listheartbeats.md) ## SubscriberAccessCodes ### Get the Subscriber Access Code. - [GET /api/addison-consoles/{hardwareIdentifier}/codes](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberaccesscodes/subscriberaccesscodescontroller_createaccesscode.md) ### Verify Subscriber Access Code. - [POST /api/addison-consoles/{hardwareIdentifier}/verify-access-code](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberaccesscodes/subscriberaccesscodescontroller_verifyaccesscode.md) ## UserInteractions ### Adds the User Interaction Information. - [POST /api/user-interactions](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/userinteractions/userinteractioncontroller_create.md) ## Biometrics ### face-detection for given subscriber - [POST /api/subscribers/{subscriberId}/face-detection](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/biometrics/biometricscontroller_facedetectionforsubscriber.md) ### Facial recognition for given subscriber. - [POST /api/subscribers/{subscriberId}/face-recognition](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/biometrics/biometricscontroller_facerecognitionforsubscriber.md) ### Addison Face Detection Test - [POST /api/biometrics/face-detection](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/biometrics/biometricscontroller_facedetection.md) ### Addison Face Recognition Test - [POST /api/biometrics/{biometricId}/face-recognition](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/biometrics/biometricscontroller_facerecognition.md) ## Health-check ### Checks health of the server - [GET /healthcheck](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/health-check/healthcheckcontroller_check.md) ## SeedData ### List the hardware Identifiers - [GET /api/seed-data/hardware-identifier](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/seeddata/seeddatacontroller_getorganizationtypes.md) ### List the Weather Forecast Information - [GET /api/seed-data/weather](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/seeddata/seeddatacontroller_gethourlyforecast.md) ### List the Weather Forecast Information based on the co-ordinates - [GET /api/seed-data/weather/coordinates](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/seeddata/seeddatacontroller_getweathercoordinates.md) ### List the User Settings. - [GET /api/seed-data/settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/seeddata/seeddatacontroller_listusersettings.md) ## login ### Enter the mobile Number. - [GET /api/login/username/{phoneNumber}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/login/logincontroller_loginrequest.md) ## Terms of Use ### Adds the Addison Subscriber's Terms of Use. - [POST /api/subscribers/{subscriberId}/terms-of-use](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/terms-of-use/subscribertoucontroller_create.md) ### Gets the Addison Subscriber's Terms of Use. - [GET /api/subscribers/{subscriberId}/terms-of-use](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/terms-of-use/subscribertoucontroller_gettermsofuse.md) ### Deletes the Addison Subscriber's Terms of Use. - [DELETE /api/subscribers/{subscriberId}/terms-of-use](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/terms-of-use/subscribertoucontroller_deletetermsofuse.md) ## SubscriberPinCodes ### Adds the Addison Subscriber's Pin Code. - [POST /api/subscribers/{subscriberId}/pin-codes](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberpincodes/subscriberpincodecontroller_create.md) ### Updates the Addison Subscriber's Pin Code. - [PATCH /api/subscribers/{subscriberId}/pin-codes](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberpincodes/subscriberpincodecontroller_update.md) ### Gets the Addison Subscriber's Pin Code Status Information. - [GET /api/subscribers/{subscriberId}/pin-codes](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberpincodes/subscriberpincodecontroller_getpincodestatus.md) ### Verifies the Addison Subscriber's Pin Code. - [POST /api/subscribers/{subscriberId}/pin-codes/verify](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriberpincodes/subscriberpincodecontroller_verifycode.md) ## Versions ### Adds the Addison Software Version. - [POST /api/software-versions](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_addversions.md) ### Lists the Addison Software Version. - [GET /api/software-versions](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_listversions.md) ### Gets the Addison Software Version. - [GET /api/software-versions/{versionId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_getversions.md) ### Deletes the Addison Software Version. - [DELETE /api/software-versions/{versionId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_deleteversions.md) ### Patches the Addison Software Version by updating the items. - [PATCH /api/software-versions/{versionId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_updateversions.md) ### Activates the Addison Software Version information. - [POST /api/software-versions/{versionId}/activate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_activate.md) ### Deactivates the Addison Software Version information. - [POST /api/software-versions/{versionId}/deactivate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/versions/softwareversionscontroller_deactivate.md) ## UserCredentials ### Gets the User Credentials by username. - [GET /api/downloads/user-credentials/{username}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/usercredentials/usercredentialscontroller_getcredentials.md) ## Call-Logs ### Adds the Call Log information for the given Subscriber. - [POST /api/subscribers/{subscriberId}/call-logs](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/call-logs/calllogcontroller_create.md) ### Lists the Call Log information for the given Subscriber. - [GET /api/subscribers/{subscriberId}/call-logs](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/call-logs/calllogcontroller_list.md) ## Device-Keys ### Gets the Device Key Information based on the Hardware Identifier - [GET /api/device-keys](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/device-keys/devicekeycontroller_getdevicekey.md) ## HelpCalls ### Adds the Help Call Log information for a given Subscriber. - [POST /api/subscribers/{subscriberId}/help-calls](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/helpcalls/helpcalllogscontroller_addhelpcalllog.md) ### This API serves the purpose of listing the Help Call Logs information based on the filters - [GET /api/subscribers/{subscriberId}/help-calls](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/helpcalls/helpcalllogscontroller_listhelpcalllogs.md) ## Rrms-Regions ### Lists the RRMS Regions. - [GET /rrms-regions](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/rrms-regions/rrmsregioncontroller_getversions.md) ### This Dummy API serves the purpose of switching the RRMS Region's primary status, for testing purpose. - [POST /rrms-regions/switch](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/rrms-regions/rrmsregioncontroller_switchregion.md) ## Rrms-Heartbeat-Activities ### Adds the RRMS Heartbeat Activities and updates the Redis Cache if RRMS Region primary status has been changed. - [POST /api/rrms-heartbeat-activities](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/rrms-heartbeat-activities/rrmsheartbeatactivitycontroller_addrrmsheartbeatactivity.md) ### List the RRMS Heartbeat Activities for both RRMS Regions. - [GET /api/rrms-heartbeat-activities](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/rrms-heartbeat-activities/rrmsheartbeatactivitycontroller_listrrmsheartbeatactivities.md) ## Voice-Profiles ### The purpose of this API to add the voice profile options for each avatar. - [POST /api/voice-profiles](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_savevoiceprofile.md): Permissions needed - setup.data.admin ### The purpose of this API is to list all the Voice Profiles in the paginated form - [GET /api/voice-profiles](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_listvoiceprofiles.md): Permissions needed - setup.data.read,ecg-api-key ### The purpose of this API to update the voice profile options for each avatar. - [PATCH /api/voice-profiles/{voiceId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_updatevoiceprofile.md): Permissions needed - setup.data.admin ### The purpose of this API is to get the Voice Profile Option - [GET /api/voice-profiles/{voiceId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_getvoiceprofile.md): Permissions needed - setup.data.read,ecg-api-key ### The purpose of this API is to activate the Voice Profile Option - [POST /api/voice-profiles/{voiceId}/activate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_activatevoiceprofile.md): Permissions needed - setup.data.admin ### The purpose of this API is to deactivate the Voice Profile Option - [POST /api/voice-profiles/{voiceId}/deactivate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_deactivatevoiceprofile.md): Permissions needed - setup.data.admin ### The purpose of this API is to re-sync the Voice Profile Option to all the different micro-services using the SNS - [POST /api/voice-profiles/{voiceId}/re-sync](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_resyncvoiceprofile.md): Permissions needed - setup.data.admin ### The purpose of this API is to re-sync ALL the Voice Profile Option to all the different micro-services using the SNS - [POST /api/voice-profiles/re-sync](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/voice-profiles/voiceprofilecontroller_resyncallvoiceprofile.md): Permissions needed - setup.data.admin ## Organization Service Settings ### The API is designed to facilitate the addition of service settings information for an organization - [POST /api/organizations/{organizationId}/service-settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/organization-service-settings/organizationservicesettingcontroller_create.md): Permissions needed - organizations.admin ### The purpose of this API is to get the service settings information for a given organization - [GET /api/organizations/{organizationId}/service-settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/organization-service-settings/organizationservicesettingcontroller_get.md): Permissions needed - organizations.read ### The purpose of this API is to update the service settings information for a given organization - [PATCH /api/organizations/{organizationId}/service-settings](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/organization-service-settings/organizationservicesettingcontroller_update.md): Permissions needed - organizations.admin ## Subscriber Service Request ### The purpose of this API to add the Subscriber Service Request for an Organization. - [POST /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_create.md): Permissions needed - subscribers.phi.admin ### The purpose of this API to list all Subscriber Service Requests for an Organization. - [GET /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_list.md): Permissions needed - subscribers.phi.admin ### The purpose of this API to list all Subscriber Service Requests for an Organization. - [GET /api/organizations/{organizationId}/service-requests](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_listrequests.md): Permissions needed - subscribers.phi.admin ### The purpose of this API is to get the information for subscriber service request by Id - [GET /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_getbyid.md): Permissions needed - subscribers.phi.read ### The purpose of this API to update the Subscriber Service Request for an Organization. - [PATCH /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_update.md): Permissions needed - subscribers.phi.admin ### The purpose of this API to resync the Subscriber Service Request for an Organization. - [POST /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/re-sync](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_resync.md): Permissions needed - subscribers.phi.admin ### The purpose of this API to activate the Subscriber Service Request for an Organization. - [POST /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/activate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_activate.md): Permissions needed - subscribers.phi.admin ### The purpose of this API to deactivate the Subscriber Service Request for an Organization. - [POST /api/organizations/{organizationId}/subscribers/{subscriberId}/service-requests/{requestId}/deactivate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-service-request/subscriberservicerequestcontroller_deactivate.md): Permissions needed - subscribers.phi.admin ## Program-Services ### The purpose of this API to add the program service information for an Organization. - [POST /api/organizations/{organizationId}/program-services](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_addprogramservice.md): Permissions needed - organizations.admin ### The purpose of this API to list all program services for an Organization. - [GET /api/organizations/{organizationId}/program-services](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_listprogramservices.md): Permissions needed - organizations.read ### The purpose of this API is to add the program service translation information for an Organization based on the locale. - [POST /api/organizations/{organizationId}/program-services/{serviceId}/translations](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_addprogramservicetranslation.md): Permissions needed - organizations.admin ### The purpose of this API is to update the program service translation information for an Organization based on the locale. - [PATCH /api/organizations/{organizationId}/program-services/{serviceId}/translations](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_updateprogramservicetranslation.md): Permissions needed - organizations.admin ### The purpose of this API to get program service by id for an Organization. - [GET /api/organizations/{organizationId}/program-services/{serviceId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_getbyid.md): Permissions needed - organizations.read ### The purpose of this API to delete the program service for an Organization. - [DELETE /api/organizations/{organizationId}/program-services/{serviceId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_deleteprogramservice.md): Permissions needed - organizations.admin ### The purpose of this API to update the program service for an Organization. - [PATCH /api/organizations/{organizationId}/program-services/{serviceId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_updateprogramservice.md): Permissions needed - organizations.admin ### The purpose of this API to activate the program service for an Organization. - [POST /api/organizations/{organizationId}/program-services/{serviceId}/activate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_activate.md): Permissions needed - organizations.admin ### The purpose of this API to deactivate the program service for an Organization. - [POST /api/organizations/{organizationId}/program-services/{serviceId}/deactivate](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_deactivate.md): Permissions needed - organizations.admin ### The purpose of this API to preview program service by id for an Organization. - [POST /api/organizations/{organizationId}/program-services/{serviceId}/preview](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/program-services/programservicecontroller_previewprogramservice.md): Permissions needed - organizations.read ## Service Delivery Rules ### The API is designed to facilitate the addition of service delivery rule information - [POST /api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/service-delivery-rules/servicedeliveryrulecontroller_create.md): Permissions needed - organizations.admin ### The purpose of this API is to list the information for service delivery rules. - [GET /api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/service-delivery-rules/servicedeliveryrulecontroller_list.md): Permissions needed - organizations.read ### The purpose of this API is to get the service delivery rule information - [GET /api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/service-delivery-rules/servicedeliveryrulecontroller_getbyid.md): Permissions needed - organizations.read ### The API is designed to to update the service delivery rule information - [PATCH /api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/service-delivery-rules/servicedeliveryrulecontroller_update.md): Permissions needed - organizations.admin ### The API is designed to facilitate the deletion of service delivery rule information - [DELETE /api/organizations/{organizationId}/program-services/{serviceId}/delivery-rules/{deliveryId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/service-delivery-rules/servicedeliveryrulecontroller_delete.md): Permissions needed - organizations.admin ## 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. - [GET /api/ai-prompts/{promptCode}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/ai-prompts/aipromptcontroller_getbycode.md): Permissions needed - subscribers.phi.read ### The purpose of this API is to update the ai prompt based on the prompt code - [PATCH /api/ai-prompts/{promptCode}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/ai-prompts/aipromptcontroller_update.md): Permissions needed - setup.data.admin ### The purpose of this API is to add the ai prompt based in the system - [POST /api/ai-prompts](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/ai-prompts/aipromptcontroller_add.md): Permissions needed - setup.data.admin ## Reward-Collections ### The purpose of this API is to add a new Reward Collection - [POST /api/subscribers/{subscriberId}/reward-collections](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-collections/rewardcollectioncontroller_createrewardcollection.md): Permissions needed - subscribers.phi.admin ### The purpose of this API is to view all Reward Collections - [GET /api/subscribers/{subscriberId}/reward-collections](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-collections/rewardcollectioncontroller_list.md): Permissions needed - subscribers.phi.read ### This API will delete the Reward Collection. - [DELETE /api/subscribers/{subscriberId}/reward-collections/{rewardCollectionId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-collections/rewardcollectioncontroller_deletebyid.md): Permissions needed - subscribers.phi.admin ## Event Point Mappings ### This API will get the Event Point Mapping details - [GET /api/event-points/{eventId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/event-point-mappings/eventpointmappingcontroller_getbyid.md): Permissions needed - subscribers.phi.read ### The purpose of this API is to view all Event Point Logs - [GET /api/event-points](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/event-point-mappings/eventpointmappingcontroller_list.md): Permissions needed - subscribers.phi.read ## Reward Categories ### The purpose of this API is to view Reward Categories - [GET /api/reward-categories](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-categories/rewardcategorycontroller_list.md): Permissions needed - subscribers.phi.read ## Subscriber Event Audits ### The purpose of this API is to add a new Subscriber Event Audit - [POST /api/subscribers/{subscriberId}/event-audits](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-event-audits/subscribereventauditcontroller_add.md): Permissions needed - subscribers.phi.admin ### The purpose of this API is to view all Subscriber Event Audit Mappings - [GET /api/subscribers/{subscriberId}/event-audits](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-event-audits/subscribereventauditcontroller_list.md): Permissions needed - subscribers.phi.read ### This API will delete the Subscriber Event Audit. - [DELETE /api/subscribers/{subscriberId}/event-audits/{subscriberEventAuditId}](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/subscriber-event-audits/subscribereventauditcontroller_deletebyid.md): Permissions needed - subscribers.phi.admin ## Reward Pools ### The purpose of this API is to view Reward Pools - [GET /api/subscribers/{subscriberId}/reward-pools](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-pools/rewardpoolcontroller_list.md): Permissions needed - subscribers.phi.read ### The purpose of this API is to view Reward Pool Statistics data for a given Subscriber. - [GET /api/subscribers/{subscriberId}/reward-pools/statistics](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-pools/rewardpoolcontroller_statistics.md): Permissions needed - subscribers.phi.read ### The purpose of this API is to allow custom attempts to be set for individual subscriber against specific Reward Categories. - [POST /api/subscribers/{subscriberId}/custom-attempts](https://ecg-api-documentation.redocly.app/products/addison/apis/addison/reward-pools/rewardpoolcontroller_customattempts.md): Permissions needed - subscribers.phi.admin