Removing the MessageType Field from an Upgraded .NET Framework Web API Project

After upgrading a .NET Framework Web API project to ePortal Developer 11.0, you might see the MessageType field in the request and response content of the Web API .

If you do not want to include the MessageType field in the Web API request and response definitions for compatibility reasons, perform the following steps to remove:

  1. Create a new solution and then create a .NET Framework Web API project on the recent ePortal Developer 11.0 IC.

  2. Copy the DataAnnotationsSchemaFilter.cs and ResponseFilter.cs files from the App_Start folder of the newly created .NET Framework Web API project and paste them into the App_Start folder of the upgraded Web API presentation project.

  3. From the Solution Explorer window of the upgraded project, navigate to the App_Start folder, right-click Add Existing Item, navigate to the folder App_Start, and add the DataAnnotationsSchemaFilter.cs and ResponseFilter.cs files.

  4. Double click the DataAnnotationsSchemaFilter.cs file to edit.

  5. Change the NameSpace to the respective project name or you can copy the namespace from any other file (for example, FilterConfig.cs) that is available in the same folder of the upgraded .NET Framework Web API project.

  6. Double click the ResponseFilter.cs file to edit.

  7. Change the NameSpace to the respective project name or you can copy the namespace from any other file (for example, FilterConfig.cs) that is available in the same folder of the upgraded .NET Framework Web API project.

  8. Open the SwaggerConfig.cs file from the App_Start folder.

  9. Register the DataAnnotationsSchemaFilter schema filter in the EnableSwagger method as shown in the following code sample if it is not registered. Skip this step if is it is already registered.

    public static void Register()
     {
GlobalConfiguration.Configuration.EnableSwagger(c =>
          {
           //Code
           c.SchemaFilter <DataAnnotationsSchemaFilter>();
           //Code
           }
     {

  10. On the Web API controller, add the [ResponseFilter] annotation at the controller level for all the controllers as shown in the following code:

    [ResponseFilter]
public partial class <ControllerName>Controller:
<ControllerName>ControllerBase { }

  11. Double-click the Web.config file under the Web API presentation project node and add the following new key to the <appSettings> element.

     <add key="IncludeMessageTypeField" value="false"/>

  12. Save and build the solution.