GET api/Associate/GetAssociateHierarchyByOffice?officeId={officeId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
officeId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of AssociateHierarchyDTO
NameDescriptionTypeAdditional information
UserId

integer

None.

AssociateId

integer

None.

AssociateContractId

integer

None.

ReportToContractId

integer

None.

ReportToAssociateId

integer

None.

FirstName

string

None.

LastName

string

None.

BusinessAssociateCode

string

None.

ContractCode

string

None.

RoleId

integer

None.

RoleName

string

None.

RoleShortName

string

None.

Email

string

None.

EmailVerificationStatus

integer

None.

Level

integer

None.

UserStatus

UserStatusEnum

None.

HierarchyId

integer

None.

RoleTypeId

integer

None.

Phone

string

None.

Mobile

string

None.

OfficeId

integer

None.

OfficeName

string

None.

ContractStartDate

date

None.

HireDate

date

None.

TerminationDate

date

None.

IsContractTerminated

boolean

None.

FullName

string

None.

DescriptiveName

string

None.

DescriptiveNameWithoutRole

string

None.

FullNameWithHierarchyInfo

string

None.

FullNameWithShortRoleName

string

None.

FullRoleDescription

string

None.

FullNameWithBusinessCode

string

None.

ManagerFullName

string

None.

ManagerDescriptiveName

string

None.

DisplayNameExcludeingPipelineInfo

string

None.

ManagerFirstName

string

None.

ManagerLastName

string

None.

ManagerBusinessAssociateCode

string

None.

CreateDate

date

None.

ManagerId

integer

None.

IsSelected

boolean

None.

ManagerOfficeId

integer

None.

IsCoperate

boolean

None.

IsRGAExtended

boolean

None.

IsSimilarManagerAlreadyMerged

boolean

None.

AssociatePipelineStatus

integer

None.

LicensedDate

date

None.

AgencyNotes

string

None.

AgencyNotesID

integer

None.

LastLogin

date

None.

PerCompleted

integer

None.

TestDate

date

None.

ExamFxId

integer

None.

OliversDataId

integer

None.

XcelLicenseingSchoolId

integer

None.

BestScore

integer

None.

ScoreDetails

Collection of string

None.

isAgencyDisplayFakeRoleName

boolean

None.

IsManagerHierarchyTerminateUser

boolean

None.

SaName

string

None.

GaName

string

None.

MgaName

string

None.

RGAName

string

None.

ContractTypeId

integer

None.

ContractType

string

None.

IsNoMatterWhat

boolean

None.

RGAHierarchyLevel

string

None.

ContractPercentage

decimal number

None.

GroupMarketPlaceId

integer

None.

LocationCode

string

None.

LocationContextCode

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UserId": 1,
    "AssociateId": 2,
    "AssociateContractId": 3,
    "ReportToContractId": 1,
    "ReportToAssociateId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "BusinessAssociateCode": "sample string 6",
    "ContractCode": "sample string 7",
    "RoleId": 8,
    "RoleName": "sample string 9",
    "RoleShortName": "sample string 10",
    "Email": "sample string 11",
    "EmailVerificationStatus": 1,
    "Level": 12,
    "UserStatus": 0,
    "HierarchyId": 13,
    "RoleTypeId": 14,
    "Phone": "sample string 15",
    "Mobile": "sample string 16",
    "OfficeId": 17,
    "OfficeName": "sample string 18",
    "ContractStartDate": "2025-10-14T00:40:30.1286211-07:00",
    "HireDate": "2025-10-14T00:40:30.1286211-07:00",
    "TerminationDate": "2025-10-14T00:40:30.1286211-07:00",
    "IsContractTerminated": true,
    "FullName": "sample string 5, sample string 4",
    "DescriptiveName": "sample string 5, sample string 4 - sample string 9 (sample string 6) ",
    "DescriptiveNameWithoutRole": "(sample string 6) sample string 5, sample string 4",
    "FullNameWithHierarchyInfo": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
    "FullNameWithShortRoleName": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
    "FullRoleDescription": "sample string 10sample string 6",
    "FullNameWithBusinessCode": "sample string 5, sample string 4 - sample string 6",
    "ManagerFullName": "sample string 21, sample string 20 - sample string 10 (sample string 22)",
    "ManagerDescriptiveName": "sample string 21, sample string 20 - sample string 9 (sample string 6) ",
    "DisplayNameExcludeingPipelineInfo": "sample string 5, sample string 4 - sample string 9 (sample string 6 -- 1%)",
    "ManagerFirstName": "sample string 20",
    "ManagerLastName": "sample string 21",
    "ManagerBusinessAssociateCode": "sample string 22",
    "CreateDate": "2025-10-14T00:40:30.1286211-07:00",
    "ManagerId": 24,
    "IsSelected": true,
    "ManagerOfficeId": 26,
    "IsCoperate": true,
    "IsRGAExtended": true,
    "IsSimilarManagerAlreadyMerged": true,
    "AssociatePipelineStatus": 1,
    "LicensedDate": "2025-10-14T00:40:30.1286211-07:00",
    "AgencyNotes": "sample string 31",
    "AgencyNotesID": 32,
    "LastLogin": "2025-10-14T00:40:30.1286211-07:00",
    "PerCompleted": 1,
    "TestDate": "2025-10-14T00:40:30.1286211-07:00",
    "ExamFxId": 33,
    "OliversDataId": 34,
    "XcelLicenseingSchoolId": 35,
    "BestScore": 1,
    "ScoreDetails": [
      "sample string 1",
      "sample string 2"
    ],
    "isAgencyDisplayFakeRoleName": true,
    "IsManagerHierarchyTerminateUser": true,
    "SaName": "sample string 38",
    "GaName": "sample string 39",
    "MgaName": "sample string 40",
    "RGAName": "sample string 41",
    "ContractTypeId": 1,
    "ContractType": "",
    "IsNoMatterWhat": true,
    "RGAHierarchyLevel": "sample string 43",
    "ContractPercentage": 1.0,
    "GroupMarketPlaceId": 1,
    "LocationCode": "sample string 44",
    "LocationContextCode": "sample string 45"
  },
  {
    "UserId": 1,
    "AssociateId": 2,
    "AssociateContractId": 3,
    "ReportToContractId": 1,
    "ReportToAssociateId": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "BusinessAssociateCode": "sample string 6",
    "ContractCode": "sample string 7",
    "RoleId": 8,
    "RoleName": "sample string 9",
    "RoleShortName": "sample string 10",
    "Email": "sample string 11",
    "EmailVerificationStatus": 1,
    "Level": 12,
    "UserStatus": 0,
    "HierarchyId": 13,
    "RoleTypeId": 14,
    "Phone": "sample string 15",
    "Mobile": "sample string 16",
    "OfficeId": 17,
    "OfficeName": "sample string 18",
    "ContractStartDate": "2025-10-14T00:40:30.1286211-07:00",
    "HireDate": "2025-10-14T00:40:30.1286211-07:00",
    "TerminationDate": "2025-10-14T00:40:30.1286211-07:00",
    "IsContractTerminated": true,
    "FullName": "sample string 5, sample string 4",
    "DescriptiveName": "sample string 5, sample string 4 - sample string 9 (sample string 6) ",
    "DescriptiveNameWithoutRole": "(sample string 6) sample string 5, sample string 4",
    "FullNameWithHierarchyInfo": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
    "FullNameWithShortRoleName": "sample string 5, sample string 4 - sample string 10(sample string 6) ",
    "FullRoleDescription": "sample string 10sample string 6",
    "FullNameWithBusinessCode": "sample string 5, sample string 4 - sample string 6",
    "ManagerFullName": "sample string 21, sample string 20 - sample string 10 (sample string 22)",
    "ManagerDescriptiveName": "sample string 21, sample string 20 - sample string 9 (sample string 6) ",
    "DisplayNameExcludeingPipelineInfo": "sample string 5, sample string 4 - sample string 9 (sample string 6 -- 1%)",
    "ManagerFirstName": "sample string 20",
    "ManagerLastName": "sample string 21",
    "ManagerBusinessAssociateCode": "sample string 22",
    "CreateDate": "2025-10-14T00:40:30.1286211-07:00",
    "ManagerId": 24,
    "IsSelected": true,
    "ManagerOfficeId": 26,
    "IsCoperate": true,
    "IsRGAExtended": true,
    "IsSimilarManagerAlreadyMerged": true,
    "AssociatePipelineStatus": 1,
    "LicensedDate": "2025-10-14T00:40:30.1286211-07:00",
    "AgencyNotes": "sample string 31",
    "AgencyNotesID": 32,
    "LastLogin": "2025-10-14T00:40:30.1286211-07:00",
    "PerCompleted": 1,
    "TestDate": "2025-10-14T00:40:30.1286211-07:00",
    "ExamFxId": 33,
    "OliversDataId": 34,
    "XcelLicenseingSchoolId": 35,
    "BestScore": 1,
    "ScoreDetails": [
      "sample string 1",
      "sample string 2"
    ],
    "isAgencyDisplayFakeRoleName": true,
    "IsManagerHierarchyTerminateUser": true,
    "SaName": "sample string 38",
    "GaName": "sample string 39",
    "MgaName": "sample string 40",
    "RGAName": "sample string 41",
    "ContractTypeId": 1,
    "ContractType": "",
    "IsNoMatterWhat": true,
    "RGAHierarchyLevel": "sample string 43",
    "ContractPercentage": 1.0,
    "GroupMarketPlaceId": 1,
    "LocationCode": "sample string 44",
    "LocationContextCode": "sample string 45"
  }
]