digitaluapi

<back to all web services

LookupCampaignCustomers

The following routes are available for this service:
GET/campaign/customers/Get Campaign Customers
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class LookupCampaignCustomers : QueryDb<CampaignCustomersView>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var Skip:Int? = null

    @DataMember(Order=2)
    open var Take:Int? = null

    @DataMember(Order=3)
    open var OrderBy:String? = null

    @DataMember(Order=4)
    open var OrderByDesc:String? = null

    @DataMember(Order=5)
    open var Include:String? = null

    @DataMember(Order=6)
    open var Fields:String? = null

    @DataMember(Order=7)
    open var Meta:HashMap<String,String>? = null
}

open class CampaignCustomersView
{
    @DataMember(Order=1)
    open var Id:Long? = null

    @DataMember(Order=2)
    open var Name:String? = null

    @DataMember(Order=3)
    open var Description:String? = null

    @DataMember(Order=4)
    open var CustomersId:Long? = null

    @DataMember(Order=5)
    open var FirstName:String? = null

    @DataMember(Order=6)
    open var LastName:String? = null

    @DataMember(Order=7)
    open var IdNumber:String? = null

    @DataMember(Order=8)
    open var PassportNumber:String? = null

    @DataMember(Order=9)
    open var Email:String? = null

    @DataMember(Order=10)
    open var MobileNumber:String? = null

    @DataMember(Order=11)
    open var CustomerUniqueIdentifier:String? = null

    @DataMember(Order=12)
    open var CustomerPublicAccessGuid:UUID? = null

    @DataMember(Order=13)
    open var CampaignPublicAccessGuid:UUID? = null

    @DataMember(Order=14)
    open var TenantsId:Int? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var Offset:Int? = null

    @DataMember(Order=2)
    open var Total:Int? = null

    @DataMember(Order=3)
    open var Results:ArrayList<CampaignCustomersView>? = null

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin LookupCampaignCustomers DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}