digitaluapi

<back to all web services

BatchViewQuery

The following routes are available for this service:
GET/batch_view
GET/batch_view/{Id}
import Foundation
import ServiceStack

public class BatchViewQuery : QueryDb<BatchView>, IGet
{
    public var userAuthId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userAuthId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userAuthId = try container.decodeIfPresent(Int.self, forKey: .userAuthId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userAuthId != nil { try container.encode(userAuthId, forKey: .userAuthId) }
    }
}

public class BatchView : Codable
{
    public var id:Int?
    public var createdDate:Date?
    public var fileName:String
    public var fileSize:String
    public var recordCount:Int?
    public var userAuthId:Int?
    public var rowVersionGuid:String
    public var insertedRecords:Int?
    public var updatedRecords:Int?
    public var deletedRecords:Int?
    public var uploadType:String
    public var statusCodesId:Int?
    public var statusCodeDescription: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 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"}}}