digitaluapi

<back to all web services

BatchViewQuery

The following routes are available for this service:
GET/batch_view
GET/batch_view/{Id}
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type BatchView() = 
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val CreatedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val FileName:String = null with get,set
        member val FileSize:String = null with get,set
        member val RecordCount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UserAuthId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RowVersionGuid:Guid = new Guid() with get,set
        member val InsertedRecords:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UpdatedRecords:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DeletedRecords:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val UploadType:String = null with get,set
        member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val StatusCodeDescription:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryDb<T>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type BatchViewQuery() = 
        inherit QueryDb<BatchView>()
        interface IGet
        member val UserAuthId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CampaignCustomersView() = 
        [<DataMember(Order=1)>]
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=2)>]
        member val Name:String = null with get,set

        [<DataMember(Order=3)>]
        member val Description:String = null with get,set

        [<DataMember(Order=4)>]
        member val CustomersId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=5)>]
        member val FirstName:String = null with get,set

        [<DataMember(Order=6)>]
        member val LastName:String = null with get,set

        [<DataMember(Order=7)>]
        member val IdNumber:String = null with get,set

        [<DataMember(Order=8)>]
        member val PassportNumber:String = null with get,set

        [<DataMember(Order=9)>]
        member val Email:String = null with get,set

        [<DataMember(Order=10)>]
        member val MobileNumber:String = null with get,set

        [<DataMember(Order=11)>]
        member val CustomerUniqueIdentifier:String = null with get,set

        [<DataMember(Order=12)>]
        member val CustomerPublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember(Order=13)>]
        member val CampaignPublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<DataMember(Order=14)>]
        member val TenantsId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<CampaignCustomersView> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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"}}}