digitaluapi

<back to all web services

BatchDataFieldsViewQuery

The following routes are available for this service:
GET/batch_data_fields_view
GET/batch_data_fields_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
{

    @DataContract
    public static class BatchDataFieldsViewQuery extends QueryDb<BatchDataFieldsView> implements IGet
    {
        
    }

    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 BatchDataFieldsView
    {
        public Long Id = null;
        public Integer BatchId = null;
        public Integer UploadFieldsId = null;
        public String MappedFieldName = null;
        public String FieldName = null;
        public Boolean Required = null;
        public String UploadType = null;
        public String Label = null;
        public String UploadSubtype = null;
        public Boolean IsEnabled = null;
        public Double SortOrder = null;
        public String Help = null;
        public String Placeholder = null;
        public String DataType = null;
        
        public Long getId() { return Id; }
        public BatchDataFieldsView setId(Long value) { this.Id = value; return this; }
        public Integer getBatchId() { return BatchId; }
        public BatchDataFieldsView setBatchId(Integer value) { this.BatchId = value; return this; }
        public Integer getUploadFieldsId() { return UploadFieldsId; }
        public BatchDataFieldsView setUploadFieldsId(Integer value) { this.UploadFieldsId = value; return this; }
        public String getMappedFieldName() { return MappedFieldName; }
        public BatchDataFieldsView setMappedFieldName(String value) { this.MappedFieldName = value; return this; }
        public String getFieldName() { return FieldName; }
        public BatchDataFieldsView setFieldName(String value) { this.FieldName = value; return this; }
        public Boolean isRequired() { return Required; }
        public BatchDataFieldsView setRequired(Boolean value) { this.Required = value; return this; }
        public String getUploadType() { return UploadType; }
        public BatchDataFieldsView setUploadType(String value) { this.UploadType = value; return this; }
        public String getLabel() { return Label; }
        public BatchDataFieldsView setLabel(String value) { this.Label = value; return this; }
        public String getUploadSubtype() { return UploadSubtype; }
        public BatchDataFieldsView setUploadSubtype(String value) { this.UploadSubtype = value; return this; }
        public Boolean getIsEnabled() { return IsEnabled; }
        public BatchDataFieldsView setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
        public Double getSortOrder() { return SortOrder; }
        public BatchDataFieldsView setSortOrder(Double value) { this.SortOrder = value; return this; }
        public String getHelp() { return Help; }
        public BatchDataFieldsView setHelp(String value) { this.Help = value; return this; }
        public String getPlaceholder() { return Placeholder; }
        public BatchDataFieldsView setPlaceholder(String value) { this.Placeholder = value; return this; }
        public String getDataType() { return DataType; }
        public BatchDataFieldsView setDataType(String value) { this.DataType = 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 BatchDataFieldsViewQuery 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 /batch_data_fields_view 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,
			BatchId: 0,
			UploadFieldsId: 0,
			MappedFieldName: String,
			FieldName: String,
			Required: False,
			UploadType: String,
			Label: String,
			UploadSubtype: String,
			IsEnabled: False,
			SortOrder: 0,
			Help: String,
			Placeholder: String,
			DataType: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}