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
UploadFieldsAdd Parameters:
NameParameterData TypeRequiredDescription
FieldNamebodystringNo
Requiredbodybool?No
UploadTypebodystringNo
LabelbodystringNo
UploadSubtypebodystringNo
IsEnabledbodybool?No
SortOrderbodydouble?No
HelpbodystringNo
PlaceholderbodystringNo
UploadFieldsAddResponse Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
Requiredformbool?No
UploadTypeformstringNo
LabelformstringNo
UploadSubtypeformstringNo
IsEnabledformbool?No
SortOrderformdouble?No
HelpformstringNo
PlaceholderformstringNo
ResponseStatusformResponseStatusNo

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 /upload_fields HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadFieldsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <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>
</UploadFieldsAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UploadFieldsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <FieldName>String</FieldName>
  <Help>String</Help>
  <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>
</UploadFieldsAddResponse>