Set Custom Data

5 min

purpose assigns values to the customer field and custom fields used in the insight portal to collate and categorise sim cards the target device is specified using the \<iccid> element each field setting is optional \<customer> if included, must exactly match a customer entry that has already been configured in the insight portal if an incorrect customer value is supplied, it will be ignored, any existing value will remain unchanged, and the api will still return success \<field x> sets the value of custom field x (where x = 1, 2, 3, or 4) any existing data in the field will be completely overwritten field length limits apply fields 1 and 2 maximum 20 characters fields 3 and 4 maximum 50 characters data longer than the allowed field length will be truncated empty fields will be ignored data must be entered as plain text reserved xml characters must be escaped as described in the xml format section operational impact api commands perform live configuration changes changes take effect immediately commands may affect sim status, service availability, charging, or usage limits requests cannot be undone automatically ensure all parameters are validated before submitting requests to the production environment endpoint post https //api m2miportal com content type application/xml accept application/xml request (xml) \<set custom data version="1" api id="123456"> \<authentication> \<username>username\</username> \<password>password\</password> \</authentication> \<iccid>1234567890123456789\</iccid> \<customer>acme tracking\</customer> \<field 1>hp16 bvv\</field 1> \<field 2>telit cv590\</field 2> \<field 3>vin 1278649998\</field 3> \<field 4>26 the gables, whitmarsh, lancs\</field 4> \</set custom data> response (success) \<set custom data response api id="123456"> \<api outcome>success\</api outcome> \</set custom data response> response (failure) if a request cannot be processed, the response will include api outcome indicating failure an error description explaining the reason failure responses may occur due to invalid authentication credentials invalid or unknown identifiers (for example iccid or msisdn) invalid or missing parameters values not permitted for the specified sim type or account configuration insufficient permissions integrating systems should validate input data before submission and implement appropriate error handling and logging