Feature/239 Include Partij Identificatoren on Partij for GET, POST and PUT operations

[danielmursa-dev]

Fixes #239 and #262

// GET /partijen

// POST /partijen
{
    ...
        {
         ...
          "partijIdentificatoren": [
          {
                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                "url": "http://example.com",
                "identificeerdePartij": {
                        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
                        "url": "http://example.com/"
                },
                "anderePartijIdentificator": "string",
                "partijIdentificator": {
                                        "codeObjecttype": "natuurlijk_persoon",
                                        "codeSoortObjectId": "bsn",
                                        "objectId": "string",
                                        "codeRegister": "brp"
                }
           }
        ],
    ...
       }
   ...
}

// POST /partijen allow to pass a list of partijIdentificatoren:

• partij_identificator or UUID

// POST /partijen
{
    ...
    ...
    # list of partij identificatoren
    "partijIdentificatoren": [
        # create new partij_identificator and attach to partij
        {
            "anderePartijIdentificator": "string",
            "partijIdentificator": {
                "codeObjecttype": "niet_natuurlijk_persoon",
                "codeSoortObjectId": "rsin",
                "objectId": "296648875",
                "codeRegister": "hr",
            },
        },
        # attach existing partij_identificator with UUID to partij
        {
            "uuid": str(partij_identificator.uuid),
        },
    ],
    ...
    ...
}

// PUT /partijen allow to pass a list of partijIdentificatoren:

• partij_identificator obj or UUID

// PUT /partijen
3 cases:

# 1 no action is performed
{
    ...
    ...
    # None or not specified key in PUT /partijen
    "partijIdentificatoren": None
    ...
    ...
}

# 2 delete all partijIdentificatoren, because specified a empty list
{
    ...
    ...
    # empty list in PUT /partijen
    "partijIdentificatoren": []
    ...
    ...
}

# 3 delete all partijIdentificatoren and attach new partij_identificator as in POST
{
    ...
    ...
    # list of partij identificatoren
    "partijIdentificatoren": [
        # create new partij_identificator and attach to partij
        {
            "anderePartijIdentificator": "string",
            "partijIdentificator": {
                "codeObjecttype": "niet_natuurlijk_persoon",
                "codeSoortObjectId": "rsin",
                "objectId": "296648875",
                "codeRegister": "hr",
            },
        },
        # attach existing partij_identificator with UUID to partij
        {
            "uuid": str(partij_identificator.uuid),
        },
    ],
    ...
    ...
}

**
For updating partij-identificatoren, this is not the right endpoint, because the edpoint /partij-identificatoren/ remains accessible for their operation.
**

[swrichards]

One or two conceptual points to consider, see the comments.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 99.22481% with 1 line in your changes missing coverage. Please review.

Project coverage is 97.21%. Comparing base (e6a3ea4) to head (8d4b20f).
Report is 7 commits behind head on master.

Files with missing lines	Patch %	Lines
...nents/klantinteracties/api/serializers/partijen.py	97.14%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #321      +/-   ##
==========================================
+ Coverage   97.10%   97.21%   +0.11%     
==========================================
  Files         179      182       +3     
  Lines        8671     9061     +390     
==========================================
+ Hits         8420     8809     +389     
- Misses        251      252       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[joeribekker]

@swrichards please re-review.

[swrichards]

@danielmursa-dev I am holding off on reviewing this for the moment, as I discussed some of the required data model changes with @joeribekker and would like to write those up first to see how they would affect the logic here (to avoid merging this and having to do complicated migrations later). I'll report back when that work is done.