Request - Response Structure Example
For more information, see Crafting HTTP Requests for the AppFxWebService.asmx and Tutorial: Using Fiddler to Compose HTTP SOAP Requests to the AppFxWebService.asmx.
SOAP 1.1 request structure
POST /bbappfx1/appfxwebservice.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Blackbaud.AppFx.WebService.API.1/DataFormLoad"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<DataFormLoadRequest xmlns="Blackbaud.AppFx.WebService.API.1">
<FormID>guid</FormID>
<FormName>string</FormName>
<RecordID>string</RecordID>
<ContextRecordID>string</ContextRecordID>
<IncludeMetaData>boolean</IncludeMetaData>
<IncludeDataFormAddIns>boolean</IncludeDataFormAddIns>
<IncludeDataFormExtensions>boolean</IncludeDataFormExtensions>
<SecurityContext>
<SecurityFeatureID>guid</SecurityFeatureID>
<SecurityFeatureType>None or Form or DataList or RecordOperation or BusinessProcess or Dashboard or SearchList or SimpleDataList or Task or SmartQuery or AdHocQueryView or BatchType or AddCodeTableEntry or UpdateCodeTableEntry or DeleteCodeTableEntry or Batch or BatchTemplate or Kpi or MergeTask or SmartField or GlobalChange or ReportParameter or SystemPrivilege or ConfigurationData or BatchTemplateCustomize or BatchProcessor or Page or MapEntity or ExportDefinition</SecurityFeatureType>
<RecordContext>
<RecordID>string</RecordID>
<RecordType>string</RecordType>
</RecordContext>
<AttributeContext>
<AttributeCategoryID>string</AttributeCategoryID>
</AttributeContext>
</SecurityContext>
<ExcludeValueTranslations>boolean</ExcludeValueTranslations>
<SanitizeHtmlFieldValues>boolean</SanitizeHtmlFieldValues>
<IncludeFieldCharacteristics>boolean</IncludeFieldCharacteristics>
</DataFormLoadRequest>
</soap:Body>
</soap:Envelope>SOAP 1.1 response structure
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<ResponseErrorHeader xmlns="Blackbaud.AppFx.WebService.API.1">
<Name>string</Name>
<ErrorCode>GeneralError or AccessDenied or InvalidAppDatabaseName or InvalidRequest or BadWebConfig or DbTransactionOutOfSync or DbConnectionError or DataFormError or BadMetaData or ServiceExecutionError or BusinessProcessError or InvalidAPIUse or DatabaseRevisionMismatch or InvalidSiteInfoID or InvalidProductIsHash or ProductListNotLoaded or TimeoutError</ErrorCode>
<ErrorText>string</ErrorText>
<ExceptionDetails>string</ExceptionDetails>
<RootRequestName>string</RootRequestName>
<RequestProcessorName>string</RequestProcessorName>
<DataFormErrorInfo>
<ErrorCode>GeneralError or InvalidFieldID or InsufficientFields or InvalidFieldValue or ConcurrencyViolation or RecordNotFound or BBPSGatewayProcessingFailure</ErrorCode>
<ErrorMsg>string</ErrorMsg>
<InvalidFieldID>string</InvalidFieldID>
<InvalidFieldReason>RequiredFldMissing or DataTooLong or InvalidDataFormat or ValueGreaterThanMax or ValueLessThanMin or DataNotUnique or InvalidCodeTableEntry or DBForeignKeyFailure or DBConstraintFailure or CustomException</InvalidFieldReason>
<InvalidFormID>guid</InvalidFormID>
<InvalidFieldCollectionFieldID>string</InvalidFieldCollectionFieldID>
<InvalidFieldPath>string</InvalidFieldPath>
<SQLErrorInfo WasRethrownByStandardHandler="boolean">
<ErrorMessage>string</ErrorMessage>
<ErrorNumber>int</ErrorNumber>
<Severity>int</Severity>
<State>int</State>
<Procedure>string</Procedure>
<LineNumber>int</LineNumber>
<ReThrowingProcedure>string</ReThrowingProcedure>
<IsConcurrencyError>boolean</IsConcurrencyError>
<IsRecordSecurityPermissionError>boolean</IsRecordSecurityPermissionError>
<Instance>int</Instance>
</SQLErrorInfo>
</DataFormErrorInfo>
</ResponseErrorHeader>
</soap:Header>
<soap:Body>
<DataFormLoadReply LastUpdated="dateTime" xmlns="Blackbaud.AppFx.WebService.API.1">
<DataFormItem>
<Values xmlns="bb_appfx_dataforms">
<fv ID="string">
<Value />
<ValueTranslation>string</ValueTranslation>
</fv>
<fv ID="string">
<Value />
<ValueTranslation>string</ValueTranslation>
</fv>
</Values>
</DataFormItem>
<TSLong>long</TSLong>
<FormID>guid</FormID>
<MetaData>
<FormDefinition FixedDialog="boolean" HideBackgroundPanel="boolean">
<FormFields xmlns="bb_appfx_commontypes">
<FormField xsi:nil="true" />
<FormField xsi:nil="true" />
</FormFields>
<FormUIComponent FormUIComponentType="DefaultUI or CustomComponent" xmlns="bb_appfx_commontypes">
<CustomComponentID xsi:nil="true" />
</FormUIComponent>
<WebUIComponent xmlns="bb_appfx_commontypes">
<UIModel xsi:nil="true" />
<WebUI xsi:nil="true" />
</WebUIComponent>
<FieldGroups xmlns="bb_appfx_commontypes">
<FieldGroup xsi:nil="true" />
<FieldGroup xsi:nil="true" />
</FieldGroups>
<Tabs xmlns="bb_appfx_commontypes">
<Tab xsi:nil="true" />
<Tab xsi:nil="true" />
</Tabs>
<UIFields xmlns="bb_appfx_commontypes">
<FormField xsi:nil="true" />
<FormField xsi:nil="true" />
</UIFields>
<UIActions xmlns="bb_appfx_commontypes">
<UIAction xsi:nil="true" />
<UIAction xsi:nil="true" />
</UIActions>
</FormDefinition>
<FormMode>View or Edit or Add</FormMode>
<HelpKey>string</HelpKey>
<CodeTablePerms>
<perm ID="guid" CodeTableName="string" AllowAdd="boolean" AllowUpdate="boolean" AllowDelete="boolean" />
<perm ID="guid" CodeTableName="string" AllowAdd="boolean" AllowUpdate="boolean" AllowDelete="boolean" />
</CodeTablePerms>
<DuplicateRecordCheck SearchListID="guid" IdentifiedDuplicateActionCaption="string" IdentifiedDuplicateActionCaptionResourceKey="string" DuplicateResolutionHeaderCaption="string" DuplicateResolutionHeaderCaptionResourceKey="string" HideSelectButton="boolean" HideIgnoreButton="boolean" HideSearchResults="boolean">
<DuplicateResolutionUIComponent FormUIComponentType="DefaultUI or CustomComponent" xmlns="bb_appfx_commontypes">
<CustomComponentID xsi:nil="true" />
</DuplicateResolutionUIComponent>
</DuplicateRecordCheck>
<FormHeader>string</FormHeader>
<RecordType>string</RecordType>
<ContextRecordType>string</ContextRecordType>
<LastUpdatedSource />
<CustomizedFields>
<CustomFieldCharacteristics IsRequired="boolean" IsHidden="boolean">
<FieldID>string</FieldID>
</CustomFieldCharacteristics>
<CustomFieldCharacteristics IsRequired="boolean" IsHidden="boolean">
<FieldID>string</FieldID>
</CustomFieldCharacteristics>
</CustomizedFields>
</MetaData>
<DataFormAddIns>
<ComponentIdentifier AssemblyName="string" ClassName="string">
<StaticParameters xmlns="bb_appfx_commontypes">
<ParameterList xsi:nil="true" />
</StaticParameters>
</ComponentIdentifier>
<ComponentIdentifier AssemblyName="string" ClassName="string">
<StaticParameters xmlns="bb_appfx_commontypes">
<ParameterList xsi:nil="true" />
</StaticParameters>
</ComponentIdentifier>
</DataFormAddIns>
<DataFormExtensionLoadReplies>
<DataFormExtensionLoadReply RenderStyle="Tab or AfterParent" TabCaption="string">
<LoadReply LastUpdated="dateTime">
<DataFormItem xsi:nil="true" />
<TSLong>long</TSLong>
<FormID>guid</FormID>
<MetaData xsi:nil="true" />
<DataFormAddIns xsi:nil="true" />
<DataFormExtensionLoadReplies xsi:nil="true" />
<SanitizedHtmlFields xsi:nil="true" />
</LoadReply>
</DataFormExtensionLoadReply>
<DataFormExtensionLoadReply RenderStyle="Tab or AfterParent" TabCaption="string">
<LoadReply LastUpdated="dateTime">
<DataFormItem xsi:nil="true" />
<TSLong>long</TSLong>
<FormID>guid</FormID>
<MetaData xsi:nil="true" />
<DataFormAddIns xsi:nil="true" />
<DataFormExtensionLoadReplies xsi:nil="true" />
<SanitizedHtmlFields xsi:nil="true" />
</LoadReply>
</DataFormExtensionLoadReply>
</DataFormExtensionLoadReplies>
<SanitizedHtmlFields>
<string>string</string>
<string>string</string>
</SanitizedHtmlFields>
</DataFormLoadReply>
</soap:Body>
</soap:Envelope>