Trendsic Platform Service

<back to all web services

FormDiscardRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/{FormUID}/draft/discard
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class FormCard
            Public Overridable Property FormUID As Guid
            Public Overridable Property Name As String
            Public Overridable Property Slug As String
            Public Overridable Property Noun As String
            Public Overridable Property NumberPrefix As String
            Public Overridable Property Description As String
            Public Overridable Property Tone As String
            Public Overridable Property Status As String
            Public Overridable Property PublishedVersionNo As Integer?
            Public Overridable Property PublishedAt As Date?
            Public Overridable Property PublishedBy As String
            Public Overridable Property DraftDirty As Boolean
            Public Overridable Property DraftUpdatedAt As Date?
            Public Overridable Property DraftUpdatedBy As String
            Public Overridable Property PackLabel As String
            Public Overridable Property SettingsJson As String
            Public Overridable Property Stats As FormStats
            Public Overridable Property Offered As List(Of String) = New List(Of String)
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
        End Class

        Public Partial Class FormDetail
            Inherits FormCard
            Public Overridable Property DraftJson As String
            Public Overridable Property DraftRev As Integer
            Public Overridable Property SourceTemplateUID As Guid?
            Public Overridable Property Warnings As List(Of String) = New List(Of String)
            Public Overridable Property AlwaysHidden As List(Of String) = New List(Of String)
        End Class

        Public Partial Class FormDiscardRequest
            Public Overridable Property FormUID As Guid
            Public Overridable Property DraftRev As Integer
        End Class

        Public Partial Class FormResponse
            Public Overridable Property Form As FormDetail
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class FormStats
            Public Overridable Property Total As Integer
            Public Overridable Property NeedDecision As Integer
            Public Overridable Property Waiting As Integer
            Public Overridable Property Overdue As Integer
        End Class
    End Namespace
End Namespace

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

POST /v1/forms/{FormUID}/draft/discard HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormDiscardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DraftRev>0</DraftRev>
  <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
</FormDiscardRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Form>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <Description>String</Description>
    <DraftDirty>false</DraftDirty>
    <DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
    <DraftUpdatedBy>String</DraftUpdatedBy>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Name>String</Name>
    <Noun>String</Noun>
    <NumberPrefix>String</NumberPrefix>
    <Offered xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Offered>
    <PackLabel>String</PackLabel>
    <PublishedAt>0001-01-01T00:00:00</PublishedAt>
    <PublishedBy>String</PublishedBy>
    <PublishedVersionNo>0</PublishedVersionNo>
    <SettingsJson>String</SettingsJson>
    <Slug>String</Slug>
    <Stats>
      <NeedDecision>0</NeedDecision>
      <Overdue>0</Overdue>
      <Total>0</Total>
      <Waiting>0</Waiting>
    </Stats>
    <Status>String</Status>
    <Tone>String</Tone>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <AlwaysHidden xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AlwaysHidden>
    <DraftJson>String</DraftJson>
    <DraftRev>0</DraftRev>
    <SourceTemplateUID>00000000-0000-0000-0000-000000000000</SourceTemplateUID>
    <Warnings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Warnings>
  </Form>
  <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>
</FormResponse>