| API Index | Overview | Function | Test form | Type | Result code |
Input parameters
Parameter Type Description Required gender Gender The gender of the person. yes personLastName LastName The last name of the person. yes Data section
This function defines no input data section.
Result codes
An error code is returned when an error occurs during the execution of the implementation.
Name Description _DisabledFunction The function is currently disabled. _InternalError There was an internal error. _InvalidRequest Indicates that the request is considered invalid since it does not match the criteria defined by the specification. _InvalidResponse Indicates that the implementation produced a response that does not match the criteria defined by the specification. Typical callers should treat this like an internal error. NoVowel The name does not contain any vowels. Output parameters
Parameter Type Description Required message _text The message returned to this person. yes Data section
This function defines no output data section.
Example 1: Missing parameter : lastName
Request: http://API_PATH?_function=MyFunction&_convention=_xins-std&personLastName=Bond+007 Response: <?xml version="1.0" encoding="UTF-8"?> <result errorcode="_InvalidRequest"> <data> <missing-param param="gender" /> <invalid-value-for-type type="LastName" param="personLastName" /> </data> </result> Test on: google-app-server mycomputer fakecomputer Example 2: The name does not contain any vowels.
Request: http://API_PATH?_function=MyFunction&_convention=_xins-std&gender=f&personLastName=cqfd Response: <?xml version="1.0" encoding="UTF-8"?> <result errorcode="NoVowel" /> Test on: google-app-server mycomputer fakecomputer Example 3: Message returned.
Request: http://API_PATH?_function=MyFunction&_convention=_xins-std&gender=f&personLastName=Lee Response: <?xml version="1.0" encoding="UTF-8"?> <result> <param name="message">Hello Miss Lee</param> </result> Test on: google-app-server mycomputer fakecomputer