Perform Check is API Builder functionality that allows using if/then statements in a user-friendly way. It checks whether certain conditions are met, and if so, executes the command wrapped between two tags - Perform Check and Close Perform Check.
This article describes the most useful examples for different Verticals:
XML: Provider
Current Utility Provider is a non mandatory parameter in Solar Vertical, which, however, can be required by Buyer Specification.
In this case, Perform Check can be used in order to check whether this parameter was specified in the Lead, and if not - send a default value to the Buyer API.
To configure Perform Check for Provider parameter in XML template, use the following instructions:
1) Enter a Provider tag and put Perform Check and Close Perform Check tags:
2) Put Current Utility Provider tag between two Perform Check tags:
3) Specify the condition on Mapping Panel (Current Utility Provider is specified in the Lead):
4) Put opening and closing Perform Check~1 tags.
5) Enter the default value (e.g., No Provider) between Close Perform Check~1 tags:
6) Specify the second condition on Mapping Panel (Current Utility Provider is not specified in the Lead):
According to these configurations, the Provider is specified in the Lead, the corresponding value will be sent to Buyer API. If no - the default value No Provider will be sent.
HTTP: Dwelling Value
Dwelling Value is a mandatory parameter in Home Vertical. Some Buyers wish to receive Leads with certain limitations on Dwelling Value, for example, only when it is less than $150.000.
Perform Check can be used in order to check this parameter, and if it is higher than is required by Buyer Specification, send a default value that corresponds to the condition.
To configure Perform Check for Dwelling Value parameter in HTTP template, follow these instructions:
1) Enter DwellingValue={ and put Perform Check and Close Perform Check tags:
2) Put Dwelling Value tag between two Perform Check tags:
3) Specify the condition on the Mapping Panel (DwellingValue specified in the Lead is less than $150.000):
4) Put opening and closing Perform Check~1 tags.
5) Enter the default value (e.g., 150000) between Close Perform Check~1 tags:
6) Specify the second condition on Mapping Panel (DwellingValue specified in the Lead is more than $150.000):
According to these configurations, if Dwelling Value specified in the Lead is less than $150.000, this value will be sent to Buyer API. If it exceeds this amount, the default value 150000 will be sent.
JSON: Day Phone Number
Any PX Vertical contains two fields: Phone Number (mandatory) and Day Phone Number (not mandatory). Nevertheless, some Buyer Specifications require the second field.
Perform Check functionality allows to check whether Day Phone Number is specified in the Lead, and if not - to send Phone Number (which is always specified) instead.
To configure Perform Check for Day Phone Number parameter in JSON template, follow these steps:
1) Put Perform Check and Close Perform Check tags:
2) Enter DayPhoneNumber parameter and the corresponding tag between two Perform Check tags:
3) Specify the condition on Mapping Panel (Day Phone Number is specified in the Lead):
4) Put opening and closing Perform Check~1 tags.
5) Enter DayPhoneNumber parameter and Phone Number tag between two Perform Check tags:
6) Specify the second condition on Mapping Panel (Day Phone Number is not specified in the Lead):
According to these configurations, if Day Phone Number is specified in the Lead, it will be sent to Buyer API. If no, Phone Number will be sent instead.
0 comments
Please sign in to leave a comment.