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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBatchViewqTGWvAI3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:BatchView>
      <d2p1:CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CreatedDate>
      <d2p1:DeletedRecords>0</d2p1:DeletedRecords>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>String</d2p1:FileSize>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InsertedRecords>0</d2p1:InsertedRecords>
      <d2p1:RecordCount>0</d2p1:RecordCount>
      <d2p1:RowVersionGuid>00000000-0000-0000-0000-000000000000</d2p1:RowVersionGuid>
      <d2p1:StatusCodeDescription>String</d2p1:StatusCodeDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:UpdatedRecords>0</d2p1:UpdatedRecords>
      <d2p1:UploadType>String</d2p1:UploadType>
      <d2p1:UserAuthId>0</d2p1:UserAuthId>
    </d2p1:BatchView>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfBatchViewqTGWvAI3>