Add documentation for Enhanced Corporate Fundraisers

https://www.notion.so/betternow/Enhanced-Corporate-Fundraiser-updates-13e917fd3e118070ac6ccc5de2bd0f25?pvs=4
BetterNowOrg · Nov 15, 2024 · 1a91703 · 1a91703
1 parent 6d79451
commit 1a91703
Show file tree

Hide file tree

Showing 3 changed files with 319 additions and 8 deletions.
diff --git a/schema/schemata/fundraiser.yml b/schema/schemata/fundraiser.yml
@@ -138,6 +138,76 @@ definitions:
     "$ref": "/schemata/common#/definitions/partner_data"
   your_reference:
     "$ref": "/schemata/project#/definitions/your_reference"
+  company:
+    description: Information about the company that owns the fundraiser. This will only include information if Enhanced Corporate Fundraisers are activated. Contact [email protected] to learn more about Enhanced Corporate Fundraisers.
+    type:
+      - object
+    properties:
+      registered_name:
+        description: The name of the company from the company registry
+        example: BETTERNOW WORLDWIDE ApS
+        type:
+          - string
+      registration_id:
+        description: The ID of the compay from the registry (CVR/Orgnummer/etc.)
+        example: 34205566
+        type:
+          - string
+      registration_country_code:
+        description: The country code for the country where the company is registered
+        example: DK
+        type:
+          - string
+      updated_from_registry_at:
+        description: When the system last pulled information about the company from the registry
+        example: "2024-11-15T15:27:27+01:00"
+        format: date
+        type:
+          - string
+      sector_code:
+        description: The sector code for the company
+        example: 620100
+        type:
+          - string
+      sector_description:
+        description: A description of the sector code
+        example: Computerprogrammering
+        type:
+          - string
+      employee_count:
+        description: The number of employees at the company
+        example: 2
+        type:
+          - integer
+      address:
+        description: The address of the company. If the registry supports both a business address and a postal address, this will be the postal address.
+        type:
+          - object
+        properties:
+          street_line_1:
+            example: Finsensvej 6E
+            type:
+              - string
+          street_line_1:
+            example: null
+            type:
+              - string
+          city:
+            example: Frederiksberg
+            type:
+              - string
+          postal_code:
+            example: 2000
+            type:
+              - string
+          province:
+            example: null
+            type:
+              - string
+          country:
+            example: DK
+            type:
+              - :string
 description: Detailed information about a single Fundraising Page on BetterNow.org
 links:
 - description: Info for existing fundraiser.
@@ -275,6 +345,8 @@ properties:
     "$ref": "/schemata/fundraiser#/definitions/death_date"
   funeral_date:
     "$ref": "/schemata/fundraiser#/definitions/funeral_date"
+  company:
+    "$ref": "/schemata/fundraiser#/definitions/company"
 type:
 - object
 id: schemata/fundraiser
diff --git a/source/includes/resources.md b/source/includes/resources.md
@@ -815,7 +815,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```
@@ -914,6 +930,18 @@ Detailed information about a single Fundraising Page on BetterNow.org
 | **activity_score** | *integer* | A number that can be used for sorting lists of fundraisers. More recently active fundraisers should have a higher activity score than fundraisers who have raised more money long ago. | `987654321` |
 | **[allow_organisation_contact](#resource-common)** | *boolean* | If the person has consented to be contacted by the organisation | `true` |
 | **birth_date** | *date* | The day the person who a tribute_fund fundraiser is honoring was born. | `"2012-01-01"` |
+| **company:address:city** | *string* |  | `"Frederiksberg"` |
+| **company:address:country** | *string* |  | `"DK"` |
+| **company:address:postal_code** | *string* |  | `2000` |
+| **company:address:province** | *string* |  | `null` |
+| **company:address:street_line_1** | *string* |  | `null` |
+| **company:employee_count** | *integer* | The number of employees at the company | `2` |
+| **company:registered_name** | *string* | The name of the company from the company registry | `"BETTERNOW WORLDWIDE ApS"` |
+| **company:registration_country_code** | *string* | The country code for the country where the company is registered | `"DK"` |
+| **company:registration_id** | *string* | The ID of the compay from the registry (CVR/Orgnummer/etc.) | `34205566` |
+| **company:sector_code** | *string* | The sector code for the company | `620100` |
+| **company:sector_description** | *string* | A description of the sector code | `"Computerprogrammering"` |
+| **company:updated_from_registry_at** | *date* | When the system last pulled information about the company from the registry | `"2024-11-15T15:27:27+01:00"` |
 | **[cover_media:image:url](#resource-common)** | *uri* | The url for the image. On the BetterNow site, the video takes precedence if both exist. 461x306 pixels | `"https://cnd.example.net/image.jpg"` |
 | **[cover_media:thumb:url](#resource-common)** | *uri* | The url for the cover media that should be displayed in e.g. a card view. 120x80 pixels | `"https://cnd.example.net/image.jpg"` |
 | **cover_media:video:oembed_html** | *string* | The OEmbed HTML to display the video. Could be blank. | `"<iframe width=\\\"480\\\" height=\\\"270\\\" src=\\\"https://www.youtube.com/embed/G1JBOSwjN6Q?feature=oembed\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>"` |
@@ -1062,7 +1090,23 @@ HTTP/1.1 200 OK
   "honoree": "Dorthe Jensen Hansen",
   "birth_date": "2012-01-01",
   "death_date": "2012-01-01",
-  "funeral_date": "2012-01-01"
+  "funeral_date": "2012-01-01",
+  "company": {
+    "registered_name": "BETTERNOW WORLDWIDE ApS",
+    "registration_id": 34205566,
+    "registration_country_code": "DK",
+    "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+    "sector_code": 620100,
+    "sector_description": "Computerprogrammering",
+    "employee_count": 2,
+    "address": {
+      "street_line_1": null,
+      "city": "Frederiksberg",
+      "postal_code": 2000,
+      "province": null,
+      "country": "DK"
+    }
+  }
 }
 ```
 
@@ -1166,7 +1210,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```
@@ -1326,7 +1386,23 @@ HTTP/1.1 200 OK
   "honoree": "Dorthe Jensen Hansen",
   "birth_date": "2012-01-01",
   "death_date": "2012-01-01",
-  "funeral_date": "2012-01-01"
+  "funeral_date": "2012-01-01",
+  "company": {
+    "registered_name": "BETTERNOW WORLDWIDE ApS",
+    "registration_id": 34205566,
+    "registration_country_code": "DK",
+    "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+    "sector_code": 620100,
+    "sector_description": "Computerprogrammering",
+    "employee_count": 2,
+    "address": {
+      "street_line_1": null,
+      "city": "Frederiksberg",
+      "postal_code": 2000,
+      "province": null,
+      "country": "DK"
+    }
+  }
 }
 ```
 
@@ -1830,7 +1906,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```
@@ -2168,7 +2260,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```
@@ -2465,7 +2573,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```
@@ -3017,7 +3141,23 @@ HTTP/1.1 200 OK
     "honoree": "Dorthe Jensen Hansen",
     "birth_date": "2012-01-01",
     "death_date": "2012-01-01",
-    "funeral_date": "2012-01-01"
+    "funeral_date": "2012-01-01",
+    "company": {
+      "registered_name": "BETTERNOW WORLDWIDE ApS",
+      "registration_id": 34205566,
+      "registration_country_code": "DK",
+      "updated_from_registry_at": "2024-11-15T15:27:27+01:00",
+      "sector_code": 620100,
+      "sector_description": "Computerprogrammering",
+      "employee_count": 2,
+      "address": {
+        "street_line_1": null,
+        "city": "Frederiksberg",
+        "postal_code": 2000,
+        "province": null,
+        "country": "DK"
+      }
+    }
   }
 ]
 ```