GET api/property/{id}/roles?pageSize={pageSize}&pageNumber={pageNumber}&roleTypes[0]={roleTypes[0]}&roleTypes[1]={roleTypes[1]}&roleStatuses[0]={roleStatuses[0]}&roleStatuses[1]={roleStatuses[1]}

Get the roles for a property by property id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the property to get the roles for

integer

Required

pageSize

integer

Default value is 20

pageNumber

integer

Default value is 1

roleTypes

Collection of string

None.

roleStatuses

Collection of string

None.

Body Parameters

None.

Response Information

Resource Description

A list of descriptions for the property or null if the property does not exist

PagedCollectionDataContractOfRoleDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of RoleDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "CustomFields": [
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        },
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        }
      ],
      "CreatedDate": "2020-12-03T04:54:25.2502017Z",
      "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
    },
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "CustomFields": [
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        },
        {
          "Name": "sample string 1",
          "Values": [
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            },
            {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 1",
              "Value": {}
            }
          ]
        }
      ],
      "CreatedDate": "2020-12-03T04:54:25.2502017Z",
      "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
    }
  ]
}