Pre-validate properties of objects which have not been saved
This endpoint is used to validate that a proposed value is acceptable for a certain field. For example, we use it to tell our enduser working in the ui, that the value they are currently entering into a field, does or does not pass uniqueness requirements. <p>The field to check is implicit in the queryparam you use. See the possible queryparams and which fields they validate below.</p> <p>While this endpoint allows you to specify more than one queryparam, and a 200 response indicates that ALL of the proposed values are ok, a 400 response only indicates that there is a problem without fully disambiguating which proposals are invalid and which are not. Therefore, it is suggested that you check one at a time.</p>
Request
- Base URLhttps://api.alianza.com
- AuthAPI key in header X-AUTH-TOKEN
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
ID of partition
Query parameters
Value proposed for <a href="#/~schema/Account">account.number</a>. Value is unacceptable if another account in this partition has this accountNumber.
Value proposed for <a href = "#/~schema/DeviceX">device.macAddress</a>. Value is not acceptable if the mac is found in use elsewhere in the system (even in another partition).
Value proposed for <a href = "#/~schema/DeviceX">device.sipUsername</a>. Value is not acceptable if found in use anywhere else in the system (even in another partition).
Value proposed for <a href="#/~schema/EndUserV2X">enduser.username</a>. Value is unacceptable if another user (even in another partition) has the same username.
Response
All of your proposed values are acceptable
Changes
No recorded changes to this operation across all 1 revision of this API.