GET api/branding/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

BrandingDataContract
NameDescriptionTypeAdditional information
Name

string

None.

BrandDocuments

Collection of DocumentDataContract

None.

PortalConfigurations

Collection of PortalConfigurationDataContract

None.

PortalCustomisations

Collection of PortalCustomisationDataContract

None.

SalesPropertyUrl

string

None.

LettingsPropertyUrl

string

None.

SystemStatus

EnumDataContract

None.

CreatedDate

date

None.

CreatedBy

CreatedByDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "BrandDocuments": [
    {
      "Url": "sample string 1",
      "RequiresAuthentication": true,
      "ExpiryDate": "2018-12-10T15:00:49.4566568Z",
      "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",
      "CreatedDate": "2018-12-10T15:00:49.4566568Z",
      "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": 8
    },
    {
      "Url": "sample string 1",
      "RequiresAuthentication": true,
      "ExpiryDate": "2018-12-10T15:00:49.4566568Z",
      "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",
      "CreatedDate": "2018-12-10T15:00:49.4566568Z",
      "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": 8
    }
  ],
  "PortalConfigurations": [
    {
      "PortalId": 1,
      "PortalName": "sample string 2",
      "BranchId": 3,
      "BranchName": "sample string 4",
      "BrandId": 5,
      "BrandName": "sample string 6",
      "IncludeSalesRoles": true,
      "IncludeLettingsRoles": true,
      "IsLive": true,
      "IncludeUnderOffer": true,
      "IncludeOfferAccepted": true,
      "BranchReference": "sample string 12",
      "BatchFormat": "sample string 13",
      "PictureWidth": 14,
      "FloorplanWidth": 15,
      "AdditionalSettings": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "UseTestMode": true,
      "NegotiatorId": 17,
      "SystemStatusName": "sample string 18",
      "ExclusiveHours": 19,
      "ImageResetActivated": true,
      "RolesToPerformImageReset": [
        1,
        2
      ],
      "CreatedDate": "2018-12-10T15:00:49.4722747Z",
      "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": 22
    },
    {
      "PortalId": 1,
      "PortalName": "sample string 2",
      "BranchId": 3,
      "BranchName": "sample string 4",
      "BrandId": 5,
      "BrandName": "sample string 6",
      "IncludeSalesRoles": true,
      "IncludeLettingsRoles": true,
      "IsLive": true,
      "IncludeUnderOffer": true,
      "IncludeOfferAccepted": true,
      "BranchReference": "sample string 12",
      "BatchFormat": "sample string 13",
      "PictureWidth": 14,
      "FloorplanWidth": 15,
      "AdditionalSettings": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "UseTestMode": true,
      "NegotiatorId": 17,
      "SystemStatusName": "sample string 18",
      "ExclusiveHours": 19,
      "ImageResetActivated": true,
      "RolesToPerformImageReset": [
        1,
        2
      ],
      "CreatedDate": "2018-12-10T15:00:49.4722747Z",
      "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": 22
    }
  ],
  "PortalCustomisations": [
    {
      "PortalId": 1,
      "BrandId": 2,
      "DescriptionOrder": [
        {
          "DescriptionType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Order": 2,
          "IsActive": true,
          "CreatedDate": "2018-12-10T15:00:49.4722747Z",
          "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": 5
        },
        {
          "DescriptionType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Order": 2,
          "IsActive": true,
          "CreatedDate": "2018-12-10T15:00:49.4722747Z",
          "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": 5
        }
      ],
      "PortalConfigurationId": 3,
      "CreatedDate": "2018-12-10T15:00:49.4722747Z",
      "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": 5
    },
    {
      "PortalId": 1,
      "BrandId": 2,
      "DescriptionOrder": [
        {
          "DescriptionType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Order": 2,
          "IsActive": true,
          "CreatedDate": "2018-12-10T15:00:49.4722747Z",
          "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": 5
        },
        {
          "DescriptionType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 1",
          "Order": 2,
          "IsActive": true,
          "CreatedDate": "2018-12-10T15:00:49.4722747Z",
          "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": 5
        }
      ],
      "PortalConfigurationId": 3,
      "CreatedDate": "2018-12-10T15:00:49.4722747Z",
      "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": 5
    }
  ],
  "SalesPropertyUrl": "sample string 2",
  "LettingsPropertyUrl": "sample string 3",
  "SystemStatus": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "CreatedDate": "2018-12-10T15:00:49.4722747Z",
  "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": 5
}