GET api/Corporation/GetBranch?q={q}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
q

string

Required

Body Parameters

None.

Response Information

Resource Description

AsapResponseOfListOfBranchDTO
NameDescriptionTypeAdditional information
isSuccess

boolean

None.

message

string

None.

jsonObj

Collection of BranchDTO

None.

totalCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "message": "sample string 2",
  "jsonObj": [
    {
      "CompanyLevel": 1,
      "isNew": true,
      "BranchCode": "sample string 2",
      "CorporationCode": "sample string 3",
      "BillAccount": "sample string 4",
      "Name": "sample string 5",
      "ShortName": "sample string 6",
      "Address": "sample string 7",
      "Suite": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "StateCode": "sample string 11",
      "Zip": "sample string 12",
      "ZipExt": "sample string 13",
      "Country": "sample string 14",
      "CountryCode": "sample string 15",
      "ValidFlag": true,
      "DateCreated": "2026-08-04T14:30:24.280503-07:00",
      "PrimaryDER": {
        "UserIdentityId": 1,
        "Regulation": "sample string 2",
        "CompanyCode": "sample string 3",
        "CompanyLevelType": 1,
        "IsPrimary": true,
        "SameAsCompanyAddress": true,
        "Address": "Sample String 6",
        "Suite": "Sample String 7",
        "City": "sample string 8",
        "State": "sample string 9",
        "ZipCode": "sample string 10",
        "Country": "sample string 11",
        "WorkPhone": "sample string 12",
        "AlternativePhone": "sample string 13",
        "SecureFax": "sample string 14",
        "OpenFax": "sample string 15",
        "Email": "sample string 16",
        "NoticeByFax": true,
        "NoticeByEmail": true,
        "Note": "sample string 19",
        "ValidFlag": true,
        "UserStatus": 64,
        "UserType": 64,
        "RoleId": 23,
        "RoleTitle": "sample string 24",
        "DateCreated": "2026-08-04T14:30:24.280503-07:00",
        "NumberOfEmployee": 1,
        "ListPointOfContactTypeId": [
          1,
          2
        ],
        "ListPointOfContactTypeName": "sample string 26",
        "ListWorkLocationCode": [
          "sample string 1",
          "sample string 2"
        ],
        "ListWorkLocationName": "sample string 27",
        "FullName": "Sample String 39 Sample String 38",
        "CellPhone": "sample string 28",
        "IsAssigned": true,
        "UrlReferrer": "http://webapihelppage30.com",
        "IsSsoEnable": true,
        "SsoIdentityID": "sample string 31",
        "SsoInternalID": "sample string 32",
        "TaxonomyCode": "sample string 33",
        "UserId": 34,
        "LoginId": "sample string 35",
        "Password": "sample string 36",
        "UserTypeId": 1,
        "EmployeeSSN": "sample string 37",
        "LastName": "Sample String 38",
        "FirstName": "Sample String 39",
        "MiddleName": "Sample String 40",
        "Gender": "sample string 41",
        "SecurityQuestion1": "sample string 42",
        "Answer1": "sample string 43",
        "SecurityQuestion2": "sample string 44",
        "Answer2": "sample string 45",
        "Status": 0,
        "UserStatusByte": 64,
        "PasswordExpiredDate": "2026-08-04T14:30:24.280503-07:00",
        "FailedLoginAttempts": 64,
        "PermissionList": [
          {
            "UserPermissionId": 1,
            "UserId": 2,
            "PermissionId": 3,
            "PermissionName": "sample string 4",
            "IsActive": true,
            "insertUserId": 6,
            "insertDate": "2026-08-04T14:30:24.280503-07:00",
            "updateUserId": 8,
            "updateDate": "2026-08-04T14:30:24.280503-07:00"
          },
          {
            "UserPermissionId": 1,
            "UserId": 2,
            "PermissionId": 3,
            "PermissionName": "sample string 4",
            "IsActive": true,
            "insertUserId": 6,
            "insertDate": "2026-08-04T14:30:24.280503-07:00",
            "updateUserId": 8,
            "updateDate": "2026-08-04T14:30:24.280503-07:00"
          }
        ],
        "CompanyCodes": [
          "sample string 1",
          "sample string 2"
        ],
        "Abbreviation": "sample string 48",
        "TypeId": 64,
        "TokenId": "sample string 50",
        "TokenExpiredDate": "2026-08-04T14:30:24.280503-07:00",
        "Required2FA": true,
        "IsActivation": true,
        "IsDeviceFound": true,
        "TOTPTokenId": "sample string 55",
        "GpsGateUserId": 1,
        "NPICode": "sample string 56",
        "PersonId": 57
      },
      "ClientCode": "sample string 18",
      "SameAsCompanyAddress": true
    },
    {
      "CompanyLevel": 1,
      "isNew": true,
      "BranchCode": "sample string 2",
      "CorporationCode": "sample string 3",
      "BillAccount": "sample string 4",
      "Name": "sample string 5",
      "ShortName": "sample string 6",
      "Address": "sample string 7",
      "Suite": "sample string 8",
      "City": "sample string 9",
      "State": "sample string 10",
      "StateCode": "sample string 11",
      "Zip": "sample string 12",
      "ZipExt": "sample string 13",
      "Country": "sample string 14",
      "CountryCode": "sample string 15",
      "ValidFlag": true,
      "DateCreated": "2026-08-04T14:30:24.280503-07:00",
      "PrimaryDER": {
        "UserIdentityId": 1,
        "Regulation": "sample string 2",
        "CompanyCode": "sample string 3",
        "CompanyLevelType": 1,
        "IsPrimary": true,
        "SameAsCompanyAddress": true,
        "Address": "Sample String 6",
        "Suite": "Sample String 7",
        "City": "sample string 8",
        "State": "sample string 9",
        "ZipCode": "sample string 10",
        "Country": "sample string 11",
        "WorkPhone": "sample string 12",
        "AlternativePhone": "sample string 13",
        "SecureFax": "sample string 14",
        "OpenFax": "sample string 15",
        "Email": "sample string 16",
        "NoticeByFax": true,
        "NoticeByEmail": true,
        "Note": "sample string 19",
        "ValidFlag": true,
        "UserStatus": 64,
        "UserType": 64,
        "RoleId": 23,
        "RoleTitle": "sample string 24",
        "DateCreated": "2026-08-04T14:30:24.280503-07:00",
        "NumberOfEmployee": 1,
        "ListPointOfContactTypeId": [
          1,
          2
        ],
        "ListPointOfContactTypeName": "sample string 26",
        "ListWorkLocationCode": [
          "sample string 1",
          "sample string 2"
        ],
        "ListWorkLocationName": "sample string 27",
        "FullName": "Sample String 39 Sample String 38",
        "CellPhone": "sample string 28",
        "IsAssigned": true,
        "UrlReferrer": "http://webapihelppage30.com",
        "IsSsoEnable": true,
        "SsoIdentityID": "sample string 31",
        "SsoInternalID": "sample string 32",
        "TaxonomyCode": "sample string 33",
        "UserId": 34,
        "LoginId": "sample string 35",
        "Password": "sample string 36",
        "UserTypeId": 1,
        "EmployeeSSN": "sample string 37",
        "LastName": "Sample String 38",
        "FirstName": "Sample String 39",
        "MiddleName": "Sample String 40",
        "Gender": "sample string 41",
        "SecurityQuestion1": "sample string 42",
        "Answer1": "sample string 43",
        "SecurityQuestion2": "sample string 44",
        "Answer2": "sample string 45",
        "Status": 0,
        "UserStatusByte": 64,
        "PasswordExpiredDate": "2026-08-04T14:30:24.280503-07:00",
        "FailedLoginAttempts": 64,
        "PermissionList": [
          {
            "UserPermissionId": 1,
            "UserId": 2,
            "PermissionId": 3,
            "PermissionName": "sample string 4",
            "IsActive": true,
            "insertUserId": 6,
            "insertDate": "2026-08-04T14:30:24.280503-07:00",
            "updateUserId": 8,
            "updateDate": "2026-08-04T14:30:24.280503-07:00"
          },
          {
            "UserPermissionId": 1,
            "UserId": 2,
            "PermissionId": 3,
            "PermissionName": "sample string 4",
            "IsActive": true,
            "insertUserId": 6,
            "insertDate": "2026-08-04T14:30:24.280503-07:00",
            "updateUserId": 8,
            "updateDate": "2026-08-04T14:30:24.280503-07:00"
          }
        ],
        "CompanyCodes": [
          "sample string 1",
          "sample string 2"
        ],
        "Abbreviation": "sample string 48",
        "TypeId": 64,
        "TokenId": "sample string 50",
        "TokenExpiredDate": "2026-08-04T14:30:24.280503-07:00",
        "Required2FA": true,
        "IsActivation": true,
        "IsDeviceFound": true,
        "TOTPTokenId": "sample string 55",
        "GpsGateUserId": 1,
        "NPICode": "sample string 56",
        "PersonId": 57
      },
      "ClientCode": "sample string 18",
      "SameAsCompanyAddress": true
    }
  ],
  "totalCount": 3
}