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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;
using digitaluapi.ServiceModel.Types;

namespace digitaluapi.ServiceModel
{
    [DataContract]
    public partial class BatchDataFieldsViewQuery
        : QueryDb<BatchDataFieldsView>, IGet
    {
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class BatchDataFieldsView
    {
        public virtual long? Id { get; set; }
        public virtual int? BatchId { get; set; }
        public virtual int? UploadFieldsId { get; set; }
        public virtual string MappedFieldName { get; set; }
        public virtual string FieldName { get; set; }
        public virtual bool Required { get; set; }
        public virtual string UploadType { get; set; }
        public virtual string Label { get; set; }
        public virtual string UploadSubtype { get; set; }
        public virtual bool IsEnabled { get; set; }
        public virtual double? SortOrder { get; set; }
        public virtual string Help { get; set; }
        public virtual string Placeholder { get; set; }
        public virtual string DataType { get; set; }
    }

    public partial class CampaignCustomersView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual string Name { get; set; }

        [DataMember(Order=3)]
        public virtual string Description { get; set; }

        [DataMember(Order=4)]
        public virtual long? CustomersId { get; set; }

        [DataMember(Order=5)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=6)]
        public virtual string LastName { get; set; }

        [DataMember(Order=7)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=8)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=9)]
        public virtual string Email { get; set; }

        [DataMember(Order=10)]
        public virtual string MobileNumber { get; set; }

        [DataMember(Order=11)]
        public virtual string CustomerUniqueIdentifier { get; set; }

        [DataMember(Order=12)]
        public virtual Guid? CustomerPublicAccessGuid { get; set; }

        [DataMember(Order=13)]
        public virtual Guid? CampaignPublicAccessGuid { get; set; }

        [DataMember(Order=14)]
        public virtual int? TenantsId { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string Include { get; set; }

        [DataMember(Order=6)]
        public virtual string Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    public partial class QueryDb<T>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<CampaignCustomersView> Results { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}