digitaluapi

<back to all web services

BatchEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/batch/{Id}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class BatchEdit
            <DataMember(Order:=1)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Id As Long

            <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

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

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

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

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

            <DataMember(Order:=5)>
            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:=14)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET BatchEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Id":0,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","FileName":"String","FileSize":"String","RecordCount":0,"UserAuthId":0,"RowVersionGuid":"00000000000000000000000000000000","InsertedRecords":0,"UpdatedRecords":0,"DeletedRecords":0,"UploadType":"String","StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","FileName":"String","FileSize":"String","RecordCount":0,"UserAuthId":0,"RowVersionGuid":"00000000000000000000000000000000","InsertedRecords":0,"UpdatedRecords":0,"DeletedRecords":0,"UploadType":"String","StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}