GET residentapi/properties/{propertyId}/cwsprofile

Gets the CWS profile data for a given property.

Request Information

URI Parameters

Name	Description	Type	Additional information
propertyId	(Required)CWS Property Id	integer	Required

Body Parameters

None.

Response Information

Resource Description

CwsPropertyProfile

Name	Type	Additional information
Welcome	WelcomeSection	None.
AboutUs	AboutUsSection	None.
Amenities	AmenitiesSection	None.
FeaturedAmenities	FeaturedAmenitiesSection	None.
Gallery	Gallery	None.
ResidentAccess	ResidentAccessSection	None.
ContactUs	ContactUsSection	None.
Footer	FooterSection	None.

Response Formats

application/json, text/json

Sample:

{
  "welcome": {
    "backgroundImage": {
      "title": "sample string 1",
      "order": 2,
      "systemFileName": "sample string 3"
    },
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "aboutUs": {
    "aboutUsImage": {
      "title": "sample string 1",
      "order": 2,
      "systemFileName": "sample string 3"
    },
    "profileItems": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "amenities": {
    "amenityItems": [
      {
        "title": "sample string 1",
        "text": "sample string 2",
        "name": "sample string 3",
        "isActive": true
      },
      {
        "title": "sample string 1",
        "text": "sample string 2",
        "name": "sample string 3",
        "isActive": true
      }
    ],
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "featuredAmenities": {
    "images": [
      {
        "title": "sample string 1",
        "order": 2,
        "systemFileName": "sample string 3"
      },
      {
        "title": "sample string 1",
        "order": 2,
        "systemFileName": "sample string 3"
      }
    ],
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "gallery": {
    "galleryItems": [
      {
        "title": "sample string 1",
        "order": 2,
        "systemFileName": "sample string 3"
      },
      {
        "title": "sample string 1",
        "order": 2,
        "systemFileName": "sample string 3"
      }
    ],
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "residentAccess": {
    "residentAccessImage": {
      "title": "sample string 1",
      "order": 2,
      "systemFileName": "sample string 3"
    },
    "display": true,
    "title": "sample string 2",
    "description": "sample string 3"
  },
  "contactUs": {
    "email": {
      "primary": "sample string 1",
      "secondary": "sample string 2",
      "useSecondary": true
    },
    "phone": {
      "primary": "sample string 1",
      "secondary": "sample string 2",
      "useSecondary": true
    },
    "address": "sample string 1",
    "display": true,
    "title": "sample string 3",
    "description": "sample string 4"
  },
  "footer": {
    "weatherWidget": true,
    "socialItems": [
      {
        "name": "sample string 1",
        "value": "sample string 2"
      },
      {
        "name": "sample string 1",
        "value": "sample string 2"
      }
    ],
    "display": true,
    "title": "sample string 3",
    "description": "sample string 4"
  }
}