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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<BatchAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <RecordCount>0</RecordCount>
  <UserAuthId>0</UserAuthId>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <InsertedRecords>0</InsertedRecords>
  <UpdatedRecords>0</UpdatedRecords>
  <DeletedRecords>0</DeletedRecords>
  <UploadType>String</UploadType>
  <StatusCodesId>0</StatusCodesId>
</BatchAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </CreatedDate>
  <DeletedRecords>0</DeletedRecords>
  <ErrorRecords>0</ErrorRecords>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <Id>0</Id>
  <InsertedRecords>0</InsertedRecords>
  <RecordCount>0</RecordCount>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <StatusCodesId>0</StatusCodesId>
  <UpdatedRecords>0</UpdatedRecords>
  <UploadType>String</UploadType>
  <UserAuthId>0</UserAuthId>
</Batch>