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 Foundation
import ServiceStack

// @DataContract
public class BatchDataFieldsViewQuery : QueryDb<BatchDataFieldsView>, IGet
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class BatchDataFieldsView : Codable
{
    public var id:Int?
    public var batchId:Int?
    public var uploadFieldsId:Int?
    public var mappedFieldName:String
    public var fieldName:String
    public var required:Bool
    public var uploadType:String
    public var label:String
    public var uploadSubtype:String
    public var isEnabled:Bool
    public var sortOrder:Double?
    public var help:String
    public var placeholder:String
    public var dataType:String

    required public init(){}
}

public class CampaignCustomersView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var name:String

    // @DataMember(Order=3)
    public var Description:String

    // @DataMember(Order=4)
    public var customersId:Int?

    // @DataMember(Order=5)
    public var firstName:String

    // @DataMember(Order=6)
    public var lastName:String

    // @DataMember(Order=7)
    public var idNumber:String

    // @DataMember(Order=8)
    public var passportNumber:String

    // @DataMember(Order=9)
    public var email:String

    // @DataMember(Order=10)
    public var mobileNumber:String

    // @DataMember(Order=11)
    public var customerUniqueIdentifier:String

    // @DataMember(Order=12)
    public var customerPublicAccessGuid:String?

    // @DataMember(Order=13)
    public var campaignPublicAccessGuid:String?

    // @DataMember(Order=14)
    public var tenantsId:Int?

    required public init(){}
}


Swift 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
		}
	}
}