API to edit an existing unit

[franck-boullier]

How it should work:

Input:

THIS NEEDS TO BE UPDATED IN LINE WITH WHAT WAS DISCUSSED IN #3

• requestorAPIKey: the MEFE API Key of the user requesting the change to the unit
• MEFE unit ID of the unit that needs to be modified
• The change that needs to be done:
  • name: a name for the unit (string)
  • type: The type of the unit. See the list of MEFE authorized unit type
  • moreInfo: Free text to add more information about the unit (excluding address information)
  • streetAddress: Street address and unit number if applicable
  • city: The city (a string)
  • state: regional subdivision or administrative region (ex: California)
  • zipCode: ZIP or Postal Code
  • country: the 2 letter ISO code for the country example: SG or AU
  • Parent Unit ID: the MEFE unit Id of the parent unit (ex: MEFE Unit Id of the building if the unit created is a flat or MEFE Unit Id of the flat if the unit created is a room

Output:

Success:

Return timestamp: date and time (Z) when the unit was successfully modified The request ID for the update request

Failure:

Include descriptive error message.

What happens in the back end:

• Unee-T Enterprise checks if user requestorUserId is allowed to edit the unit.
• UNTE updates what needs to be updated
• UNTE uses the MEFE API to edit a unit.

[kaihendry]

I don't quite understand how this works. So it's not simply an UPDATE to a row in the unte_api_add_unit table?

How am I supposed to call the MEFE API? Isn't this best done at the MEFE end point? cc @nbiton

[franck-boullier]

So it's not simply an UPDATE to a row in the unte_api_add_unit table?

No it is NOT an UPDATE to a row in the unte_api_add_unit table This is an INSERT to a different table unte_api_edit_unit table

How am I supposed to call the MEFE API?

You are not supposed to call the MEFE API at all, the UNTE will do it for you.

Isn't this best done at the MEFE end point?

No it's not possible to do this at the MEFE end point: the information needs to be stored in the UNTE database.

[kaihendry]

Let me know when unte_api_edit_unit table is ready and I'll implement.