digitaluapi

BatchAdd

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

The following routes are available for this service:
POST	/batch

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Batch:
    # @Required()
    id: int = 0

    created_date: Optional[datetime.datetime] = None
    # @Required()
    file_name: Optional[str] = None

    # @Required()
    file_size: Optional[str] = None

    # @Required()
    record_count: int = 0

    user_auth_id: int = 0
    row_version_guid: Optional[str] = None
    inserted_records: Optional[int] = None
    updated_records: Optional[int] = None
    deleted_records: Optional[int] = None
    upload_type: Optional[str] = None
    status_codes_id: Optional[int] = None
    error_records: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchAdd:
    created_date: Optional[datetime.datetime] = None
    # @Validate(Validator="NotNull")
    file_name: Optional[str] = None

    # @Validate(Validator="NotNull")
    file_size: Optional[str] = None

    # @Validate(Validator="NotNull")
    record_count: int = 0

    user_auth_id: Optional[int] = None
    row_version_guid: Optional[str] = None
    inserted_records: Optional[int] = None
    updated_records: Optional[int] = None
    deleted_records: Optional[int] = None
    upload_type: Optional[str] = None
    status_codes_id: Optional[int] = None

Python 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>