Merge pull request #21 from camaraproject/jgarciahospital-patch-4

Update APi actions descriptions
camaraproject · Oct 8, 2024 · bc93243 · bc93243
2 parents 15340e3 + c7296c8
commit bc93243
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/code/API_definitions/device-swap.yaml b/code/API_definitions/device-swap.yaml
@@ -25,9 +25,9 @@ info:
       
       The API provides 2 operations:
 
-        - POST retrieve-date: Provides timestamp of latest device swap for a given phone number. If no device swap has been performed, the API will return the first phone number usage in the device (the timestamp of the first time that the phone number was connected to the network, it is, the first time that the SIM is installed in the device) by default, unless this is not possible due to local regulations preventing the safekeeping of the information for longer than the stated period. If this is the case, a `null` value will be returned.
+        - POST retrieve-date: Provides timestamp of latest device swap for a given phone number. If no device swap has been performed, the API will return the first phone number usage in the device (the timestamp of the first time that the phone number was connected to the network, it is, the first time that the SIM is installed in the device) by default. It will return an empty string in case is not possible to retrieve the date (e.g. in case local regulations are preventing the safekeeping of the information for longer than the stated period, or in some edge error cases). In case no data is available in the operators records (e.g. no recorded event), API will return a 422 error.
+        - POST check: Checks if device swap has been performed during a past period (defined in the request with 'maxAge' attribute) for a given phone number, the API will return boolean response (true/false), indicating that the device has been swapped or not in the specified period. In case the phone number has never been installed in a device, or no data is available in the operators records (e.g. database error), API will return a 422 error.
 
-        - POST check: Checks if device swap has been performed during a past period (defined in the request with `maxAge` attribute) for a given phone number, the API will return boolean response (true/false), indicating that the device has been swapped or not in the specified period
 
         So, when consuming this operation, the following scenarios will exist: