digitaluapi

<back to all web services

LookupCampaignCustomers

The following routes are available for this service:
GET/campaign/customers/Get Campaign Customers
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CampaignCustomersView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
NameformstringNo
DescriptionformstringNo
CustomersIdformlong?No
FirstNameformstringNo
LastNameformstringNo
IdNumberformstringNo
PassportNumberformstringNo
EmailformstringNo
MobileNumberformstringNo
CustomerUniqueIdentifierformstringNo
CustomerPublicAccessGuidformGuid?No
CampaignPublicAccessGuidformGuid?No
TenantsIdformint?No
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<CampaignCustomersView>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}