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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports digitaluapi.ServiceModel.Types

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class BatchAdd
            <DataMember(Order:=2)>
            Public Overridable Property CreatedDate As DateTimeOffset?

            <DataMember(Order:=3)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property FileName As String

            <DataMember(Order:=4)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property FileSize As String

            <DataMember(Order:=5)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property RecordCount As Integer

            <DataMember(Order:=6)>
            Public Overridable Property UserAuthId As Integer?

            <DataMember(Order:=7)>
            Public Overridable Property RowVersionGuid As Guid?

            <DataMember(Order:=8)>
            Public Overridable Property InsertedRecords As Integer?

            <DataMember(Order:=9)>
            Public Overridable Property UpdatedRecords As Integer?

            <DataMember(Order:=10)>
            Public Overridable Property DeletedRecords As Integer?

            <DataMember(Order:=11)>
            Public Overridable Property UploadType As String

            <DataMember(Order:=12)>
            Public Overridable Property StatusCodesId As Long?
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

        Public Partial Class Batch
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            Public Overridable Property CreatedDate As DateTimeOffset?

            <DataMember(Order:=3)>
            <Required>
            Public Overridable Property FileName As String

            <DataMember(Order:=4)>
            <Required>
            Public Overridable Property FileSize As String

            <DataMember(Order:=5)>
            <Required>
            Public Overridable Property RecordCount As Integer

            <DataMember(Order:=6)>
            Public Overridable Property UserAuthId As Integer

            <DataMember(Order:=7)>
            Public Overridable Property RowVersionGuid As Guid

            <DataMember(Order:=8)>
            Public Overridable Property InsertedRecords As Integer?

            <DataMember(Order:=9)>
            Public Overridable Property UpdatedRecords As Integer?

            <DataMember(Order:=10)>
            Public Overridable Property DeletedRecords As Integer?

            <DataMember(Order:=11)>
            Public Overridable Property UploadType As String

            <DataMember(Order:=12)>
            Public Overridable Property StatusCodesId As Long?

            <DataMember(Order:=13)>
            Public Overridable Property ErrorRecords As Integer?
        End Class
    End Namespace
End Namespace

VB.NET 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>