GET api/WebForm?name={name}

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

NameDescriptionTypeAdditional information
name

System.String

Required

Body Parameters

None.

Response Information

Resource Description

Altai.Web.Services.Models.WebForm
NameDescriptionTypeAdditional information
Id

System.String

None.

Name

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.

IsQBE

System.Boolean

None.

Entity

Altai.Web.Services.Models.Entity

None.

OptionsSets

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

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "RedirectUrl": "sample string 3",
  "FormEntityName": "sample string 4",
  "NextWebFormName": "sample string 5",
  "NextCategory": "sample string 6",
  "NextNavigation": "sample string 7",
  "FormXml": "sample string 8",
  "ReadOnly": true,
  "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"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<WebForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
  <Entity xmlns:d2p1="http://schemas.microsoft.com/xrm/2011/Contracts" i:nil="true" />
  <FormEntityName>sample string 4</FormEntityName>
  <FormXml>sample string 8</FormXml>
  <Id>sample string 1</Id>
  <IsQBE>true</IsQBE>
  <Name>sample string 2</Name>
  <NextCategory>sample string 6</NextCategory>
  <NextNavigation>sample string 7</NextNavigation>
  <NextWebFormName>sample string 5</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>
  <ReadOnly>true</ReadOnly>
  <RedirectUrl>sample string 3</RedirectUrl>
</WebForm>