Shared Preference API

What is Shared Preference?

Write / Read String Value

Write String Key

POST http://lyour_local_ip:49761/sharedpreference/write/string/

Save a new string value. The following parameters must be in the same JSON in the body.

Request Body

Name	Type	Description
key*	myStringKey	With which key you want to save your string value
value*	myStringValue	The string value you want to save

200: OK If all parameters are correct, your key and value have been successfully saved.

400: Bad Request ERROR CODE: 41001 Deserialization error. Check the format of your request data.

500: Internal Server Error ERROR CODE: 41002 Internal server error. Please try again later.

500: Internal Server Error ERROR CODE: 41003 Something unexpected happened on the server.

Read String Key

GET http://lyour_local_ip:49761/sharedpreference/read/string/

Read the string value you saved before.

Query Parameters

Name	Type	Description
key*	myStringKey	Your data key
defaultValue*	myDefaultValue	If key is null return default value

200: OK If all parameters are true and the key is found, the value of the key is returned as the answer. If the key was not found, the defaultValue parameter you sent will be returned.

400: Bad Request If some of the parameters you send are wrong, you will get error code 400.

Write / Read Integer Value

Write Integer Key

POST http://lyour_local_ip:49761/sharedpreference/write/int/

Save a new integer value. The following parameters must be in the same JSON in the body.

Request Body

Name	Type	Description
key*	myIntegerKey	With which key you want to save your integer value
value*	myIntegerValue	The integer value you want to save

200: OK If all parameters are correct, your key and value have been successfully saved.

400: Bad Request ERROR CODE: 61001 Deserialization error. Check the format of your request data.

500: Internal Server Error ERROR CODE: 61002 Internal server error. Please try again later.

500: Internal Server Error ERROR CODE: 61003 Something unexpected happened on the server.

Read Integer Key

GET http://lyour_local_ip:49761/sharedpreference/read/int/

Read the integer value you saved before.

Query Parameters

Name	Type	Description
key*	myIntKey	Your data key
defaultValue*	myDefaultValue	If key is null return default value

200: OK If all parameters are true and the key is found, the value of the key is returned as the answer. If the key was not found, the defaultValue parameter you sent will be returned.

400: Bad Request If some of the parameters you send are wrong, you will get error code 400.

Write / Read Boolean Value

Write Boolean Key

POST http://lyour_local_ip:49761/sharedpreference/write/boolean/

Save a new boolean value. The following parameters must be in the same JSON in the body.

Request Body

Name	Type	Description
key*	myBooleanKey	With which key you want to save your boolean value
value*	myBooleanValue	The boolean value you want to save

200: OK If all parameters are correct, your key and value have been successfully saved.

400: Bad Request ERROR CODE: 61001 Deserialization error. Check the format of your request data.

500: Internal Server Error ERROR CODE: 61002 Internal server error. Please try again later.

500: Internal Server Error ERROR CODE: 61003 Something unexpected happened on the server.

Read Boolean Key

GET http://lyour_local_ip:49761/sharedpreference/read/boolean/

Read the boolean value you saved before.

Query Parameters

Name	Type	Description
key*	myBooleanKey	Your data key
defaultValue*	myDefaultValue	If key is null return default value

200: OK If all parameters are true and the key is found, the value of the key is returned as the answer. If the key was not found, the defaultValue parameter you sent will be returned.

400: Bad Request If some of the parameters you send are wrong, you will get error code 400.

Remove Key / Remove All Key

Delete Key

DELETE http://lyour_local_ip:49761/sharedpreference/remove

Delete specific key

Query Parameters

Name	Type	Description
key*	myKey	The key you want to delete

200: OK If all parameters are true the key you sent has been successfully deleted.

400: Bad Request If some of the parameters you send are wrong, you will get error code 400.

Delete All Keys

DELETE http://lyour_local_ip:49761/sharedpreference/remove/all

Delete all keys in preference file

200: OK All SharedPreference removed.

400: Bad Request Internal Server Error