| GET | /campaign/customers/ | Get Campaign Customers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long? | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| CustomersId | form | long? | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| IdNumber | form | string | No | |
| PassportNumber | form | string | No | |
| form | string | No | ||
| MobileNumber | form | string | No | |
| CustomerUniqueIdentifier | form | string | No | |
| CustomerPublicAccessGuid | form | Guid? | No | |
| CampaignPublicAccessGuid | form | Guid? | No | |
| TenantsId | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<CampaignCustomersView> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | 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 /campaign/customers/ HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
Description: String,
CustomersId: 0,
FirstName: String,
LastName: String,
IdNumber: String,
PassportNumber: String,
Email: String,
MobileNumber: String,
CustomerUniqueIdentifier: String,
CustomerPublicAccessGuid: 00000000000000000000000000000000,
CampaignPublicAccessGuid: 00000000000000000000000000000000,
TenantsId: 0
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}