diff --git a/user-device-info/README.md b/user-device-info/README.md new file mode 100644 index 00000000..6a375927 --- /dev/null +++ b/user-device-info/README.md @@ -0,0 +1,49 @@ +# User Device Info + +## User Device Info object + +```json +{ + "userId": "String", + "deviceType": "String" +} +``` + +## **Requests** + +| Route | Description | +| :------------------------------------------: | :----------------------------: | +| [POST /userDeviceInfo](#post-userDeviceInfo) | Stores user id and device type | + +## **POST /userDeviceInfo** + +Stores user id and device type + +- **Params** + None +- **Query** + None +- **Headers** + Content-Type: application/json +- **Body** `{ }` +- **Success Response:** +- **Code:** 200 + + - **Content:** + ```json + { + "message": "User Device Info stored successfully!", + "userDeviceInfo": "" + } + ``` + +- **Error Response:** + - **Code:** 500 + - **Content:** + ```json + { + "statusCode": 500, + "error": "Internal Server Error", + "message": "An internal server error occurred" + } + ```