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.*;

public class dtos
{

    public static class BatchViewQuery extends QueryDb<BatchView> implements IGet
    {
        public Integer UserAuthId = null;
        
        public Integer getUserAuthId() { return UserAuthId; }
        public BatchViewQuery setUserAuthId(Integer value) { this.UserAuthId = value; return this; }
    }

    public static class QueryDb<T> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        @DataMember(Order=1)
        public Integer Skip = null;

        @DataMember(Order=2)
        public Integer Take = null;

        @DataMember(Order=3)
        public String OrderBy = null;

        @DataMember(Order=4)
        public String OrderByDesc = null;

        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class BatchView
    {
        public Long Id = null;
        public Date CreatedDate = null;
        public String FileName = null;
        public String FileSize = null;
        public Integer RecordCount = null;
        public Integer UserAuthId = null;
        public UUID RowVersionGuid = null;
        public Integer InsertedRecords = null;
        public Integer UpdatedRecords = null;
        public Integer DeletedRecords = null;
        public String UploadType = null;
        public Long StatusCodesId = null;
        public String StatusCodeDescription = null;
        
        public Long getId() { return Id; }
        public BatchView setId(Long value) { this.Id = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public BatchView setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public String getFileName() { return FileName; }
        public BatchView setFileName(String value) { this.FileName = value; return this; }
        public String getFileSize() { return FileSize; }
        public BatchView setFileSize(String value) { this.FileSize = value; return this; }
        public Integer getRecordCount() { return RecordCount; }
        public BatchView setRecordCount(Integer value) { this.RecordCount = value; return this; }
        public Integer getUserAuthId() { return UserAuthId; }
        public BatchView setUserAuthId(Integer value) { this.UserAuthId = value; return this; }
        public UUID getRowVersionGuid() { return RowVersionGuid; }
        public BatchView setRowVersionGuid(UUID value) { this.RowVersionGuid = value; return this; }
        public Integer getInsertedRecords() { return InsertedRecords; }
        public BatchView setInsertedRecords(Integer value) { this.InsertedRecords = value; return this; }
        public Integer getUpdatedRecords() { return UpdatedRecords; }
        public BatchView setUpdatedRecords(Integer value) { this.UpdatedRecords = value; return this; }
        public Integer getDeletedRecords() { return DeletedRecords; }
        public BatchView setDeletedRecords(Integer value) { this.DeletedRecords = value; return this; }
        public String getUploadType() { return UploadType; }
        public BatchView setUploadType(String value) { this.UploadType = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public BatchView setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getStatusCodeDescription() { return StatusCodeDescription; }
        public BatchView setStatusCodeDescription(String value) { this.StatusCodeDescription = value; return this; }
    }

    @DataContract
    public static class QueryResponse<T>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<CampaignCustomersView> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<CampaignCustomersView> getResults() { return Results; }
        public QueryResponse<T> setResults(ArrayList<CampaignCustomersView> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CampaignCustomersView
    {
        @DataMember(Order=1)
        public Long Id = null;

        @DataMember(Order=2)
        public String Name = null;

        @DataMember(Order=3)
        public String Description = null;

        @DataMember(Order=4)
        public Long CustomersId = null;

        @DataMember(Order=5)
        public String FirstName = null;

        @DataMember(Order=6)
        public String LastName = null;

        @DataMember(Order=7)
        public String IdNumber = null;

        @DataMember(Order=8)
        public String PassportNumber = null;

        @DataMember(Order=9)
        public String Email = null;

        @DataMember(Order=10)
        public String MobileNumber = null;

        @DataMember(Order=11)
        public String CustomerUniqueIdentifier = null;

        @DataMember(Order=12)
        public UUID CustomerPublicAccessGuid = null;

        @DataMember(Order=13)
        public UUID CampaignPublicAccessGuid = null;

        @DataMember(Order=14)
        public Integer TenantsId = null;
        
        public Long getId() { return Id; }
        public CampaignCustomersView setId(Long value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CampaignCustomersView setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public CampaignCustomersView setDescription(String value) { this.Description = value; return this; }
        public Long getCustomersId() { return CustomersId; }
        public CampaignCustomersView setCustomersId(Long value) { this.CustomersId = value; return this; }
        public String getFirstName() { return FirstName; }
        public CampaignCustomersView setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public CampaignCustomersView setLastName(String value) { this.LastName = value; return this; }
        public String getIdNumber() { return IdNumber; }
        public CampaignCustomersView setIdNumber(String value) { this.IdNumber = value; return this; }
        public String getPassportNumber() { return PassportNumber; }
        public CampaignCustomersView setPassportNumber(String value) { this.PassportNumber = value; return this; }
        public String getEmail() { return Email; }
        public CampaignCustomersView setEmail(String value) { this.Email = value; return this; }
        public String getMobileNumber() { return MobileNumber; }
        public CampaignCustomersView setMobileNumber(String value) { this.MobileNumber = value; return this; }
        public String getCustomerUniqueIdentifier() { return CustomerUniqueIdentifier; }
        public CampaignCustomersView setCustomerUniqueIdentifier(String value) { this.CustomerUniqueIdentifier = value; return this; }
        public UUID getCustomerPublicAccessGuid() { return CustomerPublicAccessGuid; }
        public CampaignCustomersView setCustomerPublicAccessGuid(UUID value) { this.CustomerPublicAccessGuid = value; return this; }
        public UUID getCampaignPublicAccessGuid() { return CampaignPublicAccessGuid; }
        public CampaignCustomersView setCampaignPublicAccessGuid(UUID value) { this.CampaignPublicAccessGuid = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public CampaignCustomersView setTenantsId(Integer value) { this.TenantsId = value; return this; }
    }

}

Java BatchViewQuery DTOs

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

HTTP + CSV

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