Get Required Fields

GET https://uat.api.globalpay.convera.com/geo-api/buyerFields

Provides a list of configured fields and their details for a specified clientId

XSD

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:tns="http://api.globalpay.convera.com" targetNamespace="http://api.globalpay.convera.com" elementFormDefault="qualified" attributeFormDefault="unqualified" vc:minVersion="1.1">
    <xs:include schemaLocation="common.xsd"/>

    <xs:element name="buyerFieldsRequest" type="tns:BuyerFieldsRequestType"/>
    <xs:complexType name="BuyerFieldsRequestType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractInputType">
                <xs:sequence>
                    <xs:element name="clientId" type="xs:long" minOccurs="0" />
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <xs:element name="buyerFieldsResponse" type="tns:BuyerFieldsResponseType"/>
    <xs:complexType name="BuyerFieldsResponseType">
        <xs:complexContent>
            <xs:extension base="tns:AbstractOutputType">
                <xs:sequence>
                    <xs:element name="fields" type="tns:BuyerFields" />
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>

    <xs:complexType name="BuyerFields">
        <xs:sequence>
            <xs:element name="field" type="tns:Field" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="Field">
        <xs:sequence>
            <xs:element name="labelText" type="tns:String255Type"/>
            <xs:element name="name" type="tns:String255Type" />
            <xs:element name="display" type="xs:boolean" minOccurs="0" />
            <xs:element name="mandatory" type="xs:boolean"  />
            <xs:element name="description" type="tns:String255Type"  />
            <xs:element name="type" type="tns:fieldsTypeRestriction"  />
            <xs:element name="minLength" type="xs:integer" minOccurs="0" />
            <xs:element name="maxLength" type="xs:integer" minOccurs="0" />
            <xs:element name="sequence" type="xs:integer"  />
            <xs:element name="validationExpression" type="tns:String255Type" minOccurs="0" />
            <xs:element name="values" type="tns:FieldValues" minOccurs="0" />
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="FieldValues">
        <xs:sequence>
            <xs:element name="value" type="tns:String255Type" minOccurs="1" maxOccurs="unbounded"/>
        </xs:sequence>
    </xs:complexType>

</xs:schema>

Sample Input

<buyerFieldsRequest xmlns="http://api.globalpay.convera.com">
    <clientId>123456789</clientId>
</buyerFieldsRequest>

Sample Response

<buyerFieldsResponse xmlns="http://api.globalpay.convera.com" xmlns:tns="http://api.globalpay.convera.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <status success="true"/>
    <fields>
        <field>
            <labelText>Student ID</labelText>
            <name>businessId</name>
            <display>true</display>
            <mandatory>true</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>10</maxLength>
            <sequence>1</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Student First Name</labelText>
            <name>firstName</name>
            <display>true</display>
            <mandatory>true</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>2</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Student last name</labelText>
            <name>lastName</name>
            <display>true</display>
            <mandatory>true</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>3</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Street Address</labelText>
            <name>address</name>
            <display>true</display>
            <mandatory>true</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>4</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>City</labelText>
            <name>city</name>
            <display>true</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>5</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>State/Province</labelText>
            <name>state</name>
            <display>true</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>6</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Zip/Postal Code</labelText>
            <name>zip</name>
            <display>true</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <minLength>0</minLength>
            <maxLength>40</maxLength>
            <sequence>7</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Email Address</labelText>
            <name>email</name>
            <display>true</display>
            <mandatory>true</mandatory>
            <description/>
            <type>email</type>
            <minLength>7</minLength>
            <maxLength>40</maxLength>
            <sequence>8</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>Level of Study</labelText>
            <name>debtorGroup</name>
            <display>false</display>
            <mandatory>false</mandatory>
            <description/>
            <type>select</type>
            <maxLength>40</maxLength>
            <sequence>9</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>custom1</labelText>
            <name>custom1</name>
            <display>false</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <sequence>10</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>custom2</labelText>
            <name>custom2</name>
            <display>false</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <sequence>11</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
        <field>
            <labelText>custom3</labelText>
            <name>custom3</name>
            <display>false</display>
            <mandatory>false</mandatory>
            <description/>
            <type>text</type>
            <sequence>12</sequence>
            <validationExpression/>
            <values>
                <value/>
            </values>
        </field>
    </fields>
</buyerFieldsResponse>