digitaluapi

BatchEdit

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
PUT	/batch/{Id}

import Foundation
import ServiceStack

// @DataContract
public class BatchEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @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 BatchEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

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

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

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

    // @DataMember(Order=5)
    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=14)
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift BatchEdit 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.

PUT /batch/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <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>
</BatchEdit>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BatchEditResponse 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>
  <DeletedRecords>0</DeletedRecords>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <Id>0</Id>
  <InsertedRecords>0</InsertedRecords>
  <RecordCount>0</RecordCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <StatusCodesId>0</StatusCodesId>
  <UpdatedRecords>0</UpdatedRecords>
  <UploadType>String</UploadType>
  <UserAuthId>0</UserAuthId>
</BatchEditResponse>