c2g.CODAAPIMappingFormat_2_0

global with sharing class CODAAPIMappingFormat_2_0

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

the service class relating to mapping formats. these are used when loading data into financialforce accounting from microsoft excel.

Properties

Name	Type	Description
VERSION_STRING	String	the api version.
SERVICE_NAME	String	the name of the service.

Methods

webService static String GetAPIVersion()
webService static String GetServiceName()
webService static c2g.CODAAPICommon.Reference CreateMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat value, String name, boolean overrideExisting)
webService static c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat GetMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPICommon.Reference value)
webService static List<String> GetMappingFormatsByUserAndType(c2g.CODAAPICommon_2_0.Context context, String objectUser, String objectType)

GetAPIVersion

Deprecated: Deprecated: The class has been marked as deprecated so this method will not be available in the future.

webService static String GetAPIVersion()

Used to get the latest API version.

Return Value

Text

GetServiceName

Deprecated: Deprecated: The class has been marked as deprecated so this method will not be available in the future.

webService static String GetServiceName()

Used to get the name of the service.

Return Value

Text

CreateMappingFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPICommon.Reference CreateMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat value, String name, boolean overrideExisting)

This service allows you to create a data map for loading data into FinancialForce using Microsoft Excel. See the FinancialForce XL Help for more information. Use MangeXL (Manage XL) custom permission to grant permissions on this method.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_2_0.Context	Identifies the FinancialForce company in which the current operation executes.
value	c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat	Holds details of the mapping format you want to create.
name	String	The name of an existing mapping format that you want to override. Leave this blank if you do not want to override an existing mapping format.
overrideExisting	boolean	Set to true if you want this mapping format to override the existing format identified by the 'name' parameter.

Return Value

This web service returns a CODAAPICommon.Reference object.

GetMappingFormat

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat GetMappingFormat(c2g.CODAAPICommon_2_0.Context context, c2g.CODAAPICommon.Reference value)

This service allows you to retrieve a mapping format.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_2_0.Context	Identifies the FinancialForce company in which the current operation executes.
value	c2g.CODAAPICommon.Reference	Identifies the mapping format you want to retrieve.

Return Value

This web service returns a c2g.CODAAPIMappingFormatTypes_2_0.MappingFormat object.

GetMappingFormatsByUserAndType

Deprecated: Deprecated: Use the Salesforce API for CRUD operations.

webService static List<String> GetMappingFormatsByUserAndType(c2g.CODAAPICommon_2_0.Context context, String objectUser, String objectType)

This service allows you to retrieve mapping formats by user or object type.

Input Parameters

Name	Type	Description
context	c2g.CODAAPICommon_2_0.Context	Identifies the FinancialForce company in which the current operation executes.
objectUser	String	The user you are interested in.
objectType	String	The object type you are interested in.

Return Value

This web service returns a list of String objects.