feat: OR-1282 add JSON-LD fields in response

paket.dependencies

@@ -16,6 +16,7 @@ nuget Microsoft.EntityFrameworkCore.Design 6.0.3
 // BASE REGISTRIES STUFF
 nuget Be.Vlaanderen.Basisregisters.Build.Pipeline 6.0.4
 nuget Be.Vlaanderen.Basisregisters.Testing.Infrastructure.Events 3.0.0 content: true, copy_content_to_output_dir: always, copy_local: true
+nuget Be.Vlaanderen.Basisregisters.Generators.Guid.Deterministic
 
 nuget Microsoft.Extensions.DependencyInjection 6.0.0
 nuget Microsoft.NETCore.Platforms 6.0.2

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/BeheerVerenigingDetailMapper.cs

@@ -6,6 +6,8 @@
 using System.Linq;
 using Adres = ResponseModels.Adres;
 using AdresId = ResponseModels.AdresId;
+using GestructureerdeIdentificator = ResponseModels.GestructureerdeIdentificator;
+using VertegenwoordigerContactgegevens = ResponseModels.VertegenwoordigerContactgegevens;
 
 public class BeheerVerenigingDetailMapper
 {
@@ -34,6 +36,8 @@ private static VerenigingDetail Map(BeheerVerenigingDetailDocument vereniging, s
     {
         return new VerenigingDetail
         {
+            id = vereniging.JsonLdMetadata.Id,
+            type = vereniging.JsonLdMetadata.Type,
             VCode = vereniging.VCode,
             Verenigingstype = Map(vereniging.Verenigingstype),
             Naam = vereniging.Naam,
@@ -59,15 +63,15 @@ private static VerenigingDetail Map(BeheerVerenigingDetailDocument vereniging, s
         };
     }
 
-    private static Relatie Map(BeheerVerenigingDetailDocument.Relatie relatie, string baseUrl)
+    private static ResponseModels.Relatie Map(Schema.Detail.Relatie relatie, string baseUrl)
         => new()
         {
             Relatietype = relatie.Relatietype,
             AndereVereniging = Map(relatie.AndereVereniging, baseUrl),
         };
 
     private static GerelateerdeVereniging Map(
-        BeheerVerenigingDetailDocument.Relatie.GerelateerdeVereniging gerelateerdeVereniging,
+        Schema.Detail.Relatie.GerelateerdeVereniging gerelateerdeVereniging,
         string baseUrl)
         => new()
         {
@@ -79,23 +83,33 @@ private static GerelateerdeVereniging Map(
                 : string.Empty,
         };
 
-    private static VerenigingsType Map(BeheerVerenigingDetailDocument.VerenigingsType verenigingsType)
+    private static ResponseModels.VerenigingsType Map(Schema.Detail.VerenigingsType verenigingsType)
         => new()
         {
             Code = verenigingsType.Code,
             Naam = verenigingsType.Naam,
         };
 
-    private static Sleutel Map(BeheerVerenigingDetailDocument.Sleutel sleutel)
+    private static ResponseModels.Sleutel Map(Schema.Detail.Sleutel sleutel)
         => new()
         {
+            id = sleutel.JsonLdMetadata.Id,
+            type = sleutel.JsonLdMetadata.Type,
             Bron = sleutel.Bron,
             Waarde = sleutel.Waarde,
+            GestructureerdeIdentificator = new GestructureerdeIdentificator()
+            {
+                id = sleutel.GestructureerdeIdentificator.JsonLdMetadata.Id,
+                type = sleutel.GestructureerdeIdentificator.JsonLdMetadata.Type,
+                Nummer = sleutel.GestructureerdeIdentificator.Nummer,
+            },
         };
 
-    private static Contactgegeven Map(BeheerVerenigingDetailDocument.Contactgegeven contactgegeven)
+    private static ResponseModels.Contactgegeven Map(Schema.Detail.Contactgegeven contactgegeven)
         => new()
         {
+            id = contactgegeven.JsonLdMetadata.Id,
+            type = contactgegeven.JsonLdMetadata.Type,
             ContactgegevenId = contactgegeven.ContactgegevenId,
             Contactgegeventype = contactgegeven.Contactgegeventype,
             Waarde = contactgegeven.Waarde,
@@ -104,17 +118,21 @@ private static Contactgegeven Map(BeheerVerenigingDetailDocument.Contactgegeven
             Bron = contactgegeven.Bron,
         };
 
-    private static HoofdactiviteitVerenigingsloket Map(
-        BeheerVerenigingDetailDocument.HoofdactiviteitVerenigingsloket hoofdactiviteitVerenigingsloket)
+    private static ResponseModels.HoofdactiviteitVerenigingsloket Map(
+        Schema.Detail.HoofdactiviteitVerenigingsloket hoofdactiviteitVerenigingsloket)
         => new()
         {
+            id = hoofdactiviteitVerenigingsloket.JsonLdMetadata.Id,
+            type = hoofdactiviteitVerenigingsloket.JsonLdMetadata.Type,
             Code = hoofdactiviteitVerenigingsloket.Code,
             Naam = hoofdactiviteitVerenigingsloket.Naam,
         };
 
-    private static Vertegenwoordiger Map(BeheerVerenigingDetailDocument.Vertegenwoordiger ver)
+    private static ResponseModels.Vertegenwoordiger Map(Schema.Detail.Vertegenwoordiger ver)
         => new()
         {
+            id = ver.JsonLdMetadata.Id,
+            type = ver.JsonLdMetadata.Type,
             VertegenwoordigerId = ver.VertegenwoordigerId,
             Insz = ver.Insz,
             Voornaam = ver.Voornaam,
@@ -126,12 +144,27 @@ private static Vertegenwoordiger Map(BeheerVerenigingDetailDocument.Vertegenwoor
             Telefoon = ver.Telefoon,
             Mobiel = ver.Mobiel,
             SocialMedia = ver.SocialMedia,
+            VertegenwoordigerContactgegevens = Map(ver.VertegenwoordigerContactgegevens),
             Bron = ver.Bron,
         };
 
-    private static Locatie Map(BeheerVerenigingDetailDocument.Locatie loc)
+    private static VertegenwoordigerContactgegevens Map(Schema.Detail.VertegenwoordigerContactgegevens vc)
+        => new()
+        {
+            id = vc.JsonLdMetadata.Id,
+            type = vc.JsonLdMetadata.Type,
+            IsPrimair = vc.IsPrimair,
+            Email = vc.Email,
+            Telefoon = vc.Telefoon,
+            Mobiel = vc.Mobiel,
+            SocialMedia = vc.SocialMedia,
+        };
+
+    private static ResponseModels.Locatie Map(Schema.Detail.Locatie loc)
         => new()
         {
+            id = loc.JsonLdMetadata.Id,
+            type = loc.JsonLdMetadata.Type,
             LocatieId = loc.LocatieId,
             Locatietype = loc.Locatietype,
             IsPrimair = loc.IsPrimair,
@@ -155,6 +188,8 @@ private static Locatie Map(BeheerVerenigingDetailDocument.Locatie loc)
         => adres is not null
             ? new Adres
             {
+                id = adres.JsonLdMetadata.Id,
+                type = adres.JsonLdMetadata.Type,
                 Straatnaam = adres.Straatnaam,
                 Huisnummer = adres.Huisnummer,
                 Busnummer = adres.Busnummer,

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/Examples/DetailVerenigingResponseExamples.cs

@@ -1,6 +1,7 @@
 namespace AssociationRegistry.Admin.Api.Verenigingen.Detail.Examples;
 
 using Infrastructure.ConfigurationBindings;
+using JsonLdContext;
 using ResponseModels;
 using Schema.Constants;
 using Swashbuckle.AspNetCore.Filters;
@@ -33,6 +34,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                 Context = $"{_appSettings.PublicApiBaseUrl}/v1/contexten/beheer/detail-vereniging-context.json",
                 Vereniging = new VerenigingDetail
                 {
+                    id = JsonLdType.Vereniging.CreateWithIdValues("V0001001"),
+                    type = JsonLdType.Vereniging.Type,
                     VCode = "V0001001",
                     Verenigingstype = new VerenigingsType
                     {
@@ -55,6 +58,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new HoofdactiviteitVerenigingsloket
                         {
+                            id = JsonLdType.Hoofdactiviteit.CreateWithIdValues("CULT"),
+                            type = JsonLdType.Hoofdactiviteit.Type,
                             Code = "CULT",
                             Naam = "Cultuur",
                         },
@@ -63,6 +68,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Contactgegeven
                         {
+                            id = JsonLdType.Contactgegeven.CreateWithIdValues("V0001001", "1"),
+                            type = JsonLdType.Contactgegeven.Type,
                             Contactgegeventype = "E-mail",
                             Beschrijving = "Info",
                             Waarde = "info@example.org",
@@ -75,13 +82,17 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Locatie
                         {
+                            id = JsonLdType.Locatie.CreateWithIdValues("V0001001", "1"),
+                            type = JsonLdType.Locatie.Type,
                             LocatieId = 1,
                             Locatietype = "Correspondentie",
                             IsPrimair = true,
                             Adresvoorstelling = "Kerkstraat 5, 1770 Liedekerke, Belgie",
                             Naam = "Administratief centrum",
                             Adres = new Adres
                             {
+                                id = JsonLdType.Adres.CreateWithIdValues("V0001001", "1"),
+                                type = JsonLdType.Adres.Type,
                                 Straatnaam = "Kerkstraat",
                                 Huisnummer = "5",
                                 Busnummer = "b",
@@ -101,6 +112,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Vertegenwoordiger
                         {
+                            id = JsonLdType.Vertegenwoordiger.CreateWithIdValues("V0001001", "1"),
+                            type = JsonLdType.Vertegenwoordiger.Type,
                             VertegenwoordigerId = 1,
                             Insz = "1234567890",
                             Voornaam = "Jane",
@@ -112,6 +125,16 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                             Mobiel = "0000112233",
                             Telefoon = "0001112233",
                             SocialMedia = "http://example.org",
+                            VertegenwoordigerContactgegevens = new VertegenwoordigerContactgegevens()
+                            {
+                                id = JsonLdType.VertegenwoordigerContactgegeven.CreateWithIdValues("V0001001", "1"),
+                                type = JsonLdType.VertegenwoordigerContactgegeven.Type,
+                                Email = "jhon@example.org",
+                                Mobiel = "0000112233",
+                                Telefoon = "0001112233",
+                                SocialMedia = "http://example.org",
+                                IsPrimair = false,
+                            },
                             Bron = Bron.Initiator.Waarde,
                         },
                     },
@@ -133,6 +156,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                 Context = $"{_appSettings.PublicApiBaseUrl}/v1/contexten/beheer/detail-vereniging-context.json",
                 Vereniging = new VerenigingDetail
                 {
+                    id = JsonLdType.Vereniging.CreateWithIdValues("V0001002"),
+                    type = JsonLdType.Vereniging.Type,
                     VCode = "V0001002",
                     Verenigingstype = new VerenigingsType
                     {
@@ -156,6 +181,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new HoofdactiviteitVerenigingsloket
                         {
+                            id = JsonLdType.Hoofdactiviteit.CreateWithIdValues("CULT"),
+                            type = JsonLdType.Hoofdactiviteit.Type,
                             Code = "CULT",
                             Naam = "Cultuur",
                         },
@@ -164,6 +191,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Contactgegeven
                         {
+                            id = JsonLdType.Contactgegeven.CreateWithIdValues("V0001001", "1"),
+                            type = JsonLdType.Contactgegeven.Type,
                             Contactgegeventype = "E-mail",
                             Beschrijving = "Info",
                             Waarde = "info@example.org",
@@ -173,6 +202,8 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                         },
                         new Contactgegeven
                         {
+                            id = JsonLdType.Contactgegeven.CreateWithIdValues("V0001001", "2"),
+                            type = JsonLdType.Contactgegeven.Type,
                             Contactgegeventype = Contactgegeventype.SocialMedia,
                             Beschrijving = "BlubBlub",
                             Waarde = "blubblub.com/vissen",
@@ -185,13 +216,17 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Locatie
                         {
+                            id = JsonLdType.Locatie.CreateWithIdValues("V0001001", "1"),
+                            type = JsonLdType.Locatie.Type,
                             LocatieId = 1,
                             Locatietype = Locatietype.MaatschappelijkeZetelVolgensKbo.Waarde,
                             IsPrimair = true,
                             Adresvoorstelling = "Zeebank 10, 8400 Oostende, Belgie",
                             Naam = "",
                             Adres = new Adres
                             {
+                                id = JsonLdType.Adres.CreateWithIdValues("V0001001", "1"),
+                                type = JsonLdType.Adres.Type,
                                 Straatnaam = "Zeebank",
                                 Huisnummer = "10",
                                 Busnummer = "",
@@ -203,13 +238,17 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                         },
                         new Locatie
                         {
+                            id = JsonLdType.Locatie.CreateWithIdValues("V0001001", "2"),
+                            type = JsonLdType.Locatie.Type,
                             LocatieId = 2,
                             Locatietype = Locatietype.Activiteiten.Waarde,
                             IsPrimair = false,
                             Adresvoorstelling = "De pier 1, 8430 Westende",
                             Naam = "Vis plaats",
                             Adres = new Adres
                             {
+                                id = JsonLdType.Adres.CreateWithIdValues("V0001001", "2"),
+                                type = JsonLdType.Adres.Type,
                                 Straatnaam = "De pier",
                                 Huisnummer = "1",
                                 Busnummer = "",
@@ -230,8 +269,16 @@ public IEnumerable<SwaggerExample<DetailVerenigingResponse>> GetExamples()
                     {
                         new Sleutel
                         {
+                            id = JsonLdType.Sleutel.CreateWithIdValues("V0001001", Sleutelbron.Kbo.Waarde),
+                            type = JsonLdType.Sleutel.Type,
                             Waarde = "0123456789",
                             Bron = Sleutelbron.Kbo.Waarde,
+                            GestructureerdeIdentificator = new GestructureerdeIdentificator()
+                            {
+                                id = JsonLdType.GestructureerdeSleutel.CreateWithIdValues("V0001001", Sleutelbron.Kbo.Waarde),
+                                type = JsonLdType.GestructureerdeSleutel.Type,
+                                Nummer = "0123456789",
+                            },
                         },
                     },
                     Relaties = Array.Empty<Relatie>(),

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/ResponseModels/Adres.cs

@@ -2,8 +2,17 @@
 
 using System.Runtime.Serialization;
 
+[DataContract]
 public class Adres
 {
+    /// <summary>De json-ld id</summary>
+    [DataMember(Name = "@id")]
+    public string id { get; init; }
+
+    /// <summary>Het json-ld type</summary>
+    [DataMember(Name = "@type")]
+    public string type { get; init; }
+
     /// <summary>De straat van de locatie</summary>
     [DataMember(Name = "Straatnaam")]
     public string Straatnaam { get; init; } = null!;

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/ResponseModels/Contactgegeven.cs

@@ -6,6 +6,13 @@
 [DataContract]
 public class Contactgegeven
 {
+    /// <summary>De json-ld id</summary>
+    [DataMember(Name = "@id")]
+    public string id { get; init; }
+
+    /// <summary>Het json-ld type</summary>
+    [DataMember(Name = "@type")]
+    public string type { get; init; }
     /// <summary>De unieke identificatie code van dit contactgegeven binnen de vereniging</summary>
     [DataMember(Name = "ContactgegevenId")]
     public int ContactgegevenId { get; init; }

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/ResponseModels/GestructureerdeIdentificator.cs

@@ -0,0 +1,21 @@
+namespace AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels;
+
+using System.Runtime.Serialization;
+
+[DataContract]
+public class GestructureerdeIdentificator
+{
+    /// <summary>De json-ld id</summary>
+    [DataMember(Name = "@id")]
+    public string id { get; init; }
+
+    /// <summary>Het json-ld type</summary>
+    [DataMember(Name = "@type")]
+    public string type { get; init; }
+
+    /// <summary>
+    /// De externe identificator van de vereniging in de bron
+    /// </summary>
+    [DataMember(Name = "Nummer")]
+    public string Nummer { get; set; } = null!;
+}

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/ResponseModels/HoofdactiviteitVerenigingsloket.cs

@@ -6,6 +6,13 @@
 [DataContract]
 public class HoofdactiviteitVerenigingsloket
 {
+    /// <summary>De json-ld id</summary>
+    [DataMember(Name = "@id")]
+    public string id { get; init; }
+
+    /// <summary>Het json-ld type</summary>
+    [DataMember(Name = "@type")]
+    public string type { get; init; }
     /// <summary>De code van de hoofdactivititeit</summary>
     [DataMember(Name = "Code")]
     public string Code { get; init; } = null!;

src/AssociationRegistry.Admin.Api/Verenigingen/Detail/ResponseModels/Locatie.cs

@@ -6,6 +6,14 @@
 [DataContract]
 public class Locatie
 {
+    /// <summary>De json-ld id</summary>
+    [DataMember(Name = "@id")]
+    public string id { get; init; }
+
+    /// <summary>Het json-ld type</summary>
+    [DataMember(Name = "@type")]
+    public string type { get; init; }
+
     /// <summary>
     ///     De unieke identificatie code van deze locatie binnen de vereniging
     /// </summary>