The ClickBook API supports the update of existing user-specific data and the creation of new user-specific data in some cases. The API provides a mechanism that describes "groups" (schemas) of "Items" (fields) and their properties for consumption by user interfaces. The properties of Items are used in the back-end to validate input.
In the following example, the schema is retrieved for registering a new end-user (business customer).
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope>
<soapenv:Body>
<ns1:GETSCHEMAITEMGROUPResponse xmlns:ns1="urn:DefaultNamespace">
<GETSCHEMAITEMGROUPReturn>
<SCHEMA>NewUserRegistration</SCHEMA>
<CONTEXTFORM />
<CONTEXTID />
<ITEM>
<TITLE>First Name</TITLE>
<UIALIAS>inp-firstname</UIALIAS>
<FLAGS>YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Last Name</TITLE>
<UIALIAS>inp-lastname</UIALIAS>
<FLAGS>YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Contact Number</TITLE>
<UIALIAS>inp-telfixed</UIALIAS>
<FLAGS>N YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Mobile Number</TITLE>
<UIALIAS>inp-telmobile</UIALIAS>
<FLAGS>NV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Email Address</TITLE>
<UIALIAS>inp-emailaddress1</UIALIAS>
<FLAGS>E YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Confirm Email Address</TITLE>
<UIALIAS>inp-emailaddress2</UIALIAS>
<FLAGS>E YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Create Password</TITLE>
<UIALIAS>inp-password1</UIALIAS>
<FLAGS>P YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Confirm Password</TITLE>
<UIALIAS>inp-password2</UIALIAS>
<FLAGS>P YV</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Agree to Terms & Conditions</TITLE>
<UIALIAS>inp-agreeterms</UIALIAS>
<FLAGS>T Y</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>TimeZone</TITLE>
<UIALIAS>inp-timezone</UIALIAS>
<FLAGS>Y</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:nil="true" />
</ITEM>
<ITEM>
<TITLE>Country</TITLE>
<UIALIAS>inp-country</UIALIAS>
<FLAGS>O Y</FLAGS>
<VALUES xsi:nil="true" />
<DEFAULT xsi:nil="true" />
<OPTIONS xsi:type="soapenc:Array" soapenc:arrayType="xsd:string[238]">
<item />
<item>United States</item>
<item>Australia</item>
<item>New Zealand</item>
<item>United Kingdom</item>
<item>Canada</item>
<item />
<item>Afghanistan</item>
<item>Albania</item>
<item>Algeria</item>
<item>American Samoa</item>
<item>Andorra</item>
<item>Angola</item>
<item>Anguilla</item>
<item>Antarctica</item>
<item>Antigua and Barbuda</item>
<item>Argentina</item>
<item>Armenia</item>
<item>Aruba</item>
<item>Austria</item>
<item>Azerbaijan</item>
<item>Bahamas</item>
<item>Bahrain</item>
<item>Bangladesh</item>
<item>Barbados</item>
<item>Belarus</item>
<item>Belgium</item>
<item>Belize</item>
<item>Benin</item>
<item>Bermuda</item>
<item>Bhutan</item>
<item>Bolivia</item>
<item>Bosnia and Herzegovina</item>
<item>Botswana</item>
<item>Bouvet Island</item>
<item>Brazil</item>
<item>British Indian Ocean Territory</item>
<item>Brunei Darussalam</item>
<item>Bulgaria</item>
<item>Burkina Faso</item>
<item>Burundi</item>
<item>Cambodia</item>
<item>Cameroon</item>
<item>Cape Verde</item>
<item>Caribbean Islands</item>
<item>Cayman Islands</item>
<item>Central African Republic</item>
<item>Chad</item>
<item>Chile</item>
<item>China</item>
<item>Christmas Island</item>
<item>Cocos (Keeling) Islands</item>
<item>Colombia</item>
<item>Comoros</item>
<item>Congo</item>
<item>Cook Islands</item>
<item>Costa Rica</item>
<item>Cote D'Ivoire</item>
<item>Croatia</item>
<item>Cyprus</item>
<item>Czech Republic</item>
<item>Denmark</item>
<item>Djibouti</item>
<item>Dominica</item>
<item>Dominican Republic</item>
<item>East Timor</item>
<item>Ecuador</item>
<item>Egypt</item>
<item>El Salvador</item>
<item>Equatorial Guinea</item>
<item>Eritrea</item>
<item>Estonia</item>
<item>Ethiopia</item>
<item>Falkland Islands (Malvinas)</item>
<item>Faroe Islands</item>
<item>Fiji</item>
<item>Finland</item>
<item>France</item>
<item>France, Metropolitan</item>
<item>French Guiana</item>
<item>French Polynesia</item>
<item>French Southern Territories</item>
<item>Gabon</item>
<item>Gambia</item>
<item>Georgia</item>
<item>Germany</item>
<item>Ghana</item>
<item>Gibraltar</item>
<item>Greece</item>
<item>Greenland</item>
<item>Grenada</item>
<item>Guadeloupe</item>
<item>Guam</item>
<item>Guatemala</item>
<item>Guinea-Bissau</item>
<item>Guinea</item>
<item>Guyana</item>
<item>Haiti</item>
<item>Heard Island and McDonald Islands</item>
<item>Honduras</item>
<item>Hong Kong</item>
<item>Hungary</item>
<item>Iceland</item>
<item>India</item>
<item>Indonesia</item>
<item>Ireland</item>
<item>Israel</item>
<item>Italy</item>
<item>Jamaica</item>
<item>Japan</item>
<item>Jordan</item>
<item>Kazakhstan</item>
<item>Kenya</item>
<item>Kiribati</item>
<item>Korea, Republic of</item>
<item>Kuwait</item>
<item>Kyrgyzstan</item>
<item>Lao People's Democratic Republic</item>
<item>Latvia</item>
<item>Lebanon</item>
<item>Lesotho</item>
<item>Liberia</item>
<item>Liechtenstein</item>
<item>Lithuania</item>
<item>Luxembourg</item>
<item>Macau</item>
<item>Macedonia</item>
<item>Madegascar</item>
<item>Malawi</item>
<item>Malaysia</item>
<item>Maldives</item>
<item>Mali</item>
<item>Malta</item>
<item>Marshall Islands</item>
<item>Martinique</item>
<item>Mauritania</item>
<item>Mauritius</item>
<item>Mayotte</item>
<item>Mexico</item>
<item>Micronesia</item>
<item>Moldova, Republic of</item>
<item>Monaco</item>
<item>Mongolia</item>
<item>Montserrat</item>
<item>Morocco</item>
<item>Mozambique</item>
<item>Myanmar</item>
<item>Namibia</item>
<item>Nauru</item>
<item>Nepal</item>
<item>Netherlands Antilles</item>
<item>Netherlands</item>
<item>New Caledonia</item>
<item>Nicaragua</item>
<item>Niger</item>
<item>Nigeria</item>
<item>Niue</item>
<item>Norfolk Island</item>
<item>Northern Mariana Islands</item>
<item>Norway</item>
<item>N. Korea</item>
<item>Oman</item>
<item>Other</item>
<item>Pakistan</item>
<item>Pakistan</item>
<item>Palau</item>
<item>Panama</item>
<item>Papua New Guinea</item>
<item>Paraguay</item>
<item>Peru</item>
<item>Phillippines</item>
<item>Pitcairn</item>
<item>Poland</item>
<item>Portugal</item>
<item>Puerto Rico</item>
<item>Qatar</item>
<item>Reunion</item>
<item>Romania</item>
<item>Russian Federation</item>
<item>Rwanda</item>
<item>Saint Helena</item>
<item>Saint Kitts and Nevis</item>
<item>Saint Lucia</item>
<item>Saint Pierre and Miquelon</item>
<item>Saint Vincent and the Grenadines</item>
<item>Samoa</item>
<item>San Marino</item>
<item>Sao Tome and Principe</item>
<item>Saudi Arabia</item>
<item>Senegal</item>
<item>Seychelles</item>
<item>Sierra Leone</item>
<item>Singapore</item>
<item>Slovakia</item>
<item>Slovenia</item>
<item>Solomon Islands</item>
<item>Somalia</item>
<item>South Africa</item>
<item>South Georgia and the South Sandwich</item>
<item>Spain</item>
<item>Sri Lanka</item>
<item>Sudan</item>
<item>Suriname</item>
<item>Svalbard and Jan Mayen</item>
<item>Swaziland</item>
<item>Sweden</item>
<item>Switzerland</item>
<item>Taiwan</item>
<item>Tajikistan</item>
<item>Tanzania</item>
<item>Thailand</item>
<item>Togo</item>
<item>Tokelau</item>
<item>Tonga</item>
<item>Trinidad and Tobago</item>
<item>Tunisia</item>
<item>Turkey</item>
<item>Turkmenistan</item>
<item>Turks and Caicos Islands</item>
<item>Tuvalu</item>
<item>Uganda</item>
<item>Ukraine</item>
<item>United Arab Emirates</item>
<item>Uruguay</item>
<item>Uzbekistan</item>
<item>Vanautu</item>
<item>Vatican City State</item>
<item>Venezuela</item>
<item>Viet Nam</item>
<item>Virgin Islands (British)</item>
<item>Virgin Islands (U.S.)</item>
<item>Wallis and Futuna Islands</item>
<item>Western Sahara</item>
<item>Yemen</item>
<item>Yugoslavia</item>
<item>Zaire</item>
<item>Zambia</item>
<item>Zimbabwe</item>
</OPTIONS>
</ITEM>
</GETSCHEMAITEMGROUPReturn>
</ns1:GETSCHEMAITEMGROUPResponse>
</soapenv:Body>
</soapenv:Envelope>