digitaluapi

SegmentsAutoQueryLookup

**Requires Authentication**
Requires the role:	Client

The following routes are available for this service:
GET	/auto/segments/{Id}
GET	/auto/segments

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 SegmentsAutoQueryLookup : QueryDb<Segments>(), IGet
{
    @DataMember(Order=1)
    open var Id:Int? = null

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

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 Segments
{
    @DataMember(Order=1)
    @Required()
    open var Id:Long? = null

    @DataMember(Order=2)
    @Required()
    @References(Type=Tenants::class)
    open var TenantsId:Int? = null

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

    @DataMember(Order=4)
    open var IsCustom:Boolean? = 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
}

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
}

Kotlin SegmentsAutoQueryLookup 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 /auto/segments/{Id} 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,
			TenantsId: 0,
			Name: String,
			IsCustom: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}