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

Get a list of portal configurations for the brand within a branch. Processes this agency API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize	The page size value supplied with the request.	integer	Default value is 20
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfPortalConfigurationDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of 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",
      "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"
    }
  ]
}