PUT api/webforms/{webFormId}

Request Information

URI Parameters

Name	Description	Type	Additional information
webFormId		integer	Required

Body Parameters

UpdateWebFormViewModel

Name	Type	Additional information
CanBeSubscribedTo	boolean	None.
ConfirmationMailSubject	string	None.
ConfirmationMailText	string	None.
ConfirmationNavigationUrl	string	None.
ConfirmationPopupText	string	None.
Description	string	None.
EntityAttributeChoiceNamings	Collection of WebFormEntityAttributeChoiceNamingViewModel	None.
EntityAttributeIds	Collection of integer	None.
EntityAttributeNamings	Collection of WebFormEntityAttributeNamingViewModel	None.
EntityCategoryNamings	Collection of WebFormEntityCategoryNamingViewModel	None.
FilesAreAllowed	boolean	None.
ForwardEmailAddress	string	None.
Id	integer	None.
SubscribableEntityAttributeIds	Collection of integer	None.
SubscriptionIsMandatory	boolean	None.
WebFormGeneralStyling	WebFormGeneralStylingViewModel	None.
WebFormHtml	string	None.
WebFormNamings	WebFormNamingViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CanBeSubscribedTo": true,
  "ConfirmationMailSubject": "sample string 2",
  "ConfirmationMailText": "sample string 3",
  "ConfirmationNavigationUrl": "sample string 4",
  "ConfirmationPopupText": "sample string 5",
  "Description": "sample string 6",
  "EntityAttributeChoiceNamings": [
    {
      "ChoiceNaming": "sample string 1",
      "ChoiceValue": "sample string 2",
      "EntityAttributeId": 3
    },
    {
      "ChoiceNaming": "sample string 1",
      "ChoiceValue": "sample string 2",
      "EntityAttributeId": 3
    }
  ],
  "EntityAttributeIds": [
    1,
    2
  ],
  "EntityAttributeNamings": [
    {
      "DateRangeEndLabelNaming": "sample string 1",
      "DateRangeStartLabelNaming": "sample string 2",
      "EntityAttributeId": 3,
      "Naming": "sample string 4"
    },
    {
      "DateRangeEndLabelNaming": "sample string 1",
      "DateRangeStartLabelNaming": "sample string 2",
      "EntityAttributeId": 3,
      "Naming": "sample string 4"
    }
  ],
  "EntityCategoryNamings": [
    {
      "EntityCategoryId": 1,
      "Naming": "sample string 2"
    },
    {
      "EntityCategoryId": 1,
      "Naming": "sample string 2"
    }
  ],
  "FilesAreAllowed": true,
  "ForwardEmailAddress": "sample string 8",
  "Id": 9,
  "SubscribableEntityAttributeIds": [
    1,
    2
  ],
  "SubscriptionIsMandatory": true,
  "WebFormGeneralStyling": {
    "FormBackgroundColor": "sample string 1",
    "FormFontFamily": "sample string 2",
    "FormHeadersTextColor": "sample string 3",
    "FormInputsBackgroundColor": "sample string 4",
    "FormInputsBottomBorderColor": "sample string 5",
    "FormInputsTextColor": "sample string 6",
    "FormLabelsTextColor": "sample string 7",
    "SaveButtonBackgroundColor": "sample string 8",
    "SaveButtonBottomBorderColor": "sample string 9",
    "SaveButtonTextColor": "sample string 10"
  },
  "WebFormHtml": "sample string 11",
  "WebFormNamings": {
    "AttachAnotherFileText": "sample string 1",
    "AttachFilesDescriptionText": "sample string 2",
    "FilesSectionHeaderText": "sample string 3",
    "InvalidEntityAttributeFormatErrorMessage": "sample string 4",
    "RequiredEntityAttributeErrorMessage": "sample string 5",
    "RequiredEntityAttributeErrorPopupMessage": "sample string 6",
    "RequiredEntityAttributeErrorPopupTitle": "sample string 7",
    "SendButtonText": "sample string 8",
    "SubscriptionSectionDescriptionText": "sample string 9",
    "SubscriptionSectionHeaderText": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<UpdateWebFormViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <CanBeSubscribedTo>true</CanBeSubscribedTo>
  <ConfirmationMailSubject>sample string 2</ConfirmationMailSubject>
  <ConfirmationMailText>sample string 3</ConfirmationMailText>
  <ConfirmationNavigationUrl>sample string 4</ConfirmationNavigationUrl>
  <ConfirmationPopupText>sample string 5</ConfirmationPopupText>
  <Description>sample string 6</Description>
  <EntityAttributeChoiceNamings>
    <WebFormEntityAttributeChoiceNamingViewModel>
      <ChoiceNaming>sample string 1</ChoiceNaming>
      <ChoiceValue>sample string 2</ChoiceValue>
      <EntityAttributeId>3</EntityAttributeId>
    </WebFormEntityAttributeChoiceNamingViewModel>
    <WebFormEntityAttributeChoiceNamingViewModel>
      <ChoiceNaming>sample string 1</ChoiceNaming>
      <ChoiceValue>sample string 2</ChoiceValue>
      <EntityAttributeId>3</EntityAttributeId>
    </WebFormEntityAttributeChoiceNamingViewModel>
  </EntityAttributeChoiceNamings>
  <EntityAttributeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </EntityAttributeIds>
  <EntityAttributeNamings>
    <WebFormEntityAttributeNamingViewModel>
      <DateRangeEndLabelNaming>sample string 1</DateRangeEndLabelNaming>
      <DateRangeStartLabelNaming>sample string 2</DateRangeStartLabelNaming>
      <EntityAttributeId>3</EntityAttributeId>
      <Naming>sample string 4</Naming>
    </WebFormEntityAttributeNamingViewModel>
    <WebFormEntityAttributeNamingViewModel>
      <DateRangeEndLabelNaming>sample string 1</DateRangeEndLabelNaming>
      <DateRangeStartLabelNaming>sample string 2</DateRangeStartLabelNaming>
      <EntityAttributeId>3</EntityAttributeId>
      <Naming>sample string 4</Naming>
    </WebFormEntityAttributeNamingViewModel>
  </EntityAttributeNamings>
  <EntityCategoryNamings>
    <WebFormEntityCategoryNamingViewModel>
      <EntityCategoryId>1</EntityCategoryId>
      <Naming>sample string 2</Naming>
    </WebFormEntityCategoryNamingViewModel>
    <WebFormEntityCategoryNamingViewModel>
      <EntityCategoryId>1</EntityCategoryId>
      <Naming>sample string 2</Naming>
    </WebFormEntityCategoryNamingViewModel>
  </EntityCategoryNamings>
  <FilesAreAllowed>true</FilesAreAllowed>
  <ForwardEmailAddress>sample string 8</ForwardEmailAddress>
  <Id>9</Id>
  <SubscribableEntityAttributeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SubscribableEntityAttributeIds>
  <SubscriptionIsMandatory>true</SubscriptionIsMandatory>
  <WebFormGeneralStyling>
    <FormBackgroundColor>sample string 1</FormBackgroundColor>
    <FormFontFamily>sample string 2</FormFontFamily>
    <FormHeadersTextColor>sample string 3</FormHeadersTextColor>
    <FormInputsBackgroundColor>sample string 4</FormInputsBackgroundColor>
    <FormInputsBottomBorderColor>sample string 5</FormInputsBottomBorderColor>
    <FormInputsTextColor>sample string 6</FormInputsTextColor>
    <FormLabelsTextColor>sample string 7</FormLabelsTextColor>
    <SaveButtonBackgroundColor>sample string 8</SaveButtonBackgroundColor>
    <SaveButtonBottomBorderColor>sample string 9</SaveButtonBottomBorderColor>
    <SaveButtonTextColor>sample string 10</SaveButtonTextColor>
  </WebFormGeneralStyling>
  <WebFormHtml>sample string 11</WebFormHtml>
  <WebFormNamings>
    <AttachAnotherFileText>sample string 1</AttachAnotherFileText>
    <AttachFilesDescriptionText>sample string 2</AttachFilesDescriptionText>
    <FilesSectionHeaderText>sample string 3</FilesSectionHeaderText>
    <InvalidEntityAttributeFormatErrorMessage>sample string 4</InvalidEntityAttributeFormatErrorMessage>
    <RequiredEntityAttributeErrorMessage>sample string 5</RequiredEntityAttributeErrorMessage>
    <RequiredEntityAttributeErrorPopupMessage>sample string 6</RequiredEntityAttributeErrorPopupMessage>
    <RequiredEntityAttributeErrorPopupTitle>sample string 7</RequiredEntityAttributeErrorPopupTitle>
    <SendButtonText>sample string 8</SendButtonText>
    <SubscriptionSectionDescriptionText>sample string 9</SubscriptionSectionDescriptionText>
    <SubscriptionSectionHeaderText>sample string 10</SubscriptionSectionHeaderText>
  </WebFormNamings>
</UpdateWebFormViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadWebFormViewModel

Name	Type	Additional information
CanBeSubscribedTo	boolean	None.
ConfirmationMailSubject	string	None.
ConfirmationMailText	string	None.
ConfirmationNavigationUrl	string	None.
ConfirmationPopupText	string	None.
Description	string	None.
EntityAttributeChoiceNamings	Collection of WebFormEntityAttributeChoiceNamingViewModel	None.
EntityAttributeIds	Collection of integer	None.
EntityAttributeNamings	Collection of WebFormEntityAttributeNamingViewModel	None.
EntityCategoryNamings	Collection of WebFormEntityCategoryNamingViewModel	None.
EntityDefinitionId	integer	None.
FileName	string	None.
FilesAreAllowed	boolean	None.
ForwardEmailAddress	string	None.
Id	integer	None.
SubscribableEntityAttributes	Collection of integer	None.
SubscriptionIsMandatory	boolean	None.
WebFormGeneralStyling	WebFormGeneralStylingViewModel	None.
WebFormNamings	WebFormNamingViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "CanBeSubscribedTo": true,
  "ConfirmationMailSubject": "sample string 2",
  "ConfirmationMailText": "sample string 3",
  "ConfirmationNavigationUrl": "sample string 4",
  "ConfirmationPopupText": "sample string 5",
  "Description": "sample string 6",
  "EntityAttributeChoiceNamings": [
    {
      "ChoiceNaming": "sample string 1",
      "ChoiceValue": "sample string 2",
      "EntityAttributeId": 3
    },
    {
      "ChoiceNaming": "sample string 1",
      "ChoiceValue": "sample string 2",
      "EntityAttributeId": 3
    }
  ],
  "EntityAttributeIds": [
    1,
    2
  ],
  "EntityAttributeNamings": [
    {
      "DateRangeEndLabelNaming": "sample string 1",
      "DateRangeStartLabelNaming": "sample string 2",
      "EntityAttributeId": 3,
      "Naming": "sample string 4"
    },
    {
      "DateRangeEndLabelNaming": "sample string 1",
      "DateRangeStartLabelNaming": "sample string 2",
      "EntityAttributeId": 3,
      "Naming": "sample string 4"
    }
  ],
  "EntityCategoryNamings": [
    {
      "EntityCategoryId": 1,
      "Naming": "sample string 2"
    },
    {
      "EntityCategoryId": 1,
      "Naming": "sample string 2"
    }
  ],
  "EntityDefinitionId": 7,
  "FileName": "sample string 8",
  "FilesAreAllowed": true,
  "ForwardEmailAddress": "sample string 10",
  "Id": 11,
  "SubscribableEntityAttributes": [
    1,
    2
  ],
  "SubscriptionIsMandatory": true,
  "WebFormGeneralStyling": {
    "FormBackgroundColor": "sample string 1",
    "FormFontFamily": "sample string 2",
    "FormHeadersTextColor": "sample string 3",
    "FormInputsBackgroundColor": "sample string 4",
    "FormInputsBottomBorderColor": "sample string 5",
    "FormInputsTextColor": "sample string 6",
    "FormLabelsTextColor": "sample string 7",
    "SaveButtonBackgroundColor": "sample string 8",
    "SaveButtonBottomBorderColor": "sample string 9",
    "SaveButtonTextColor": "sample string 10"
  },
  "WebFormNamings": {
    "AttachAnotherFileText": "sample string 1",
    "AttachFilesDescriptionText": "sample string 2",
    "FilesSectionHeaderText": "sample string 3",
    "InvalidEntityAttributeFormatErrorMessage": "sample string 4",
    "RequiredEntityAttributeErrorMessage": "sample string 5",
    "RequiredEntityAttributeErrorPopupMessage": "sample string 6",
    "RequiredEntityAttributeErrorPopupTitle": "sample string 7",
    "SendButtonText": "sample string 8",
    "SubscriptionSectionDescriptionText": "sample string 9",
    "SubscriptionSectionHeaderText": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<ReadWebFormViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <CanBeSubscribedTo>true</CanBeSubscribedTo>
  <ConfirmationMailSubject>sample string 2</ConfirmationMailSubject>
  <ConfirmationMailText>sample string 3</ConfirmationMailText>
  <ConfirmationNavigationUrl>sample string 4</ConfirmationNavigationUrl>
  <ConfirmationPopupText>sample string 5</ConfirmationPopupText>
  <Description>sample string 6</Description>
  <EntityAttributeChoiceNamings>
    <WebFormEntityAttributeChoiceNamingViewModel>
      <ChoiceNaming>sample string 1</ChoiceNaming>
      <ChoiceValue>sample string 2</ChoiceValue>
      <EntityAttributeId>3</EntityAttributeId>
    </WebFormEntityAttributeChoiceNamingViewModel>
    <WebFormEntityAttributeChoiceNamingViewModel>
      <ChoiceNaming>sample string 1</ChoiceNaming>
      <ChoiceValue>sample string 2</ChoiceValue>
      <EntityAttributeId>3</EntityAttributeId>
    </WebFormEntityAttributeChoiceNamingViewModel>
  </EntityAttributeChoiceNamings>
  <EntityAttributeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </EntityAttributeIds>
  <EntityAttributeNamings>
    <WebFormEntityAttributeNamingViewModel>
      <DateRangeEndLabelNaming>sample string 1</DateRangeEndLabelNaming>
      <DateRangeStartLabelNaming>sample string 2</DateRangeStartLabelNaming>
      <EntityAttributeId>3</EntityAttributeId>
      <Naming>sample string 4</Naming>
    </WebFormEntityAttributeNamingViewModel>
    <WebFormEntityAttributeNamingViewModel>
      <DateRangeEndLabelNaming>sample string 1</DateRangeEndLabelNaming>
      <DateRangeStartLabelNaming>sample string 2</DateRangeStartLabelNaming>
      <EntityAttributeId>3</EntityAttributeId>
      <Naming>sample string 4</Naming>
    </WebFormEntityAttributeNamingViewModel>
  </EntityAttributeNamings>
  <EntityCategoryNamings>
    <WebFormEntityCategoryNamingViewModel>
      <EntityCategoryId>1</EntityCategoryId>
      <Naming>sample string 2</Naming>
    </WebFormEntityCategoryNamingViewModel>
    <WebFormEntityCategoryNamingViewModel>
      <EntityCategoryId>1</EntityCategoryId>
      <Naming>sample string 2</Naming>
    </WebFormEntityCategoryNamingViewModel>
  </EntityCategoryNamings>
  <EntityDefinitionId>7</EntityDefinitionId>
  <FileName>sample string 8</FileName>
  <FilesAreAllowed>true</FilesAreAllowed>
  <ForwardEmailAddress>sample string 10</ForwardEmailAddress>
  <Id>11</Id>
  <SubscribableEntityAttributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </SubscribableEntityAttributes>
  <SubscriptionIsMandatory>true</SubscriptionIsMandatory>
  <WebFormGeneralStyling>
    <FormBackgroundColor>sample string 1</FormBackgroundColor>
    <FormFontFamily>sample string 2</FormFontFamily>
    <FormHeadersTextColor>sample string 3</FormHeadersTextColor>
    <FormInputsBackgroundColor>sample string 4</FormInputsBackgroundColor>
    <FormInputsBottomBorderColor>sample string 5</FormInputsBottomBorderColor>
    <FormInputsTextColor>sample string 6</FormInputsTextColor>
    <FormLabelsTextColor>sample string 7</FormLabelsTextColor>
    <SaveButtonBackgroundColor>sample string 8</SaveButtonBackgroundColor>
    <SaveButtonBottomBorderColor>sample string 9</SaveButtonBottomBorderColor>
    <SaveButtonTextColor>sample string 10</SaveButtonTextColor>
  </WebFormGeneralStyling>
  <WebFormNamings>
    <AttachAnotherFileText>sample string 1</AttachAnotherFileText>
    <AttachFilesDescriptionText>sample string 2</AttachFilesDescriptionText>
    <FilesSectionHeaderText>sample string 3</FilesSectionHeaderText>
    <InvalidEntityAttributeFormatErrorMessage>sample string 4</InvalidEntityAttributeFormatErrorMessage>
    <RequiredEntityAttributeErrorMessage>sample string 5</RequiredEntityAttributeErrorMessage>
    <RequiredEntityAttributeErrorPopupMessage>sample string 6</RequiredEntityAttributeErrorPopupMessage>
    <RequiredEntityAttributeErrorPopupTitle>sample string 7</RequiredEntityAttributeErrorPopupTitle>
    <SendButtonText>sample string 8</SendButtonText>
    <SubscriptionSectionDescriptionText>sample string 9</SubscriptionSectionDescriptionText>
    <SubscriptionSectionHeaderText>sample string 10</SubscriptionSectionHeaderText>
  </WebFormNamings>
</ReadWebFormViewModel>