digitaluapi

<back to all web services

LookupCampaignCustomers

The following routes are available for this service:
GET/campaign/customers/Get Campaign Customers
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CampaignCustomersView() = 
        [<DataMember(Order=1)>]
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=2)>]
        member val Name:String = null with get,set

        [<DataMember(Order=3)>]
        member val Description:String = null with get,set

        [<DataMember(Order=4)>]
        member val CustomersId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=5)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=6)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=7)>]
        member val IdNumber:String = null with get,set

        [<DataMember(Order=8)>]
        member val PassportNumber:String = null with get,set

        [<DataMember(Order=9)>]
        member val Email:String = null with get,set

        [<DataMember(Order=10)>]
        member val MobileNumber:String = null with get,set

        [<DataMember(Order=11)>]
        member val CustomerUniqueIdentifier:String = null with get,set

        [<DataMember(Order=12)>]
        member val CustomerPublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember(Order=13)>]
        member val CampaignPublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember(Order=14)>]
        member val TenantsId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryDb<T>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type LookupCampaignCustomers() = 
        inherit QueryDb<CampaignCustomersView>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<CampaignCustomersView> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# LookupCampaignCustomers DTOs

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