digitaluapi

<back to all web services

UploadFieldsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/upload_fields
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 UploadFieldsAddResponse:
    field_name: Optional[str] = None
    required: Optional[bool] = None
    upload_type: Optional[str] = None
    label: Optional[str] = None
    upload_subtype: Optional[str] = None
    is_enabled: Optional[bool] = None
    sort_order: Optional[float] = None
    help: Optional[str] = None
    placeholder: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UploadFieldsAdd:
    field_name: Optional[str] = None
    required: Optional[bool] = None
    upload_type: Optional[str] = None
    label: Optional[str] = None
    upload_subtype: Optional[str] = None
    is_enabled: Optional[bool] = None
    sort_order: Optional[float] = None
    help: Optional[str] = None
    placeholder: Optional[str] = None

Python UploadFieldsAdd DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /upload_fields HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}