getDefaultGUI

Parameters

recordId is the record ID for which to retrieve the default GUI.

Returns

The default GUI object for the given record is returned.

Errors

RecordDoesNotExistException

A record with the specified ID does not exist.

GuiDoesNotExistException

The record does not have a default GUI associated with it.

java.lang.Exception

A system error occurred when the request was being processed.

AccessException

The user does not have access to the form or record.

Sample request

<soapenv:Envelope 
	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:ws="http://ws.tririga.com">
   <soapenv:Body>
      <ws:getDefaultGUI>
         <ws:recordId>2535762</ws:recordId>
      </ws:getDefaultGUI>
   </soapenv:Body>
</soapenv:Envelope>

Sample response

<soap:Envelope 
	xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <getDefaultGUIResponse xmlns="http://ws.tririga.com">
         <out>
            <childRecordId xmlns="http://gui.dto.ws.tririga.com">0</childRecordId>
            <id xmlns="http://gui.dto.ws.tririga.com">10002954</id>
            <label xmlns="http://gui.dto.ws.tririga.com">Building</label>
            <moduleId xmlns="http://gui.dto.ws.tririga.com">6</moduleId>
            <moduleName xmlns="http://gui.dto.ws.tririga.com">Location</moduleName>
            <name xmlns="http://gui.dto.ws.tririga.com">triBuilding</name>
            <objectTypeId xmlns="http://gui.dto.ws.tririga.com">10002100</objectTypeId>
            <objectTypeName xmlns="http://gui.dto.ws.tririga.com">triBuilding</objectTypeName>
            <popupId xmlns="http://gui.dto.ws.tririga.com">0</popupId>
            <recordId xmlns="http://gui.dto.ws.tririga.com">2535762</recordId>
            <recordName xmlns="http://gui.dto.ws.tririga.com">My Building</recordName>
            <saveOnPopup xmlns="http://gui.dto.ws.tririga.com">false</saveOnPopup>
            <singleTab xmlns="http://gui.dto.ws.tririga.com">false</singleTab>
            <state xmlns="http://gui.dto.ws.tririga.com">triRevision</state>
            <tabs xmlns="http://gui.dto.ws.tririga.com">
               <Tab>
                  <id>9999</id>
                  <instruction xsi:nil="true"/>
                  <label xsi:nil="true"/>
                  <name>System Info</name>
                  <sections>
                     <Section>
                        <fields>
                           <Field>
                              <dataType xsi:nil="true"/>
                              <displayValue xsi:nil="true"/>
                              <guiRootClassificationId>0</guiRootClassificationId>
                              <guiRootClassificationName xsi:nil="true"/>
                              <guiSectionId>0</guiSectionId>
                              <guiSectionName xsi:nil="true"/>
                              <label>Review Status</label>
                              <listId>0</listId>
                              <listModuleId>0</listModuleId>
                              <liveLink>false</liveLink>
                              <locatorField>false</locatorField>
                              <locatorModuleId>0</locatorModuleId>
                              <mobileField>false</mobileField>
                              <mobileFieldSeq>0</mobileFieldSeq>
                              <name>Review Status</name>
                              <readOnly>false</readOnly>
                              <refObjectTypeId>0</refObjectTypeId>
                              <refSpecId>0</refSpecId>
                              <required>false</required>
                              <rootClassification>~</rootClassification>
                              <rootClassificationId>0</rootClassificationId>
                              <sectionName>System Info</sectionName>
                              <specId>2535762</specId>
                              <type>Text</type>
                              <unitOfMeasure/>
                              <unitOfMeasureType>0</unitOfMeasureType>
                              <value/>
                           </Field>                        </fields>
                        <guiSectionId>0</guiSectionId>
                        <guiSectionName xsi:nil="true"/>
                        <id>1</id>
                        <label>System Info</label>
                        <name>System Info</name>
                        <readOnly>false</readOnly>
                        <refModuleId>0</refModuleId>
                        <refObjectTypeId>0</refObjectTypeId>
                        <rows xsi:nil="true"/>
                        <type>GUI Section</type>
                        <typeId>0</typeId>
                        <visible>false</visible>
                     </Section>                  </sections>
                  <tabInformation>triRevision</tabInformation>
                  <url xsi:nil="true"/>
                  <visible>false</visible>
               </Tab>
            </tabs>
            <type xmlns="http://gui.dto.ws.tririga.com">Wizard</type>
         </out>
      </getDefaultGUIResponse>
   </soap:Body>
</soap:Envelope>