digitaluapi

<back to all web services

LookupCampaignCustomers

The following routes are available for this service:
GET/campaign/customers/Get Campaign Customers
import Foundation
import ServiceStack

public class LookupCampaignCustomers : QueryDb<CampaignCustomersView>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class CampaignCustomersView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var name:String

    // @DataMember(Order=3)
    public var Description:String

    // @DataMember(Order=4)
    public var customersId:Int?

    // @DataMember(Order=5)
    public var firstName:String

    // @DataMember(Order=6)
    public var lastName:String

    // @DataMember(Order=7)
    public var idNumber:String

    // @DataMember(Order=8)
    public var passportNumber:String

    // @DataMember(Order=9)
    public var email:String

    // @DataMember(Order=10)
    public var mobileNumber:String

    // @DataMember(Order=11)
    public var customerUniqueIdentifier:String

    // @DataMember(Order=12)
    public var customerPublicAccessGuid:String?

    // @DataMember(Order=13)
    public var campaignPublicAccessGuid:String?

    // @DataMember(Order=14)
    public var tenantsId:Int?

    required public init(){}
}


Swift LookupCampaignCustomers DTOs

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

HTTP + OTHER

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