GET api/people/{id}
Get a person by its Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The id of the person to get. Pass 0 to be returned an empty data contract. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The person or null if it does not exist
Dezrez.Core.DataContracts.External.Api.People.Query.Get.PersonDataContractResponse Formats
application/json, text/json
Sample:
{ "Gender": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Note": "sample string 4", "ContactName": "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 }, "GroupCount": 6, "GroupMemberships": [ { "Group": { "Name": "sample string 1", "Description": "sample string 2", "GroupType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "GroupIcon": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SystemStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "GroupBackgroundImageUrl": "sample string 3", "Id": 4 }, "RelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SystemStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 1 }, { "Group": { "Name": "sample string 1", "Description": "sample string 2", "GroupType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "GroupIcon": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SystemStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "GroupBackgroundImageUrl": "sample string 3", "Id": 4 }, "RelationshipType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "SystemStatus": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 1 } ], "ContactItems": [ { "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 }, { "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 } ], "Addresses": [ { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "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 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-11-14T08:33:14.4005301Z", "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": 12 }, { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "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 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-11-14T08:33:14.4005301Z", "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": 12 } ], "ArchivedAddresses": [ { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "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 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-11-14T08:33:14.4005301Z", "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": 12 }, { "AddressType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ContactOrder": 1, "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 2", "OrganizationName": "sample string 3", "Number": "sample string 4", "BuildingName": "sample string 5", "Street": "sample string 6", "Town": "sample string 7", "Locality": "sample string 8", "County": "sample string 9", "Postcode": "sample string 10", "CreatedDate": "2024-11-14T08:33:14.4005301Z", "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": 12 } ], "AdditionalInformation": { "ProofOfIdReceived": true, "RightToRentReceived": true, "HousingBenefit": { "LocalAuthorityId": 1, "ReceivesBenefits": true, "Reference": "sample string 3", "Id": 4 }, "Documents": [ { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-11-14T08:33:14.4005301Z", "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-11-14T08:33:14.4005301Z", "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 }, { "Url": "sample string 1", "RequiresAuthentication": true, "ExpiryDate": "2024-11-14T08:33:14.4005301Z", "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-11-14T08:33:14.4005301Z", "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 } ], "TOBSigned": true, "NRLStatus": true, "NRLNumber": "sample string 5", "RegistrationScheme": { "RegistrationDate": "2024-11-14T08:33:14.4005301Z", "ExpiryDate": "2024-11-14T08:33:14.4005301Z", "Name": "sample string 3", "Id": 4 }, "RightToRentType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "RightToRentStatus": 6 }, "MarketingPreferences": [ { "ServiceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ServiceStatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Referral": true, "ReferralStatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 2 }, { "ServiceType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ServiceStatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Referral": true, "ReferralStatusType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Id": 2 } ], "GroupIds": [ 1, 2 ], "HasBankAccounts": true, "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": "2024-11-14T08:33:14.4005301Z", "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 }