generated: '2026-07-26'
method: derived
source: openapi/nar-m1-gateway-external-openapi.json
api: REALTORS M1 Gateway External API
summary: 'Entity-relationship graph derived from the 99 definitions in NAR''s published M1 Gateway Swagger
  2.0 document. The graph is member-centric: Member is the hub, keyed by MemberId (the NRDS successor
  identifier), with roughly twenty sub-record types hanging off it (address, phone, email, certification,
  code of ethics, demographic, designation, dues payment, education, fair housing, field of business,
  ISC affiliation, language, MLS, military service, secondary affiliation). Office and Association are
  the two other roots; Data_Extract_Request and Data_Extract_Schedule model the bulk/pull delivery surface.
  JSON Patch envelope types (*Patch/*Operation/*JsonPatchDocument) are excluded as transport shapes, not
  entities.'
roots:
- Member
- Office
- Association
identifier_fields:
  MemberId: Primary REALTOR member identifier issued through the local association ID prefix (replaces
    the NRDS ID).
  OfficeId: Office/firm identifier.
  AssociationId: Local or state association identifier.
entity_count: 44
relationship_count: 85
entities:
- name: AssocMemberCount
  fields: 0
- name: Association
  fields: 89
- name: Association_Board_Serviced
  fields: 19
- name: BizAssociationSearch
  fields: 7
- name: BizEmailValidation
  fields: 3
- name: BizMember
  fields: 160
- name: BizMemberDesignation
  fields: 25
- name: BizMemberSearch
  fields: 23
- name: BizOfficeSearch
  fields: 9
- name: BizReinstate
  fields: 2
- name: BizValidationFieldError
  fields: 3
- name: BizValidationRealEstateLicense
  fields: 9
- name: ConvertIAMember
  fields: 161
- name: Data_Extract_Request
  fields: 34
- name: Data_Extract_Schedule
  fields: 29
- name: Member
  fields: 67
- name: Member_Address
  fields: 25
- name: Member_Certification
  fields: 27
- name: Member_Coe
  fields: 32
- name: Member_Demographic
  fields: 26
- name: Member_Designation
  fields: 21
- name: Member_Dues_Payment
  fields: 37
- name: Member_Education
  fields: 51
- name: Member_Education_Level
  fields: 22
- name: Member_Email
  fields: 21
- name: Member_Fair_Housing
  fields: 26
- name: Member_Field_Of_Business
  fields: 21
- name: Member_Isc_Affiliation
  fields: 27
- name: Member_Language
  fields: 23
- name: Member_MLS
  fields: 27
- name: Member_Master_Record
  fields: 28
- name: Member_Military_Service
  fields: 22
- name: Member_Phone
  fields: 20
- name: Member_Secondary
  fields: 39
- name: Member_Single_Owned_MLS
  fields: 24
- name: Office
  fields: 76
- name: OfficeSecondary
  fields: 25
- name: OperationType
  fields: 0
- name: RefOfficeStatusType
  fields: 16
- name: Ref_Association_Type
  fields: 17
- name: Ref_Branch_Type
  fields: 16
- name: Ref_State
  fields: 16
- name: TransferMember
  fields: 163
- name: TransferOffice
  fields: 79
relationships:
- from: Association
  to: Association
  kind: has_one
  via: primaryStateAssociation
- from: Association
  to: Association
  kind: has_one
  via: stateAssociation1
- from: Association
  to: Association
  kind: has_one
  via: stateAssociation2
- from: Association
  to: Association
  kind: has_one
  via: stateAssociation3
- from: Association
  to: AssocMemberCount
  kind: has_one
  via: assocMemberCount
- from: Association
  to: Association_Board_Serviced
  kind: has_many
  via: boardsServicedList
- from: BizMember
  to: Member_Secondary
  kind: has_many
  via: memberSecondaries
- from: BizMember
  to: Member_Certification
  kind: has_many
  via: memberCertification
- from: BizMember
  to: Member_Coe
  kind: has_many
  via: memberCoe
- from: BizMember
  to: Member_Demographic
  kind: has_many
  via: memberDemographic
- from: BizMember
  to: BizMemberDesignation
  kind: has_many
  via: memberDesignation
- from: BizMember
  to: Member_Dues_Payment
  kind: has_many
  via: memberDuesPayment
- from: BizMember
  to: Member_Education_Level
  kind: has_many
  via: memberEducationLevel
- from: BizMember
  to: Member_Education
  kind: has_many
  via: memberEducation
- from: BizMember
  to: Member_Fair_Housing
  kind: has_many
  via: memberFairHousing
- from: BizMember
  to: Member_Isc_Affiliation
  kind: has_many
  via: memberIscAffiliation
- from: BizMember
  to: Member_Language
  kind: has_many
  via: memberLanguage
- from: BizMember
  to: Member_Military_Service
  kind: has_many
  via: memberMilitary
- from: BizMember
  to: Member_MLS
  kind: has_many
  via: memberMLS
- from: BizMember
  to: Member_Single_Owned_MLS
  kind: has_many
  via: memberSingleOwnedMLS
- from: BizMember
  to: Member_Master_Record
  kind: has_one
  via: masterRecord
- from: BizMember
  to: Office
  kind: has_one
  via: office
- from: BizReinstate
  to: BizMember
  kind: has_one
  via: member
- from: BizReinstate
  to: Office
  kind: has_one
  via: office
- from: ConvertIAMember
  to: Member_Secondary
  kind: has_many
  via: memberSecondaries
- from: ConvertIAMember
  to: Member_Certification
  kind: has_many
  via: memberCertification
- from: ConvertIAMember
  to: Member_Coe
  kind: has_many
  via: memberCoe
- from: ConvertIAMember
  to: Member_Demographic
  kind: has_many
  via: memberDemographic
- from: ConvertIAMember
  to: BizMemberDesignation
  kind: has_many
  via: memberDesignation
- from: ConvertIAMember
  to: Member_Dues_Payment
  kind: has_many
  via: memberDuesPayment
- from: ConvertIAMember
  to: Member_Education_Level
  kind: has_many
  via: memberEducationLevel
- from: ConvertIAMember
  to: Member_Education
  kind: has_many
  via: memberEducation
- from: ConvertIAMember
  to: Member_Fair_Housing
  kind: has_many
  via: memberFairHousing
- from: ConvertIAMember
  to: Member_Isc_Affiliation
  kind: has_many
  via: memberIscAffiliation
- from: ConvertIAMember
  to: Member_Language
  kind: has_many
  via: memberLanguage
- from: ConvertIAMember
  to: Member_Military_Service
  kind: has_many
  via: memberMilitary
- from: ConvertIAMember
  to: Member_MLS
  kind: has_many
  via: memberMLS
- from: ConvertIAMember
  to: Member_Single_Owned_MLS
  kind: has_many
  via: memberSingleOwnedMLS
- from: ConvertIAMember
  to: Member_Master_Record
  kind: has_one
  via: masterRecord
- from: ConvertIAMember
  to: Office
  kind: has_one
  via: office
- from: Office
  to: Office
  kind: has_one
  via: billingOffice
- from: Office
  to: Office
  kind: has_one
  via: mainOffice
- from: Office
  to: Office
  kind: has_one
  via: franchiseOffice
- from: Office
  to: Office
  kind: has_one
  via: parentCompanyOffice
- from: Office
  to: RefOfficeStatusType
  kind: has_one
  via: refOfficeStatusType
- from: Office
  to: Ref_Branch_Type
  kind: has_one
  via: refBranchType
- from: Office
  to: Member
  kind: has_one
  via: officeContactDr
- from: Office
  to: Member
  kind: has_one
  via: officeContactManager
- from: Office
  to: Association
  kind: has_one
  via: primaryLocalAssociation
- from: Office
  to: Association
  kind: has_one
  via: primaryStateAssociation
- from: Office
  to: Ref_State
  kind: has_one
  via: refStreetState
- from: Office
  to: Ref_State
  kind: has_one
  via: refMailState
- from: Office
  to: OfficeSecondary
  kind: has_many
  via: officeSecondaries
- from: OfficeSecondary
  to: Association
  kind: has_one
  via: association
- from: OfficeSecondary
  to: RefOfficeStatusType
  kind: has_one
  via: refOfficeStatusType
- from: OfficeSecondary
  to: Ref_Association_Type
  kind: has_one
  via: refAssociationType
- from: TransferMember
  to: Member_Secondary
  kind: has_many
  via: memberSecondaries
- from: TransferMember
  to: Member_Certification
  kind: has_many
  via: memberCertification
- from: TransferMember
  to: Member_Coe
  kind: has_many
  via: memberCoe
- from: TransferMember
  to: Member_Demographic
  kind: has_many
  via: memberDemographic
- from: TransferMember
  to: BizMemberDesignation
  kind: has_many
  via: memberDesignation
- from: TransferMember
  to: Member_Dues_Payment
  kind: has_many
  via: memberDuesPayment
- from: TransferMember
  to: Member_Education_Level
  kind: has_many
  via: memberEducationLevel
- from: TransferMember
  to: Member_Education
  kind: has_many
  via: memberEducation
- from: TransferMember
  to: Member_Fair_Housing
  kind: has_many
  via: memberFairHousing
- from: TransferMember
  to: Member_Isc_Affiliation
  kind: has_many
  via: memberIscAffiliation
- from: TransferMember
  to: Member_Language
  kind: has_many
  via: memberLanguage
- from: TransferMember
  to: Member_Military_Service
  kind: has_many
  via: memberMilitary
- from: TransferMember
  to: Member_MLS
  kind: has_many
  via: memberMLS
- from: TransferMember
  to: Member_Single_Owned_MLS
  kind: has_many
  via: memberSingleOwnedMLS
- from: TransferMember
  to: Member_Master_Record
  kind: has_one
  via: masterRecord
- from: TransferMember
  to: Office
  kind: has_one
  via: office
- from: TransferOffice
  to: Office
  kind: has_one
  via: billingOffice
- from: TransferOffice
  to: Office
  kind: has_one
  via: mainOffice
- from: TransferOffice
  to: Office
  kind: has_one
  via: franchiseOffice
- from: TransferOffice
  to: Office
  kind: has_one
  via: parentCompanyOffice
- from: TransferOffice
  to: RefOfficeStatusType
  kind: has_one
  via: refOfficeStatusType
- from: TransferOffice
  to: Ref_Branch_Type
  kind: has_one
  via: refBranchType
- from: TransferOffice
  to: Member
  kind: has_one
  via: officeContactDr
- from: TransferOffice
  to: Member
  kind: has_one
  via: officeContactManager
- from: TransferOffice
  to: Association
  kind: has_one
  via: primaryLocalAssociation
- from: TransferOffice
  to: Association
  kind: has_one
  via: primaryStateAssociation
- from: TransferOffice
  to: Ref_State
  kind: has_one
  via: refStreetState
- from: TransferOffice
  to: Ref_State
  kind: has_one
  via: refMailState
- from: TransferOffice
  to: OfficeSecondary
  kind: has_many
  via: officeSecondaries