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

namespace digitaluapi.ServiceModel
{
    [DataContract]
    public partial class BatchAdd
    {
        [DataMember(Order=2)]
        public virtual DateTimeOffset? CreatedDate { get; set; }

        [DataMember(Order=3)]
        [Validate("NotNull")]
        public virtual string FileName { get; set; }

        [DataMember(Order=4)]
        [Validate("NotNull")]
        public virtual string FileSize { get; set; }

        [DataMember(Order=5)]
        [Validate("NotNull")]
        public virtual int RecordCount { get; set; }

        [DataMember(Order=6)]
        public virtual int? UserAuthId { get; set; }

        [DataMember(Order=7)]
        public virtual Guid? RowVersionGuid { get; set; }

        [DataMember(Order=8)]
        public virtual int? InsertedRecords { get; set; }

        [DataMember(Order=9)]
        public virtual int? UpdatedRecords { get; set; }

        [DataMember(Order=10)]
        public virtual int? DeletedRecords { get; set; }

        [DataMember(Order=11)]
        public virtual string UploadType { get; set; }

        [DataMember(Order=12)]
        public virtual long? StatusCodesId { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class Batch
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        public virtual DateTimeOffset? CreatedDate { get; set; }

        [DataMember(Order=3)]
        [Required]
        public virtual string FileName { get; set; }

        [DataMember(Order=4)]
        [Required]
        public virtual string FileSize { get; set; }

        [DataMember(Order=5)]
        [Required]
        public virtual int RecordCount { get; set; }

        [DataMember(Order=6)]
        public virtual int UserAuthId { get; set; }

        [DataMember(Order=7)]
        public virtual Guid RowVersionGuid { get; set; }

        [DataMember(Order=8)]
        public virtual int? InsertedRecords { get; set; }

        [DataMember(Order=9)]
        public virtual int? UpdatedRecords { get; set; }

        [DataMember(Order=10)]
        public virtual int? DeletedRecords { get; set; }

        [DataMember(Order=11)]
        public virtual string UploadType { get; set; }

        [DataMember(Order=12)]
        public virtual long? StatusCodesId { get; set; }

        [DataMember(Order=13)]
        public virtual int? ErrorRecords { get; set; }
    }

}

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