digitaluapi

<back to all web services

UploadFieldsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/upload_fields/{Id}

export class UploadFieldsEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public FieldName: string;

    // @DataMember(Order=3)
    public Required?: boolean;

    // @DataMember(Order=4)
    public UploadType: string;

    // @DataMember(Order=5)
    public Label: string;

    // @DataMember(Order=6)
    public UploadSubtype: string;

    // @DataMember(Order=7)
    public IsEnabled?: boolean;

    // @DataMember(Order=8)
    public SortOrder?: number;

    // @DataMember(Order=9)
    public Help: string;

    // @DataMember(Order=10)
    public Placeholder: string;

    // @DataMember(Order=12)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<UploadFieldsEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UploadFieldsEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @DataMember(Order=2)
    public FieldName: string;

    // @DataMember(Order=3)
    public Required?: boolean;

    // @DataMember(Order=4)
    public UploadType: string;

    // @DataMember(Order=5)
    public Label: string;

    // @DataMember(Order=6)
    public UploadSubtype: string;

    // @DataMember(Order=7)
    public IsEnabled?: boolean;

    // @DataMember(Order=8)
    public SortOrder?: number;

    // @DataMember(Order=9)
    public Help: string;

    // @DataMember(Order=10)
    public Placeholder: string;

    public constructor(init?: Partial<UploadFieldsEdit>) { (Object as any).assign(this, init); }
}

TypeScript UploadFieldsEdit 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.

PUT /upload_fields/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadFieldsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <FieldName>String</FieldName>
  <Required>false</Required>
  <UploadType>String</UploadType>
  <Label>String</Label>
  <UploadSubtype>String</UploadSubtype>
  <IsEnabled>false</IsEnabled>
  <SortOrder>0</SortOrder>
  <Help>String</Help>
  <Placeholder>String</Placeholder>
</UploadFieldsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UploadFieldsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <FieldName>String</FieldName>
  <Help>String</Help>
  <Id>0</Id>
  <IsEnabled>false</IsEnabled>
  <Label>String</Label>
  <Placeholder>String</Placeholder>
  <Required>false</Required>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SortOrder>0</SortOrder>
  <UploadSubtype>String</UploadSubtype>
  <UploadType>String</UploadType>
</UploadFieldsEditResponse>