digitaluapi

<back to all web services

BatchAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/batch
import Foundation
import ServiceStack

// @DataContract
public class BatchAdd : Codable
{
    // @DataMember(Order=2)
    public var createdDate:Date?

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var fileName:String

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var fileSize:String

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var recordCount:Int

    // @DataMember(Order=6)
    public var userAuthId:Int?

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

    // @DataMember(Order=8)
    public var insertedRecords:Int?

    // @DataMember(Order=9)
    public var updatedRecords:Int?

    // @DataMember(Order=10)
    public var deletedRecords:Int?

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

    // @DataMember(Order=12)
    public var statusCodesId:Int?

    required public init(){}
}

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

    // @DataMember(Order=2)
    public var createdDate:Date?

    // @DataMember(Order=3)
    // @Required()
    public var fileName:String?

    // @DataMember(Order=4)
    // @Required()
    public var fileSize:String?

    // @DataMember(Order=5)
    // @Required()
    public var recordCount:Int?

    // @DataMember(Order=6)
    public var userAuthId:Int

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

    // @DataMember(Order=8)
    public var insertedRecords:Int?

    // @DataMember(Order=9)
    public var updatedRecords:Int?

    // @DataMember(Order=10)
    public var deletedRecords:Int?

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

    // @DataMember(Order=12)
    public var statusCodesId:Int?

    // @DataMember(Order=13)
    public var errorRecords:Int?

    required public init(){}
}


Swift BatchAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"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}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"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,"ErrorRecords":0}