GET api/agency/portalconfigurations?pageSize={pageSize}&pageNumber={pageNumber}

Get a list of portal configurations for the brand within a branch.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfPortalConfigurationDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of PortalConfigurationDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "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",
      "BatchFormat": "sample string 14",
      "PictureWidth": 15,
      "FloorplanWidth": 16,
      "AdditionalSettings": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "UseTestMode": true,
      "NegotiatorId": 18,
      "SystemStatusName": "sample string 19",
      "ExclusiveHours": 20,
      "ImageResetActivated": true,
      "RolesToPerformImageReset": [
        1,
        2
      ],
      "SendToWormhole": true
    },
    {
      "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",
      "BatchFormat": "sample string 14",
      "PictureWidth": 15,
      "FloorplanWidth": 16,
      "AdditionalSettings": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "UseTestMode": true,
      "NegotiatorId": 18,
      "SystemStatusName": "sample string 19",
      "ExclusiveHours": 20,
      "ImageResetActivated": true,
      "RolesToPerformImageReset": [
        1,
        2
      ],
      "SendToWormhole": true
    }
  ]
}