GET api/Configuration/EventSubscriptions/Client/{clientId}
Allows a user to get the event subscriptions for the client they specify.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
The client id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The list of event subscription categories.
Collection of ESignSystems.SmartSAFE.Models.EventNotification.EventSubscriptionCategoryModel| Name | Description | Type | Additional information |
|---|---|---|---|
| EventTypeCategoryId |
Gets or sets the event type category id. |
integer |
None. |
| EventTypeCategory |
Gets or sets the event type category lookup value. |
string |
None. |
| EventSubscriptions |
Gets or sets the event subscriptions in this category. |
Collection of ESignSystems.SmartSAFE.Models.EventNotification.EventSubscriptionModel |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"EventTypeCategoryId": 1,
"EventTypeCategory": "sample string 1",
"EventSubscriptions": [
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"CCEmailAddress": "sample string 11",
"UpdatedBy": "sample string 12",
"UpdatedDate": "2024-11-26T17:25:18.3635335-05:00"
},
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"CCEmailAddress": "sample string 11",
"UpdatedBy": "sample string 12",
"UpdatedDate": "2024-11-26T17:25:18.3635335-05:00"
}
]
},
{
"EventTypeCategoryId": 1,
"EventTypeCategory": "sample string 1",
"EventSubscriptions": [
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"CCEmailAddress": "sample string 11",
"UpdatedBy": "sample string 12",
"UpdatedDate": "2024-11-26T17:25:18.3635335-05:00"
},
{
"ClientEventSubscriptionId": 1,
"ClientId": 1,
"EventTypeId": 1,
"EventType": "sample string 1",
"EmailNotification": true,
"FromEmailAddress": "sample string 3",
"FromEmailName": "sample string 4",
"ReplyToEmailAddress": "sample string 5",
"EmailSubject": "sample string 6",
"EmailTemplate": "sample string 7",
"EmailRecipientDescription": "sample string 8",
"PushNotification": true,
"PushNotificationUrl": "sample string 10",
"CCEmailAddress": "sample string 11",
"UpdatedBy": "sample string 12",
"UpdatedDate": "2024-11-26T17:25:18.3635335-05:00"
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfEventSubscriptionCategoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.EventNotification">
<EventSubscriptionCategoryModel>
<EventSubscriptions>
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:25:18.3635335-05:00</UpdatedDate>
<CCEmailAddress>sample string 11</CCEmailAddress>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:25:18.3635335-05:00</UpdatedDate>
<CCEmailAddress>sample string 11</CCEmailAddress>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
</EventSubscriptions>
<EventTypeCategory>sample string 1</EventTypeCategory>
<EventTypeCategoryId>1</EventTypeCategoryId>
</EventSubscriptionCategoryModel>
<EventSubscriptionCategoryModel>
<EventSubscriptions>
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:25:18.3635335-05:00</UpdatedDate>
<CCEmailAddress>sample string 11</CCEmailAddress>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
<EventSubscriptionModel>
<UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 12</UpdatedBy>
<UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2024-11-26T17:25:18.3635335-05:00</UpdatedDate>
<CCEmailAddress>sample string 11</CCEmailAddress>
<ClientEventSubscriptionId>1</ClientEventSubscriptionId>
<ClientId>1</ClientId>
<EmailNotification>true</EmailNotification>
<EmailRecipientDescription>sample string 8</EmailRecipientDescription>
<EmailSubject>sample string 6</EmailSubject>
<EmailTemplate>sample string 7</EmailTemplate>
<EventType>sample string 1</EventType>
<EventTypeId>1</EventTypeId>
<FromEmailAddress>sample string 3</FromEmailAddress>
<FromEmailName>sample string 4</FromEmailName>
<PushNotification>true</PushNotification>
<PushNotificationUrl>sample string 10</PushNotificationUrl>
<ReplyToEmailAddress>sample string 5</ReplyToEmailAddress>
</EventSubscriptionModel>
</EventSubscriptions>
<EventTypeCategory>sample string 1</EventTypeCategory>
<EventTypeCategoryId>1</EventTypeCategoryId>
</EventSubscriptionCategoryModel>
</ArrayOfEventSubscriptionCategoryModel>