digitaluapi

<back to all web services

UploadFieldsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/upload_fields
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class UploadFieldsLookup
            <DataMember(Order:=2)>
            Public Overridable Property FieldName As String

            <DataMember(Order:=3)>
            Public Overridable Property Required As Boolean?

            <DataMember(Order:=4)>
            Public Overridable Property UploadType As String

            <DataMember(Order:=5)>
            Public Overridable Property Label As String

            <DataMember(Order:=6)>
            Public Overridable Property UploadSubtype As String

            <DataMember(Order:=7)>
            Public Overridable Property IsEnabled As Boolean?

            <DataMember(Order:=8)>
            Public Overridable Property SortOrder As Double?

            <DataMember(Order:=9)>
            Public Overridable Property Help As String

            <DataMember(Order:=10)>
            Public Overridable Property Placeholder As String
        End Class
    End Namespace
End Namespace

VB.NET UploadFieldsLookup 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.

GET /upload_fields HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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