| Required role: | Admin |
| GET | /SurveyCampaign/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | form | SurveyCampaign | No | |
| Stats | form | SurveyCampaignStats | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| Name | form | string | No | |
| Status | form | string | No | |
| Subject | form | string | No | |
| BodyHtml | form | string | No | |
| ReminderSubject | form | string | No | |
| ReminderBodyHtml | form | string | No | |
| FromEmail | form | string | No | |
| FromName | form | string | No | |
| Language | form | string | No | |
| ReminderAfterDays | form | int | No | |
| MaxReminders | form | int | No | |
| CreatedAt | form | DateTime | No | |
| SentAt | form | DateTime? | No | |
| ClosedAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Recipients | form | int | No | |
| Pending | form | int | No | |
| Queued | form | int | No | |
| Sent | form | int | No | |
| Bounced | form | int | No | |
| Rejected | form | int | No | |
| Opened | form | int | No | |
| Clicked | form | int | No | |
| Responded | form | int | No | |
| RemindersSent | form | int | No | |
| DueForReminder | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /SurveyCampaign/{Id} HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
item:
{
id: 0,
name: String,
status: String,
subject: String,
bodyHtml: String,
reminderSubject: String,
reminderBodyHtml: String,
fromEmail: String,
fromName: String,
language: String,
reminderAfterDays: 0,
maxReminders: 0,
createdAt: 0001-01-01,
sentAt: 0001-01-01,
closedAt: 0001-01-01
},
stats:
{
recipients: 0,
pending: 0,
queued: 0,
sent: 0,
bounced: 0,
rejected: 0,
opened: 0,
clicked: 0,
responded: 0,
remindersSent: 0,
dueForReminder: 0
},
statusCode: 0,
message: String
}