POST

api/FormBuilder/v1/Publish/Validate

Validates the form to ensure it can be published

Request Information

Roles

FormBuilder

URI Parameters

None.

Body Parameters

Form model to publish

OnlineEditorPublishedForm

Name	Type	Additional information
User	string	None.
_FinanceProperties	FinanceProperties	None.
_BrandingProperties	BrandingProperties	None.
DocumentPropertiesJSON	DocumentPropertiesJSON	None.
_FormProperties	FormProperties	None.
OnlineEditorPublishedFormsSeq	integer	None.
PublishURL	string	None.
Version	integer	None.
PageHTML	string	None.
PublishFrom	date	None.
PublishTo	date	None.
CreatedOn	date	None.
CreatedBy	string	None.
ModifiedOn	date	None.
ModifiedBy	string	None.
OnlineEditorPageSeq	integer	None.

Request Formats

{
  "User": "sample string 1",
  "_FinanceProperties": {
    "EnrolmentDepositDefinition": "sample string 1",
    "EnableEnrolmentDeposit": true,
    "EnablePayNow": true,
    "EnablePayLater": true,
    "PayNowLabel": "sample string 5",
    "PayLaterLabel": "sample string 6",
    "PayNowExtra": "sample string 7",
    "ForcePayment": "sample string 8",
    "PayLaterExtra": "sample string 9",
    "CompletionUrl": "sample string 10",
    "ReceiptsOnlineReference": "sample string 11",
    "OnlinePaymentMerchant": 1,
    "ReturnLabel": "sample string 12",
    "ReturnURL": "sample string 13"
  },
  "_BrandingProperties": {
    "Form": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "ActiveFlag": "sample string 3",
      "WebHeaderHTML": "sample string 4",
      "WebBackgroundHTML": "sample string 5",
      "WelcomePageHTML": "sample string 6"
    },
    "Payment": {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "ActiveFlag": "sample string 3",
      "WebHeaderHTML": "sample string 4",
      "WebBackgroundHTML": "sample string 5",
      "WelcomePageHTML": "sample string 6"
    }
  },
  "DocumentPropertiesJSON": {
    "PortalDocumentFlag": true,
    "DocumentDescriptions": "sample string 2"
  },
  "_FormProperties": {
    "RedirectURL": "sample string 1",
    "FormType": "sample string 2"
  },
  "OnlineEditorPublishedFormsSeq": 2,
  "PublishURL": "sample string 3",
  "Version": 4,
  "PageHTML": "sample string 5",
  "PublishFrom": "2025-05-02T01:01:10.9550057+10:00",
  "PublishTo": "2025-05-02T01:01:10.9550057+10:00",
  "CreatedOn": "2025-05-02T01:01:10.9550057+10:00",
  "CreatedBy": "sample string 7",
  "ModifiedOn": "2025-05-02T01:01:10.9550057+10:00",
  "ModifiedBy": "sample string 9",
  "OnlineEditorPageSeq": 1
}

<OnlineEditorPublishedForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.AutoGenerated">
  <CreatedBy>sample string 7</CreatedBy>
  <CreatedOn>2025-05-02T01:01:10.9550057+10:00</CreatedOn>
  <ModifiedBy>sample string 9</ModifiedBy>
  <ModifiedOn>2025-05-02T01:01:10.9550057+10:00</ModifiedOn>
  <OnlineEditorPageSeq>1</OnlineEditorPageSeq>
  <OnlineEditorPublishedFormsSeq>2</OnlineEditorPublishedFormsSeq>
  <PageHTML>sample string 5</PageHTML>
  <PublishFrom>2025-05-02T01:01:10.9550057+10:00</PublishFrom>
  <PublishTo>2025-05-02T01:01:10.9550057+10:00</PublishTo>
  <PublishURL>sample string 3</PublishURL>
  <Version>4</Version>
  <DocumentPropertiesJSON>
    <DocumentDescriptions>sample string 2</DocumentDescriptions>
    <PortalDocumentFlag>true</PortalDocumentFlag>
  </DocumentPropertiesJSON>
  <User>sample string 1</User>
  <_BrandingProperties>
    <Form>
      <ActiveFlag>sample string 3</ActiveFlag>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <WebBackgroundHTML>sample string 5</WebBackgroundHTML>
      <WebHeaderHTML>sample string 4</WebHeaderHTML>
      <WelcomePageHTML>sample string 6</WelcomePageHTML>
    </Form>
    <Payment>
      <ActiveFlag>sample string 3</ActiveFlag>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <WebBackgroundHTML>sample string 5</WebBackgroundHTML>
      <WebHeaderHTML>sample string 4</WebHeaderHTML>
      <WelcomePageHTML>sample string 6</WelcomePageHTML>
    </Payment>
  </_BrandingProperties>
  <_FinanceProperties>
    <CompletionUrl>sample string 10</CompletionUrl>
    <EnableEnrolmentDeposit>true</EnableEnrolmentDeposit>
    <EnablePayLater>true</EnablePayLater>
    <EnablePayNow>true</EnablePayNow>
    <EnrolmentDepositDefinition>sample string 1</EnrolmentDepositDefinition>
    <ForcePayment>sample string 8</ForcePayment>
    <OnlinePaymentMerchant>1</OnlinePaymentMerchant>
    <PayLaterExtra>sample string 9</PayLaterExtra>
    <PayLaterLabel>sample string 6</PayLaterLabel>
    <PayNowExtra>sample string 7</PayNowExtra>
    <PayNowLabel>sample string 5</PayNowLabel>
    <ReceiptsOnlineReference>sample string 11</ReceiptsOnlineReference>
    <ReturnLabel>sample string 12</ReturnLabel>
    <ReturnURL>sample string 13</ReturnURL>
  </_FinanceProperties>
  <_FormProperties>
    <FormType>sample string 2</FormType>
    <RedirectURL>sample string 1</RedirectURL>
  </_FormProperties>
</OnlineEditorPublishedForm>

Sample not available.

POST

api/FormBuilder/v1/Publish/Validate

Request Information

Roles

URI Parameters

Body Parameters

Request Formats

Response Information

Resource Description

Response Formats

Name	Type	Additional information
IsValid	boolean	None.
ExistingFormName	string	None.
ExistingFormSeq	integer	None.