ApexERPHost

<back to all web services

GetDynamicFormsAllowed

Requires Authentication
The following routes are available for this service:
GET/Core/Dynamic/Forms/Allowed
GET/Core/Dynamic/Forms/ByCategory/{CategoryID}/Allowed
GetDynamicFormsAllowed Parameters:
NameParameterData TypeRequiredDescription
CategoryIDpathGuid?No
GetDynamicFormsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<DynamicForm>No
DynamicForm Parameters:
NameParameterData TypeRequiredDescription
UnIdformGuidNo
NameformstringNo
DescriptionformstringNo
TypeformintNo
DataSourceIdformGuid?No
DataSourceformDynamicDataSourceNo
CategoryIdformGuid?No
ScriptformstringNo
DynamicPopupsformList<DynamicPopup>No
HCodeformstringNo
Visibilityformbool?No
ParamsformFormObjParamsNo
DynamicDataSource Parameters:
NameParameterData TypeRequiredDescription
DsIdformGuidNo
NameformstringNo
DescriptionformstringNo
QueryformstringNo
HasDatesformboolNo
CategoryIdformGuidNo
ParamsformList<DynamicDataSourceParam>No
HccrtformstringNo
Usedformbool?No
HasParamsformbool?No
HCodeformstringNo
DynamicDataSourceParam Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
DescriptionformstringNo
DataSourceIdformGuidNo
DbTypeformstringNo
SizeformintNo
QueryIdformGuid?No
FormatformstringNo
IsNullableformboolNo
OrderIndexformintNo
DynamicPopup Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DataformDynamicPopupDataNo
DynamicPopupData Parameters:
NameParameterData TypeRequiredDescription
FormUnIdformGuidNo
FormLayoutIdformint?No
PriorityformintNo
HideFormParamsformboolNo
ParamsMapformDictionary<string, string>No
ShowAsDialogformbool?No
FormObjParams Parameters:
NameParameterData TypeRequiredDescription
ShowInMenuformbool?No
ImageformstringNo
LargeImageformstringNo
OrderIndexformint?No
ParentFormTypeformstringNo

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.

GET /Core/Dynamic/Forms/Allowed HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDynamicFormsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apex.Services">
  <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>
  <Result>
    <DynamicForm>
      <UnId>00000000-0000-0000-0000-000000000000</UnId>
      <Name>String</Name>
      <Description>String</Description>
      <Type>0</Type>
      <DataSourceId>00000000-0000-0000-0000-000000000000</DataSourceId>
      <DataSource>
        <DsId>00000000-0000-0000-0000-000000000000</DsId>
        <Name>String</Name>
        <Description>String</Description>
        <Query>String</Query>
        <HasDates>false</HasDates>
        <CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
        <Params>
          <DynamicDataSourceParam>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <Name>String</Name>
            <Description>String</Description>
            <DataSourceId>00000000-0000-0000-0000-000000000000</DataSourceId>
            <DbType>String</DbType>
            <Size>0</Size>
            <QueryId>00000000-0000-0000-0000-000000000000</QueryId>
            <Format>String</Format>
            <IsNullable>false</IsNullable>
            <OrderIndex>0</OrderIndex>
          </DynamicDataSourceParam>
        </Params>
        <Hccrt>String</Hccrt>
        <Used>false</Used>
        <HasParams>false</HasParams>
        <HCode>String</HCode>
      </DataSource>
      <CategoryId>00000000-0000-0000-0000-000000000000</CategoryId>
      <Script>String</Script>
      <DynamicPopups>
        <DynamicPopup>
          <Id>0</Id>
          <Name>String</Name>
          <Data>
            <FormUnId>00000000-0000-0000-0000-000000000000</FormUnId>
            <FormLayoutId>0</FormLayoutId>
            <Priority>0</Priority>
            <HideFormParams>false</HideFormParams>
            <ParamsMap xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </ParamsMap>
            <ShowAsDialog>false</ShowAsDialog>
          </Data>
        </DynamicPopup>
      </DynamicPopups>
      <HCode>String</HCode>
      <Visibility>false</Visibility>
      <Params>
        <ShowInMenu>false</ShowInMenu>
        <Image>String</Image>
        <LargeImage>String</LargeImage>
        <OrderIndex>0</OrderIndex>
        <ParentFormType>String</ParentFormType>
      </Params>
    </DynamicForm>
  </Result>
</GetDynamicFormsResponse>