Home / API Platform / Payment as a Service / Engine.Application

Engine.Application


The Application node provides additional parameters to be posted to Salesforce PaaS platform with each transaction.  Through these parameters programmers may take action based on specific conditions or applications uniquely identified through this parameter list.

Path:  CnPAPI.Engine.Application

Elements:
  • ID
  • Name
  • Version
  • CustomParameters

Schema

  <xsd:element name="Application">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element ref="ID" minOccurs="0"/>

        <xsd:element ref="Name" minOccurs="0"/>

        <xsd:element ref="Version" minOccurs="0"/>

        <xsd:element ref="CustomParameters" minOccurs="0"/>       

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

ID

Name  

ID

Path  

CnPAPI.Engine.Application.ID

Description  

Application ID- internal ID number to be posted in Salesforce.

Data Type  

String  

Range  

1-50

Default  

 

Operation  

All operations  

Input/output  

Input  

Version/Release  

2.38 

Required  

No

Example  

<ID>123456</ID>

Schema

  <xsd:element name="ID">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation></xsd:documentation>

      </xsd:annotation>

      <xsd:restriction base="xsd:normalizedString">

        <xsd:maxLength value="50"/>

      </xsd:restriction>

    </xsd:simpleType>

  </xsd:element>

Name

Name  

Name

Path  

CnPAPI.Engine.Application.Name

Description  

Application Name- internal name to be posted in Salesforce.

Data Type  

String  

Range  

1-100

Default  

 

Operation  

All operations  

Input/output  

Input  

Version/Release  

2.38 

Required  

No

Example  

<Name>123456</Name>

Schema

  <xsd:element name="Name">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation></xsd:documentation>

      </xsd:annotation>

      <xsd:restriction base="xsd:normalizedString">

        <xsd:maxLength value="100"/>

      </xsd:restriction>

    </xsd:simpleType>

  </xsd:element>

Version

Name  

Version

Path  

CnPAPI.Engine.Application.Version

Description  

Application version- internal version to be posted in Salesforce.

Data Type  

String  

Range  

1 - 100

Default  

 

Operation  

All operations  

Input/output  

Input  

Version/Release  

2.38 

Required  

No

Example  

<Version>123456</Version>

Schema

      <xsd:element name="Version">

            <xsd:simpleType>

                  <xsd:annotation>

                        <xsd:documentation>Specifies the CnPAPI engine version</xsd:documentation>

                  </xsd:annotation>

                  <xsd:restriction base="xsd:string">

                        <xsd:minLength value="1"/>

                        <xsd:maxLength value="100"/>

                  </xsd:restriction>

            </xsd:simpleType>

      </xsd:element>

CustomParameters

Path:  CnPAPI.Engine.Application.CustomParameters

Elements:

  • Parameter

Schema

  <xsd:element name="CustomParameters">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element ref="Parameter" maxOccurs="unbounded"/>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

Parameters

Path:  CnPAPI.Engine.Application.CustomParameters.Parameter

Elements:

  • Field
  • Value
Schema

  <xsd:element name="Parameter">

    <xsd:complexType>

      <xsd:sequence>

        <xsd:element ref="Field"/>

        <xsd:element ref="Value"/>

      </xsd:sequence>

    </xsd:complexType>

  </xsd:element>

Field

Name  

Field

Path  

CnPAPI.Engine.Application.CustomParameters.Parameter.Field

Description  

Field / Value pair for passing additional parameters

Data Type  

String  

Range  

1 - 100

Default  

 

Operation  

All operations  

Input/output  

Input  

Version/Release  

2.38 

Required  

No

Example  

<Field>Authors</Field>

Schema

  <xsd:element name="Field">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation>Additional information collected from the</xsd:documentation>

      </xsd:annotation>

      <xsd:restriction base="xsd:normalizedString">

        <xsd:maxLength value="100"/>

      </xsd:restriction>

    </xsd:simpleType>

  </xsd:element>

Value

Name  

Value

Path  

CnPAPI.Engine.Application.CustomParameters.Parameter.Value

Description  

Field / Value pair for passing additional parameters

Data Type  

String  

Range  

1 - 100

Default  

 

Operation  

All operations  

Input/output  

Input  

Version/Release  

2.38 

Required  

No

Example  

<Value>John Smith, Suzie Smith</Value>

Schema

  <xsd:element name="Value">

    <xsd:simpleType>

      <xsd:annotation>

        <xsd:documentation><![CDATA[Value to the Field.]]></xsd:documentation>

      </xsd:annotation>

      <xsd:restriction base="xsd:normalizedString">

        <xsd:maxLength value="300"/>

      </xsd:restriction>

    </xsd:simpleType>

  </xsd:element>



    		 RSS of this page