GET api/WebForm

Returs the web form for the specified web form name.
Possible Service Responses:
200/OK - match found returns form xml as a string.
404/Web Form Not Found - no match found for the specified web form name.
404/System Form Not Found - no system form found for the specified web form name.
500/Internal Server - unexpected server error, details in the body of the response.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.WebForm]
NameDescriptionTypeAdditional information
Id

System.String

None.
Name

System.String

None.
Text1

System.String

None.
Text2

System.String

None.
RedirectUrl

System.String

None.
FormEntityName

System.String

None.
NextWebFormName

System.String

None.
NextCategory

System.String

None.
NextNavigation

System.String

None.
FormXml

System.String

None.
ReadOnly

System.Boolean

None.
AssociateWithPortalUser

System.Boolean

None.
AssociatePortalUserTargetEntityField

System.String

None.
IsQBE

System.Boolean

None.
Entity

Altai.Web.Services.Models.Entity

None.
OptionsSets

System.Collections.Generic.List`1[Altai.Web.Services.Models.OptionSetValues]

None.
ParentEntityType

System.String

None.
ParentEntityAttribute

System.String

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Text1": "sample string 3",
    "Text2": "sample string 4",
    "RedirectUrl": "sample string 5",
    "FormEntityName": "sample string 6",
    "NextWebFormName": "sample string 7",
    "NextCategory": "sample string 8",
    "NextNavigation": "sample string 9",
    "FormXml": "sample string 10",
    "ReadOnly": true,
    "AssociateWithPortalUser": true,
    "AssociatePortalUserTargetEntityField": "sample string 13",
    "IsQBE": true,
    "Entity": null,
    "OptionsSets": [
      {
        "FieldName": "sample string 1",
        "OptionSet": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      },
      {
        "FieldName": "sample string 1",
        "OptionSet": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      }
    ],
    "ParentEntityType": "sample string 15",
    "ParentEntityAttribute": "sample string 16"
  },
  {
    "Id": "sample string 1",
    "Name": "sample string 2",
    "Text1": "sample string 3",
    "Text2": "sample string 4",
    "RedirectUrl": "sample string 5",
    "FormEntityName": "sample string 6",
    "NextWebFormName": "sample string 7",
    "NextCategory": "sample string 8",
    "NextNavigation": "sample string 9",
    "FormXml": "sample string 10",
    "ReadOnly": true,
    "AssociateWithPortalUser": true,
    "AssociatePortalUserTargetEntityField": "sample string 13",
    "IsQBE": true,
    "Entity": null,
    "OptionsSets": [
      {
        "FieldName": "sample string 1",
        "OptionSet": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      },
      {
        "FieldName": "sample string 1",
        "OptionSet": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        ]
      }
    ],
    "ParentEntityType": "sample string 15",
    "ParentEntityAttribute": "sample string 16"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWebForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <WebForm>
    <AssociatePortalUserTargetEntityField>sample string 13</AssociatePortalUserTargetEntityField>
    <AssociateWithPortalUser>true</AssociateWithPortalUser>
    <Entity xmlns:d3p1="http://schemas.microsoft.com/xrm/2011/Contracts" i:nil="true" />
    <FormEntityName>sample string 6</FormEntityName>
    <FormXml>sample string 10</FormXml>
    <Id>sample string 1</Id>
    <IsQBE>true</IsQBE>
    <Name>sample string 2</Name>
    <NextCategory>sample string 8</NextCategory>
    <NextNavigation>sample string 9</NextNavigation>
    <NextWebFormName>sample string 7</NextWebFormName>
    <OptionsSets>
      <OptionSetValues>
        <FieldName>sample string 1</FieldName>
        <OptionSet>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
        </OptionSet>
      </OptionSetValues>
      <OptionSetValues>
        <FieldName>sample string 1</FieldName>
        <OptionSet>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
        </OptionSet>
      </OptionSetValues>
    </OptionsSets>
    <ParentEntityAttribute>sample string 16</ParentEntityAttribute>
    <ParentEntityType>sample string 15</ParentEntityType>
    <ReadOnly>true</ReadOnly>
    <RedirectUrl>sample string 5</RedirectUrl>
    <Text1>sample string 3</Text1>
    <Text2>sample string 4</Text2>
  </WebForm>
  <WebForm>
    <AssociatePortalUserTargetEntityField>sample string 13</AssociatePortalUserTargetEntityField>
    <AssociateWithPortalUser>true</AssociateWithPortalUser>
    <Entity xmlns:d3p1="http://schemas.microsoft.com/xrm/2011/Contracts" i:nil="true" />
    <FormEntityName>sample string 6</FormEntityName>
    <FormXml>sample string 10</FormXml>
    <Id>sample string 1</Id>
    <IsQBE>true</IsQBE>
    <Name>sample string 2</Name>
    <NextCategory>sample string 8</NextCategory>
    <NextNavigation>sample string 9</NextNavigation>
    <NextWebFormName>sample string 7</NextWebFormName>
    <OptionsSets>
      <OptionSetValues>
        <FieldName>sample string 1</FieldName>
        <OptionSet>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
        </OptionSet>
      </OptionSetValues>
      <OptionSetValues>
        <FieldName>sample string 1</FieldName>
        <OptionSet>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
          <OptionSetValue>
            <Id>sample string 1</Id>
            <Name>sample string 2</Name>
          </OptionSetValue>
        </OptionSet>
      </OptionSetValues>
    </OptionsSets>
    <ParentEntityAttribute>sample string 16</ParentEntityAttribute>
    <ParentEntityType>sample string 15</ParentEntityType>
    <ReadOnly>true</ReadOnly>
    <RedirectUrl>sample string 5</RedirectUrl>
    <Text1>sample string 3</Text1>
    <Text2>sample string 4</Text2>
  </WebForm>
</ArrayOfWebForm>