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
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 Batch() = 
        [<DataMember(Order=1)>]
        [<Required>]
        member val Id:Int64 = new Int64() with get,set

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

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

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

        [<DataMember(Order=5)>]
        [<Required>]
        member val RecordCount:Int32 = new Int32() with get,set

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

        [<DataMember(Order=7)>]
        member val RowVersionGuid:Guid = new Guid() with get,set

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type BatchAdd() = 
        [<DataMember(Order=2)>]
        member val CreatedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set

        [<DataMember(Order=3)>]
        [<Validate(Validator="NotNull")>]
        member val FileName:String = null with get,set

        [<DataMember(Order=4)>]
        [<Validate(Validator="NotNull")>]
        member val FileSize:String = null with get,set

        [<DataMember(Order=5)>]
        [<Validate(Validator="NotNull")>]
        member val RecordCount:Int32 = new Int32() with get,set

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

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

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

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

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

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

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

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