MHR API - History Updates from UX Design

[doug-lovett]

Update MHR API MH history endpoint from UX design requirements captured here: https://www.figma.com/design/Odp8YV7GmMNPClx23SO7Oc/MHR-History?node-id=120-12977

• [x] sort most recent first
• [x] for each registration change include the start and end dates. Leave the end date empty if the record is active. Also include description, type, doc reg number, doc id and description of registration that ended the change if applicable.
• [x] list owners, not owner groups. Extend the owner schema to add group id and group count.
• [x] update the MHR API spec
• [x] update the BCRS schema objects for MHR

DEV API request example: GET https://bcregistry-dev.apigee.net/mhr/api/v1/registrations/history/107397

[doug-lovett]

Example response from DEV:

{
  "descriptions": [
    {
      "baseInformation": {
        "circa": false,
        "make": "WATSON IND. (ALTA)",
        "model": "DUCHESS",
        "year": 2018
      },
      "createDateTime": "2024-06-11T16:03:51+00:00",
      "csaNumber": "786356",
      "csaStandard": "Z240",
      "documentId": "12703823",
      "documentRegistrationNumber": "00551027",
      "manufacturer": "STARLINE",
      "otherRemarks": "BC SAFETY AUTHORITY #339556, PERMIT# EL-721296-2018",
      "rebuiltRemarks": "REBUILT AS A DOUBLE WIDE, MAKE/MODEL CUSTOM, YEAR 1995",
      "registrationDescription": "MANUFACTURED HOME REGISTRATION",
      "sectionCount": 1,
      "sections": [
        {
          "lengthFeet": 52,
          "lengthInches": 0,
          "serialNumber": "52D70556",
          "widthFeet": 12,
          "widthInches": 0
        }
      ],
      "status": "ACTIVE"
    }
  ],
  "locations": [
    {
      "address": {
        "city": "VICTORIA",
        "country": "CA",
        "postalCode": "A1A 1A1",
        "region": "BC",
        "street": "940 BLANSHARD ST"
      },
      "createDateTime": "2024-06-11T16:07:18+00:00",
      "documentId": "12398293",
      "documentRegistrationNumber": "00551029",
      "leaveProvince": false,
      "legalDescription": "THE NORTH WEST 1/4 OF SECTION 8 TOWNSHIP 79 RANGE 15 WEST OF THE 6TH MERIDIAN PEACE RIVER DISTRICT",
      "locationId": 201043,
      "locationType": "STRATA",
      "pidNumber": "014597365",
      "registrationDescription": "MANUFACTURED HOME RE-REGISTRATION",
      "status": "ACTIVE",
      "taxCertificate": false
    },
    {
      "additionalDescription": "SPALLUMCHEEN INDIAN RESERVE NO. 2",
      "address": {
        "city": "VICTORIA",
        "country": "CA",
        "postalCode": "A1A 1A1",
        "region": "BC",
        "street": "940 BLANSHARD STREET"
      },
      "createDateTime": "2024-06-11T16:03:51+00:00",
      "documentId": "12703823",
      "documentRegistrationNumber": "00551027",
      "endDateTime": "2024-06-11T16:07:18+00:00",
      "endRegistrationDescription": "MANUFACTURED HOME RE-REGISTRATION",
      "leaveProvince": false,
      "legalDescription": "LOT 3 PARCEL A (69860M) OF THE NORTH WEST 1/4 OF SECTION 34 TOWNSHIP 78 RANGE 16 WEST OF THE 6TH MERIDIAN PEACE RIVER DISTRICT",
      "locationId": 201042,
      "locationType": "OTHER",
      "pidNumber": "011625490",
      "registrationDescription": "MANUFACTURED HOME REGISTRATION",
      "status": "HISTORICAL",
      "taxCertificate": false
    }
  ],
  "mhrNumber": "108354",
  "owners": [
    {
      "address": {
        "city": "LANGLEY",
        "country": "CA",
        "postalCode": "V3A 6H4",
        "region": "BC",
        "street": "6665 238TH STREET"
      },
      "createDateTime": "2024-06-17T17:14:02+00:00",
      "documentId": "18100099",
      "documentRegistrationNumber": "00551040",
      "groupCount": 2,
      "groupId": 2,
      "groupOwnerCount": 1,
      "groupTenancyType": "NA",
      "individualName": {
        "first": "JOHN",
        "last": "CONNOLLY",
        "middle": "STEVEN"
      },
      "interest": "UNDIVIDED",
      "interestDenominator": 5,
      "interestNumerator": 1,
      "ownerId": 1,
      "partyType": "OWNER_IND",
      "phoneNumber": "6044620279",
      "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "status": "ACTIVE",
      "type": "COMMON"
    },
    {
      "address": {
        "city": "SASKATOON",
        "country": "CA",
        "postalCode": "S7N 4W9",
        "region": "SK",
        "street": "123-655 KENDERDINE RD"
      },
      "createDateTime": "2024-06-17T17:14:02+00:00",
      "documentId": "18100099",
      "documentRegistrationNumber": "00551040",
      "groupCount": 2,
      "groupId": 1,
      "groupOwnerCount": 2,
      "groupTenancyType": "JOINT",
      "individualName": {
        "first": "BILL",
        "last": "NYE"
      },
      "interest": "UNDIVIDED",
      "interestDenominator": 5,
      "interestNumerator": 4,
      "ownerId": 2,
      "partyType": "OWNER_IND",
      "phoneNumber": "1231231231",
      "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "status": "ACTIVE",
      "type": "COMMON"
    },
    {
      "address": {
        "city": "LANGLEY",
        "country": "CA",
        "postalCode": "V3A 6H4",
        "region": "BC",
        "street": "6665 238TH STREET"
      },
      "createDateTime": "2024-06-17T17:14:02+00:00",
      "documentId": "18100099",
      "documentRegistrationNumber": "00551040",
      "groupCount": 2,
      "groupId": 1,
      "groupOwnerCount": 2,
      "groupTenancyType": "JOINT",
      "individualName": {
        "first": "MARY-ANNE",
        "last": "BICKNELL"
      },
      "interest": "UNDIVIDED",
      "interestDenominator": 5,
      "interestNumerator": 4,
      "ownerId": 1,
      "partyType": "OWNER_IND",
      "phoneNumber": "6044620279",
      "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "status": "ACTIVE",
      "type": "COMMON"
    },
    {
      "address": {
        "city": "LANGLEY",
        "country": "CA",
        "postalCode": "V3A 6H4",
        "region": "BC",
        "street": "6665 238TH STREET"
      },
      "createDateTime": "2024-06-11T16:03:51+00:00",
      "documentId": "12703823",
      "documentRegistrationNumber": "00551027",
      "endDateTime": "2024-06-17T17:14:02+00:00",
      "endRegistrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "groupCount": 2,
      "groupId": 2,
      "groupOwnerCount": 1,
      "groupTenancyType": "COMMON",
      "individualName": {
        "first": "JOHN",
        "last": "CONNOLLY",
        "middle": "STEVEN"
      },
      "interest": "UNDIVIDED",
      "interestDenominator": 5,
      "interestNumerator": 1,
      "ownerId": 1,
      "partyType": "OWNER_IND",
      "phoneNumber": "6044620279",
      "registrationDescription": "MANUFACTURED HOME REGISTRATION",
      "status": "PREVIOUS",
      "type": "COMMON"
    },
    {
      "address": {
        "city": "LANGLEY",
        "country": "CA",
        "postalCode": "V3A 6H4",
        "region": "BC",
        "street": "6665 238TH STREET"
      },
      "createDateTime": "2024-06-11T16:03:51+00:00",
      "documentId": "12703823",
      "documentRegistrationNumber": "00551027",
      "endDateTime": "2024-06-17T17:14:02+00:00",
      "endRegistrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "groupCount": 2,
      "groupId": 1,
      "groupOwnerCount": 1,
      "groupTenancyType": "COMMON",
      "individualName": {
        "first": "MARY-ANNE",
        "last": "BICKNELL"
      },
      "interest": "UNDIVIDED",
      "interestDenominator": 5,
      "interestNumerator": 4,
      "ownerId": 1,
      "partyType": "OWNER_IND",
      "phoneNumber": "6044620279",
      "registrationDescription": "MANUFACTURED HOME REGISTRATION",
      "status": "PREVIOUS",
      "type": "COMMON"
    }
  ],
  "registrations": [
    {
      "affirmByName": "CAMERON BOWLER",
      "consideration": "$123.00",
      "createDateTime": "2024-06-17T17:14:02+00:00",
      "declaredValue": 123,
      "documentId": "18100099",
      "documentRegistrationNumber": "00551040",
      "ownLand": false,
      "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
      "transferDate": "2024-06-18T06:59:59+00:00"
    },
    {
      "affirmByName": "BUSINESS REGISTRY TEST 1",
      "attentionReference": "AT-239482",
      "createDateTime": "2024-06-11T16:07:18+00:00",
      "documentId": "12398293",
      "documentRegistrationNumber": "00551029",
      "registrationDescription": "MANUFACTURED HOME RE-REGISTRATION"
    },
    {
      "affirmByName": "BUSINESS REGISTRY TEST 1",
      "createDateTime": "2024-06-11T16:05:45+00:00",
      "documentId": "12949281",
      "documentRegistrationNumber": "00551028",
      "registrationDescription": "RESIDENTIAL EXEMPTION"
    },
    {
      "affirmByName": "BUSINESS REGISTRY TEST 1",
      "createDateTime": "2024-06-11T16:03:51+00:00",
      "documentId": "12703823",
      "documentRegistrationNumber": "00551027",
      "registrationDescription": "MANUFACTURED HOME REGISTRATION"
    }
  ],
  "statusType": "ACTIVE"
}

[chdivyareddy]

Verified in DEV!

https://bcregistry-dev.apigee.net/mhr/api/v1/registrations/history/108303

{
    "descriptions": [
        {
            "baseInformation": {
                "circa": true,
                "make": "Watson",
                "model": "Duchess",
                "year": 2012
            },
            "createDateTime": "2024-03-25T19:36:26+00:00",
            "documentId": "12373847",
            "documentRegistrationNumber": "00550318",
            "manufacturer": "Starline",
            "registrationDescription": "MANUFACTURED HOME REGISTRATION",
            "sectionCount": 1,
            "sections": [
                {
                    "lengthFeet": 52,
                    "lengthInches": 8,
                    "serialNumber": "BC2378493",
                    "widthFeet": 25,
                    "widthInches": 5
                }
            ],
            "status": "ACTIVE"
        }
    ],
    "locations": [
        {
            "address": {
                "city": "KAMLOOPS",
                "country": "CA",
                "postalCode": "V2C 6R9",
                "region": "BC",
                "street": "421-421 COLUMBIA ST"
            },
            "createDateTime": "2024-06-07T22:47:39+00:00",
            "documentId": "12382898",
            "documentRegistrationNumber": "00550988",
            "leaveProvince": false,
            "locationId": 201019,
            "locationType": "MH_PARK",
            "pad": "423",
            "parkName": "Deer Park",
            "registrationDescription": "MANUFACTURED HOME RE-REGISTRATION",
            "status": "ACTIVE",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "MONTRÉAL",
                "country": "CA",
                "postalCode": "H1E 6R2",
                "region": "QC",
                "street": "12312 AV FERNAND-GAUTHIER"
            },
            "createDateTime": "2024-03-27T21:01:28+00:00",
            "dealerName": "Dealer 12312",
            "documentId": "12312111",
            "documentRegistrationNumber": "00550382",
            "endDateTime": "2024-06-07T22:47:39+00:00",
            "endRegistrationDescription": "MANUFACTURED HOME RE-REGISTRATION",
            "leaveProvince": false,
            "locationId": 200782,
            "locationType": "MANUFACTURER",
            "registrationDescription": "REGISTRY CORRECTION - STAFF ERROR OR OMISSION",
            "status": "HISTORICAL",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "MAPLE RIDGE",
                "country": "CA",
                "postalCode": "V2X 2N4",
                "region": "BC",
                "street": "41-11229 232 ST"
            },
            "createDateTime": "2024-03-27T19:35:50+00:00",
            "dealerName": "Dealer 12312",
            "documentId": "90050080",
            "documentRegistrationNumber": "00550367",
            "endDateTime": "2024-03-27T21:01:28+00:00",
            "endRegistrationDescription": "REGISTRY CORRECTION - STAFF ERROR OR OMISSION",
            "leaveProvince": false,
            "locationId": 200777,
            "locationType": "MANUFACTURER",
            "registrationDescription": "TRANSPORT PERMIT - AMENDED",
            "status": "HISTORICAL",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "MAPLE RIDGE",
                "country": "CA",
                "postalCode": "V2X 2N4",
                "region": "BC",
                "street": "41-11229 232 ST"
            },
            "createDateTime": "2024-03-27T19:30:15+00:00",
            "dealerName": "Dealer 1231",
            "documentId": "90050079",
            "documentRegistrationNumber": "00550366",
            "endDateTime": "2024-03-27T19:35:50+00:00",
            "endRegistrationDescription": "TRANSPORT PERMIT - AMENDED",
            "leaveProvince": false,
            "locationId": 200776,
            "locationType": "MANUFACTURER",
            "registrationDescription": "TRANSPORT PERMIT - AMENDED",
            "status": "HISTORICAL",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "MAPLE RIDGE",
                "country": "CA",
                "postalCode": "V2X 2N4",
                "region": "BC",
                "street": "41-11229 232 ST"
            },
            "createDateTime": "2024-03-25T19:43:05+00:00",
            "dealerName": "Dealer 123",
            "documentId": "90050047",
            "documentRegistrationNumber": "00550320",
            "endDateTime": "2024-03-27T19:30:15+00:00",
            "endRegistrationDescription": "TRANSPORT PERMIT - AMENDED",
            "leaveProvince": false,
            "locationId": 200756,
            "locationType": "MANUFACTURER",
            "registrationDescription": "TRANSPORT PERMIT",
            "status": "HISTORICAL",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "MAPLE RIDGE",
                "country": "CA",
                "postalCode": "V2X 2N4",
                "region": "BC",
                "street": "41-11229 232 ST"
            },
            "createDateTime": "2024-03-25T19:43:05+00:00",
            "dealerName": "Dealer 123",
            "documentId": "90050046",
            "documentRegistrationNumber": "00550319",
            "endDateTime": "2024-03-25T19:43:05+00:00",
            "endRegistrationDescription": "TRANSPORT PERMIT",
            "leaveProvince": false,
            "locationId": 200755,
            "locationType": "MANUFACTURER",
            "registrationDescription": "TRANSPORT PERMIT",
            "status": "HISTORICAL",
            "taxCertificate": false
        },
        {
            "address": {
                "city": "COQUITLAM",
                "country": "CA",
                "postalCode": "V3B 5R5",
                "region": "BC",
                "street": "2142-2929 BARNET HWY"
            },
            "createDateTime": "2024-03-25T19:36:26+00:00",
            "dealerName": "Dealer abc",
            "documentId": "12373847",
            "documentRegistrationNumber": "00550318",
            "endDateTime": "2024-03-25T19:43:05+00:00",
            "endRegistrationDescription": "TRANSPORT PERMIT",
            "leaveProvince": false,
            "locationId": 200754,
            "locationType": "MANUFACTURER",
            "registrationDescription": "MANUFACTURED HOME REGISTRATION",
            "status": "HISTORICAL",
            "taxCertificate": false
        }
    ],
    "mhrNumber": "108303",
    "owners": [
        {
            "address": {
                "city": "KELOWNA",
                "country": "CA",
                "postalCode": "V1Y 9R1",
                "region": "BC",
                "street": "326-877 K.L.O. RD"
            },
            "createDateTime": "2024-03-27T21:00:49+00:00",
            "documentId": "12123121",
            "documentRegistrationNumber": "00550381",
            "groupCount": 1,
            "groupId": 1,
            "groupOwnerCount": 1,
            "individualName": {
                "first": "HUBERT",
                "last": "STEPHENS"
            },
            "ownerId": 1,
            "partyType": "OWNER_IND",
            "phoneExtension": "1",
            "phoneNumber": "8359823942",
            "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
            "status": "ACTIVE",
            "type": "SOLE"
        },
        {
            "address": {
                "city": "SMITHS FALLS",
                "country": "CA",
                "postalCode": "K7A 2J7",
                "region": "ON",
                "street": "4-55 MCGILL ST N"
            },
            "createDateTime": "2024-03-25T19:36:26+00:00",
            "documentId": "12373847",
            "documentRegistrationNumber": "00550318",
            "endDateTime": "2024-03-27T21:00:49+00:00",
            "endRegistrationDescription": "TRANSFER DUE TO SALE OR GIFT",
            "groupCount": 1,
            "groupId": 1,
            "groupOwnerCount": 2,
            "organizationName": "SERVICE AIR GROUP INC.",
            "ownerId": 2,
            "partyType": "OWNER_BUS",
            "phoneExtension": "1",
            "phoneNumber": "9832498239",
            "registrationDescription": "MANUFACTURED HOME REGISTRATION",
            "status": "PREVIOUS",
            "type": "JOINT"
        },
        {
            "address": {
                "city": "KELOWNA",
                "country": "CA",
                "postalCode": "V1Y 9R1",
                "region": "BC",
                "street": "326-877 K.L.O. RD"
            },
            "createDateTime": "2024-03-25T19:36:26+00:00",
            "documentId": "12373847",
            "documentRegistrationNumber": "00550318",
            "endDateTime": "2024-03-27T21:00:49+00:00",
            "endRegistrationDescription": "TRANSFER DUE TO SALE OR GIFT",
            "groupCount": 1,
            "groupId": 1,
            "groupOwnerCount": 2,
            "individualName": {
                "first": "HUBERT",
                "last": "STEPHENS"
            },
            "ownerId": 1,
            "partyType": "OWNER_IND",
            "phoneExtension": "1",
            "phoneNumber": "8359823942",
            "registrationDescription": "MANUFACTURED HOME REGISTRATION",
            "status": "PREVIOUS",
            "type": "JOINT"
        }
    ],
    "registrations": [
        {
            "affirmByName": "BUSINESS REGISTRY TEST 1",
            "attentionReference": "AT-2394893",
            "createDateTime": "2024-06-07T22:47:39+00:00",
            "documentId": "12382898",
            "documentRegistrationNumber": "00550988",
            "registrationDescription": "MANUFACTURED HOME RE-REGISTRATION"
        },
        {
            "affirmByName": "CAMERON BOWLER",
            "createDateTime": "2024-03-27T21:01:28+00:00",
            "documentId": "12312111",
            "documentRegistrationNumber": "00550382",
            "registrationDescription": "REGISTRY CORRECTION - STAFF ERROR OR OMISSION"
        },
        {
            "affirmByName": "CAMERON BOWLER",
            "consideration": "$123123.00",
            "createDateTime": "2024-03-27T21:00:49+00:00",
            "declaredValue": 123123,
            "documentId": "12123121",
            "documentRegistrationNumber": "00550381",
            "ownLand": false,
            "registrationDescription": "TRANSFER DUE TO SALE OR GIFT",
            "transferDate": "2024-03-27T00:00:00+00:00"
        },
        {
            "affirmByName": "BUSINESS REGISTRY TEST 5",
            "createDateTime": "2024-03-27T19:35:50+00:00",
            "documentId": "90050080",
            "documentRegistrationNumber": "00550367",
            "registrationDescription": "TRANSPORT PERMIT - AMENDED"
        },
        {
            "affirmByName": "BUSINESS REGISTRY TEST 5",
            "createDateTime": "2024-03-27T19:30:15+00:00",
            "documentId": "90050079",
            "documentRegistrationNumber": "00550366",
            "registrationDescription": "TRANSPORT PERMIT - AMENDED"
        },
        {
            "affirmByName": "BUSINESS REGISTRY TEST 5",
            "createDateTime": "2024-03-25T19:43:05+00:00",
            "documentId": "90050047",
            "documentRegistrationNumber": "00550320",
            "registrationDescription": "TRANSPORT PERMIT"
        },
        {
            "affirmByName": "BUSINESS REGISTRY TEST 5",
            "createDateTime": "2024-03-25T19:43:05+00:00",
            "documentId": "90050046",
            "documentRegistrationNumber": "00550319",
            "registrationDescription": "TRANSPORT PERMIT"
        },
        {
            "affirmByName": "BUSINESS REGISTRY TEST 1",
            "attentionReference": "AT-3049504",
            "createDateTime": "2024-03-25T19:36:26+00:00",
            "documentId": "12373847",
            "documentRegistrationNumber": "00550318",
            "registrationDescription": "MANUFACTURED HOME REGISTRATION"
        }
    ],
    "statusType": "ACTIVE"
}