GET api/Office/GetOfficeListForUser?onlyActive={onlyActive}

Request Information

URI Parameters

Name	Description	Type	Additional information
onlyActive		boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of OfficeDTO

Name	Type	Additional information
TotalGroupLeadCount	string	None.
groupName	string	None.
groupCode	string	None.
OfficeId	integer	None.
AgencyId	integer	None.
AgencyName	string	None.
OfficeName	string	None.
Phone	string	None.
FormattedPhone	string	None.
Address	string	None.
FullAddress	string	None.
StateId	integer	None.
StateName	string	None.
StateCode	string	None.
CityId	integer	None.
CityName	string	None.
Zip	string	None.
CountryId	integer	None.
CountryName	string	None.
GeoAddress	string	None.
Lat	decimal number	None.
Lng	decimal number	None.
CreatedById	integer	None.
UpdatedById	integer	None.
isDisable	boolean	None.
TotalLeadCount	integer	None.
TotalAssignedLeadCount	integer	None.
TotalLeadOnHandCount	integer	None.
Default	boolean	None.
RowIndex	integer	None.
ClientTimeZone	integer	None.
LeadAssigmentSummary	Collection of LeadAssignmentSummaryDTO	None.
IsPosCertificate	boolean	None.
IsCertificate	boolean	None.
IsFreshen	boolean	None.
IsPreApproch	boolean	None.
IsGroupDatasheet	boolean	None.
IsCorporate	boolean	None.
HasOfficeGeoCoded	boolean	None.
SplittedOfficeName	string	None.
UserRoleDictionary	Dictionary of integer [key] and integer [value]	None.
AgentList	Collection of integer	None.
IsAgentExistForCertificateAccess	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "TotalGroupLeadCount": "sample string 1",
    "groupName": "sample string 2",
    "groupCode": "sample string 3",
    "OfficeId": 4,
    "AgencyId": 5,
    "AgencyName": "sample string 6",
    "OfficeName": "sample string 7",
    "Phone": "sample string 8",
    "FormattedPhone": "sample string 8",
    "Address": "sample string 9",
    "FullAddress": "sample string 9, sample string 14, sample string 12, sample string 15, sample string 17",
    "StateId": 10,
    "StateName": "sample string 11",
    "StateCode": "sample string 12",
    "CityId": 13,
    "CityName": "sample string 14",
    "Zip": "sample string 15",
    "CountryId": 16,
    "CountryName": "sample string 17",
    "GeoAddress": "sample string 18",
    "Lat": 19.1,
    "Lng": 20.1,
    "CreatedById": 21,
    "UpdatedById": 22,
    "isDisable": true,
    "TotalLeadCount": 24,
    "TotalAssignedLeadCount": 25,
    "TotalLeadOnHandCount": 26,
    "Default": true,
    "RowIndex": 28,
    "ClientTimeZone": 1,
    "LeadAssigmentSummary": [
      {
        "AssociateContractId": 1,
        "AssociateId": 2,
        "AssociateName": "sample string 3",
        "TotalLeadsAssigned": 4,
        "NumberOfLeadsToAssign": 5,
        "Zip": "sample string 6",
        "CityName": "sample string 7",
        "LeadBankCharge": {
          "InTown": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "RoadTrip": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "LapsePool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "ListPool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          }
        },
        "LeadOriginTotal": {
          "ResponseCard": 1,
          "Referral": 2,
          "POS": 3,
          "ListLead": 4
        },
        "AssignedLeadsDetail": [
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          },
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          }
        ]
      },
      {
        "AssociateContractId": 1,
        "AssociateId": 2,
        "AssociateName": "sample string 3",
        "TotalLeadsAssigned": 4,
        "NumberOfLeadsToAssign": 5,
        "Zip": "sample string 6",
        "CityName": "sample string 7",
        "LeadBankCharge": {
          "InTown": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "RoadTrip": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "LapsePool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "ListPool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          }
        },
        "LeadOriginTotal": {
          "ResponseCard": 1,
          "Referral": 2,
          "POS": 3,
          "ListLead": 4
        },
        "AssignedLeadsDetail": [
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          },
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          }
        ]
      }
    ],
    "IsPosCertificate": true,
    "IsCertificate": true,
    "IsFreshen": true,
    "IsPreApproch": true,
    "IsGroupDatasheet": true,
    "IsCorporate": true,
    "HasOfficeGeoCoded": true,
    "SplittedOfficeName": "sample string 7",
    "UserRoleDictionary": {
      "1": 2,
      "3": 4
    },
    "AgentList": [
      1,
      2
    ],
    "IsAgentExistForCertificateAccess": true
  },
  {
    "TotalGroupLeadCount": "sample string 1",
    "groupName": "sample string 2",
    "groupCode": "sample string 3",
    "OfficeId": 4,
    "AgencyId": 5,
    "AgencyName": "sample string 6",
    "OfficeName": "sample string 7",
    "Phone": "sample string 8",
    "FormattedPhone": "sample string 8",
    "Address": "sample string 9",
    "FullAddress": "sample string 9, sample string 14, sample string 12, sample string 15, sample string 17",
    "StateId": 10,
    "StateName": "sample string 11",
    "StateCode": "sample string 12",
    "CityId": 13,
    "CityName": "sample string 14",
    "Zip": "sample string 15",
    "CountryId": 16,
    "CountryName": "sample string 17",
    "GeoAddress": "sample string 18",
    "Lat": 19.1,
    "Lng": 20.1,
    "CreatedById": 21,
    "UpdatedById": 22,
    "isDisable": true,
    "TotalLeadCount": 24,
    "TotalAssignedLeadCount": 25,
    "TotalLeadOnHandCount": 26,
    "Default": true,
    "RowIndex": 28,
    "ClientTimeZone": 1,
    "LeadAssigmentSummary": [
      {
        "AssociateContractId": 1,
        "AssociateId": 2,
        "AssociateName": "sample string 3",
        "TotalLeadsAssigned": 4,
        "NumberOfLeadsToAssign": 5,
        "Zip": "sample string 6",
        "CityName": "sample string 7",
        "LeadBankCharge": {
          "InTown": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "RoadTrip": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "LapsePool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "ListPool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          }
        },
        "LeadOriginTotal": {
          "ResponseCard": 1,
          "Referral": 2,
          "POS": 3,
          "ListLead": 4
        },
        "AssignedLeadsDetail": [
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          },
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          }
        ]
      },
      {
        "AssociateContractId": 1,
        "AssociateId": 2,
        "AssociateName": "sample string 3",
        "TotalLeadsAssigned": 4,
        "NumberOfLeadsToAssign": 5,
        "Zip": "sample string 6",
        "CityName": "sample string 7",
        "LeadBankCharge": {
          "InTown": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "RoadTrip": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "LapsePool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          },
          "ListPool": {
            "ChargeableCount": 1,
            "NonChargeableCount": 2
          }
        },
        "LeadOriginTotal": {
          "ResponseCard": 1,
          "Referral": 2,
          "POS": 3,
          "ListLead": 4
        },
        "AssignedLeadsDetail": [
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          },
          {
            "Zip": "sample string 1",
            "CityName": "sample string 2",
            "LeadOriginTotal": {
              "ResponseCard": 1,
              "Referral": 2,
              "POS": 3,
              "ListLead": 4
            }
          }
        ]
      }
    ],
    "IsPosCertificate": true,
    "IsCertificate": true,
    "IsFreshen": true,
    "IsPreApproch": true,
    "IsGroupDatasheet": true,
    "IsCorporate": true,
    "HasOfficeGeoCoded": true,
    "SplittedOfficeName": "sample string 7",
    "UserRoleDictionary": {
      "1": 2,
      "3": 4
    },
    "AgentList": [
      1,
      2
    ],
    "IsAgentExistForCertificateAccess": true
  }
]