GET api/people/{id}/roles?pageSize={pageSize}&pageNumber={pageNumber}
Get basic role infomation for a Person by PersonId
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
|
| pageSize | integer |
Default value is 20 |
|
| pageNumber | integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
A list of basic role information for a person
Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Get.Group.BasicPersonRoleDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | Dezrez.Core.DataContracts.External.Api.Location.Query.AddressDataContract |
None. |
|
| PrimaryPhoto | Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract |
None. |
|
| Price | decimal number |
None. |
|
| PriceType | string |
None. |
|
| RoleType | string |
None. |
|
| PropertyStatus | string |
None. |
|
| RoleId | integer |
None. |
|
| OfferCount | integer |
None. |
|
| OfferAcceptedPrice | decimal number |
None. |
|
| ViewingCount | integer |
None. |
|
| PropertyId | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Address": {
"Location": {
"CenterPoint": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Extent": [
{
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
{
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
}
],
"ViewPoints": [
{
"Point": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Pitch": 1.1,
"Heading": 2.1,
"FieldOfVision": 3.1,
"Zoom": 4.1,
"Label": "sample string 5",
"Id": 6
},
{
"Point": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Pitch": 1.1,
"Heading": 2.1,
"FieldOfVision": 3.1,
"Zoom": 4.1,
"Label": "sample string 5",
"Id": 6
}
],
"Id": 1
},
"AddressSource": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SourceId": "sample string 1",
"OrganizationName": "sample string 2",
"Number": "sample string 3",
"BuildingName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"CreatedDate": "2024-04-25T02:21:38.1124455Z",
"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": 11
},
"PrimaryPhoto": {
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-04-25T02:21:38.1124455Z",
"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-25T02:21:38.1124455Z",
"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
},
"Price": 1.1,
"PriceType": "sample string 2",
"RoleType": "sample string 3",
"PropertyStatus": "sample string 4",
"RoleId": 5,
"OfferCount": 6,
"OfferAcceptedPrice": 1.1,
"ViewingCount": 7,
"PropertyId": 8
},
{
"Address": {
"Location": {
"CenterPoint": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Extent": [
{
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
{
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
}
],
"ViewPoints": [
{
"Point": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Pitch": 1.1,
"Heading": 2.1,
"FieldOfVision": 3.1,
"Zoom": 4.1,
"Label": "sample string 5",
"Id": 6
},
{
"Point": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Pitch": 1.1,
"Heading": 2.1,
"FieldOfVision": 3.1,
"Zoom": 4.1,
"Label": "sample string 5",
"Id": 6
}
],
"Id": 1
},
"AddressSource": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"SourceId": "sample string 1",
"OrganizationName": "sample string 2",
"Number": "sample string 3",
"BuildingName": "sample string 4",
"Street": "sample string 5",
"Town": "sample string 6",
"Locality": "sample string 7",
"County": "sample string 8",
"Postcode": "sample string 9",
"CreatedDate": "2024-04-25T02:21:38.1124455Z",
"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": 11
},
"PrimaryPhoto": {
"Url": "sample string 1",
"RequiresAuthentication": true,
"ExpiryDate": "2024-04-25T02:21:38.1124455Z",
"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-25T02:21:38.1124455Z",
"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
},
"Price": 1.1,
"PriceType": "sample string 2",
"RoleType": "sample string 3",
"PropertyStatus": "sample string 4",
"RoleId": 5,
"OfferCount": 6,
"OfferAcceptedPrice": 1.1,
"ViewingCount": 7,
"PropertyId": 8
}
]