GET api/branding/getallbrands

Get all brands with details for an agency

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BrandInfoDataContract
NameDescriptionTypeAdditional information
Name

string

None.

AgencyName

string

None.

BranchName

string

None.

BrandLogo

DocumentDataContract

None.

PortalConfigurations

Collection of PortalConfigurationDataContract

None.

AgencyId

integer

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "AgencyName": "sample string 2",
    "BranchName": "sample string 3",
    "BrandLogo": {
      "Url": "sample string 1",
      "RequiresAuthentication": true,
      "ExpiryDate": "2023-02-04T23:08:59.9471652Z",
      "FileStream": null,
      "Tags": [
        {
          "Name": "sample string 1",
          "SystemStatusName": "sample string 2",
          "TagType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "SystemStatusName": "sample string 2",
          "TagType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 3
        }
      ],
      "DocumentType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "DocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "FileExtension": "sample string 5",
      "Description": "sample string 6",
      "FileSize": "sample string 7",
      "CreatedDate": "2023-02-04T23:08:59.9471652Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 9
    },
    "PortalConfigurations": [
      {
        "Id": "sample string 1",
        "PortalId": "sample string 2",
        "PortalName": "sample string 3",
        "BranchId": 4,
        "BranchName": "sample string 5",
        "BrandId": 6,
        "BrandName": "sample string 7",
        "IncludeSalesRoles": true,
        "IncludeLettingsRoles": true,
        "IsLive": true,
        "IncludeUnderOffer": true,
        "IncludeOfferAccepted": true,
        "BranchReference": "sample string 13",
        "LeadBranchId": "sample string 14",
        "BatchFormat": "sample string 15",
        "PictureWidth": 16,
        "FloorplanWidth": 17,
        "AdditionalSettings": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "UseTestMode": true,
        "NegotiatorId": 19,
        "SystemStatusName": "sample string 20",
        "ExclusiveHours": 21,
        "ImageResetActivated": true,
        "RolesToPerformImageReset": [
          1,
          2
        ],
        "SendToWormhole": true,
        "PortalSpecification": "sample string 24"
      },
      {
        "Id": "sample string 1",
        "PortalId": "sample string 2",
        "PortalName": "sample string 3",
        "BranchId": 4,
        "BranchName": "sample string 5",
        "BrandId": 6,
        "BrandName": "sample string 7",
        "IncludeSalesRoles": true,
        "IncludeLettingsRoles": true,
        "IsLive": true,
        "IncludeUnderOffer": true,
        "IncludeOfferAccepted": true,
        "BranchReference": "sample string 13",
        "LeadBranchId": "sample string 14",
        "BatchFormat": "sample string 15",
        "PictureWidth": 16,
        "FloorplanWidth": 17,
        "AdditionalSettings": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "UseTestMode": true,
        "NegotiatorId": 19,
        "SystemStatusName": "sample string 20",
        "ExclusiveHours": 21,
        "ImageResetActivated": true,
        "RolesToPerformImageReset": [
          1,
          2
        ],
        "SendToWormhole": true,
        "PortalSpecification": "sample string 24"
      }
    ],
    "AgencyId": 4,
    "Id": 5
  },
  {
    "Name": "sample string 1",
    "AgencyName": "sample string 2",
    "BranchName": "sample string 3",
    "BrandLogo": {
      "Url": "sample string 1",
      "RequiresAuthentication": true,
      "ExpiryDate": "2023-02-04T23:08:59.9471652Z",
      "FileStream": null,
      "Tags": [
        {
          "Name": "sample string 1",
          "SystemStatusName": "sample string 2",
          "TagType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 3
        },
        {
          "Name": "sample string 1",
          "SystemStatusName": "sample string 2",
          "TagType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Id": 3
        }
      ],
      "DocumentType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "DocumentSubType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FileName": "sample string 3",
      "ContentType": "sample string 4",
      "FileExtension": "sample string 5",
      "Description": "sample string 6",
      "FileSize": "sample string 7",
      "CreatedDate": "2023-02-04T23:08:59.9471652Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 9
    },
    "PortalConfigurations": [
      {
        "Id": "sample string 1",
        "PortalId": "sample string 2",
        "PortalName": "sample string 3",
        "BranchId": 4,
        "BranchName": "sample string 5",
        "BrandId": 6,
        "BrandName": "sample string 7",
        "IncludeSalesRoles": true,
        "IncludeLettingsRoles": true,
        "IsLive": true,
        "IncludeUnderOffer": true,
        "IncludeOfferAccepted": true,
        "BranchReference": "sample string 13",
        "LeadBranchId": "sample string 14",
        "BatchFormat": "sample string 15",
        "PictureWidth": 16,
        "FloorplanWidth": 17,
        "AdditionalSettings": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "UseTestMode": true,
        "NegotiatorId": 19,
        "SystemStatusName": "sample string 20",
        "ExclusiveHours": 21,
        "ImageResetActivated": true,
        "RolesToPerformImageReset": [
          1,
          2
        ],
        "SendToWormhole": true,
        "PortalSpecification": "sample string 24"
      },
      {
        "Id": "sample string 1",
        "PortalId": "sample string 2",
        "PortalName": "sample string 3",
        "BranchId": 4,
        "BranchName": "sample string 5",
        "BrandId": 6,
        "BrandName": "sample string 7",
        "IncludeSalesRoles": true,
        "IncludeLettingsRoles": true,
        "IsLive": true,
        "IncludeUnderOffer": true,
        "IncludeOfferAccepted": true,
        "BranchReference": "sample string 13",
        "LeadBranchId": "sample string 14",
        "BatchFormat": "sample string 15",
        "PictureWidth": 16,
        "FloorplanWidth": 17,
        "AdditionalSettings": {
          "sample string 1": "sample string 2",
          "sample string 3": "sample string 4"
        },
        "UseTestMode": true,
        "NegotiatorId": 19,
        "SystemStatusName": "sample string 20",
        "ExclusiveHours": 21,
        "ImageResetActivated": true,
        "RolesToPerformImageReset": [
          1,
          2
        ],
        "SendToWormhole": true,
        "PortalSpecification": "sample string 24"
      }
    ],
    "AgencyId": 4,
    "Id": 5
  }
]