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}
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 BatchEditResponse:
    id: int = 0
    created_date: Optional[datetime.datetime] = None
    file_name: Optional[str] = None
    file_size: Optional[str] = None
    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
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchEdit:
    # @Validate(Validator="NotNull")
    id: int = 0

    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 BatchEdit DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}}