digitaluapi

<back to all web services

BatchViewQuery

The following routes are available for this service:
GET/batch_view
GET/batch_view/{Id}
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 BatchViewQuery : QueryDb<BatchView>(), IGet
{
    open var UserAuthId: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 BatchView
{
    open var Id:Long? = null
    open var CreatedDate:Date? = null
    open var FileName:String? = null
    open var FileSize:String? = null
    open var RecordCount:Int? = null
    open var UserAuthId:Int? = null
    open var RowVersionGuid:UUID? = null
    open var InsertedRecords:Int? = null
    open var UpdatedRecords:Int? = null
    open var DeletedRecords:Int? = null
    open var UploadType:String? = null
    open var StatusCodesId:Long? = null
    open var StatusCodeDescription:String? = 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 BatchViewQuery 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 /batch_view 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,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","FileName":"String","FileSize":"String","RecordCount":0,"UserAuthId":0,"RowVersionGuid":"00000000000000000000000000000000","InsertedRecords":0,"UpdatedRecords":0,"DeletedRecords":0,"UploadType":"String","StatusCodesId":0,"StatusCodeDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}