GET api/branding/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.Branding.Query.Get.BrandingDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| BrandDocuments | Collection of Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract |
None. |
|
| PortalConfigurations | Collection of Dezrez.Core.DataContracts.External.Api.Agency.Query.Portals.PortalConfigurationDataContract |
None. |
|
| PortalCustomisations | Collection of Dezrez.Core.DataContracts.External.Api.Agency.Query.Portals.PortalCustomisationDataContract |
None. |
|
| SalesPropertyUrl | string |
None. |
|
| LettingsPropertyUrl | string |
None. |
|
| AnytimeBaseUrl | string |
None. |
|
| SystemStatus | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
| CreatedDate | date |
None. |
|
| CreatedBy | Dezrez.Core.DataContracts.External.Api.People.Query.Get.CreatedByDataContract |
None. |
|
| Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"BrandDocuments": [
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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
},
{
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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"
}
],
"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": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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": "2024-04-24T15:08:43.4109Z",
"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",
"AnytimeBaseUrl": "sample string 4",
"SystemStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2024-04-24T15:08:43.4109Z",
"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": 6
}