GET api/ContactProfile/GetContactProfileByContactID?contactID={contactID}&showInactive={showInactive}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactID | integer |
Required |
|
showInactive | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ContactProfileVMName | Description | Type | Additional information |
---|---|---|---|
ContactProfile | ContactProfileModel |
None. |
|
EmploymentStatusList | Collection of EmploymentStatusForList |
None. |
|
DisplaySettings | ContactProfileDisplaySettings |
None. |
|
Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ContactProfile": { "ContactID": 1, "Hair": "sample string 2", "Build": "sample string 3", "Height": "sample string 4", "Eyes": "sample string 5", "EmploymentStatusID": 1, "IsContactOnInvalidityBenefit": true, "IsContactOnFamilyTaxCredit": true, "IsContactOnIncomeSupport": true, "IsContactOnJobSeekersAllowance": true, "IsContactOnLowIncome": true, "IsContactSingleParent": true, "IsContactOnHoliday": true, "ContactOnHolidayDueBackDate": "2025-09-02T23:08:53.0259516+00:00", "IsContactBankrupt": true, "IsContactPregnant": true, "IsContactLanguageProblems": true, "IsContactInPrison": true, "IsContactTerminallyIll": true, "IsContactInHospital": true, "IsContactMentallyIll": true, "IsContactDisabled": true, "IsContactDeceased": true, "IsContactOS": true, "IsContactInMilitary": true, "ContactNationalInsuranceNumber": "sample string 6", "ContactDeceasedYear": 1, "ContactDeceasedMonth": 1, "ContactDeceasedDay": 1, "ContactDeceasedRegNumber": "sample string 7", "ContactDeceasedCauseOfDeath": "sample string 8", "ContactMovedOSWhere": "sample string 9", "ContactMovedOSYear": 1, "ContactMovedOSMonth": 1, "ContactMovedOSDay": 1, "ContactBankruptcyOrderNumber": "sample string 10", "ContactPrisonName": "sample string 11", "ContactPrisonReleaseYear": 1, "ContactPrisonReleaseMonth": 1, "ContactPrisonReleaseDay": 1, "ContactResidency": "sample string 12", "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:08:53.0259516+00:00", "ModifyID": 1, "ModifySessionID": 1, "ModifyTS": "2025-09-02T23:08:53.0259516+00:00", "InactiveID": 1, "InactiveSessionID": 1, "InactiveTS": "2025-09-02T23:08:53.0259516+00:00", "StatusID": 1, "ContactTaxFileNumber": "sample string 13", "ContactPhotoMediaID": 1, "ContactPhysicalDescription": "sample string 14", "IsContactOnSingleIncomeFamilySupplement": true, "ContactDriversLicenseNumber": "sample string 15", "ContactDeceasedDate": "2025-09-02T23:08:53.0259516+00:00", "BecameMemberDate": "2025-09-02T23:08:53.0259516+00:00", "DCSID": 1, "AdmitDate": "2025-09-02T23:08:53.0259516+00:00", "AccountID": 1 }, "EmploymentStatusList": [ { "EmploymentStatusID": 1, "EmploymentStatus": "sample string 2" }, { "EmploymentStatusID": 1, "EmploymentStatus": "sample string 2" } ], "DisplaySettings": { "PrisonAdditionsVisible": true }, "Response": null }, { "ContactProfile": { "ContactID": 1, "Hair": "sample string 2", "Build": "sample string 3", "Height": "sample string 4", "Eyes": "sample string 5", "EmploymentStatusID": 1, "IsContactOnInvalidityBenefit": true, "IsContactOnFamilyTaxCredit": true, "IsContactOnIncomeSupport": true, "IsContactOnJobSeekersAllowance": true, "IsContactOnLowIncome": true, "IsContactSingleParent": true, "IsContactOnHoliday": true, "ContactOnHolidayDueBackDate": "2025-09-02T23:08:53.0259516+00:00", "IsContactBankrupt": true, "IsContactPregnant": true, "IsContactLanguageProblems": true, "IsContactInPrison": true, "IsContactTerminallyIll": true, "IsContactInHospital": true, "IsContactMentallyIll": true, "IsContactDisabled": true, "IsContactDeceased": true, "IsContactOS": true, "IsContactInMilitary": true, "ContactNationalInsuranceNumber": "sample string 6", "ContactDeceasedYear": 1, "ContactDeceasedMonth": 1, "ContactDeceasedDay": 1, "ContactDeceasedRegNumber": "sample string 7", "ContactDeceasedCauseOfDeath": "sample string 8", "ContactMovedOSWhere": "sample string 9", "ContactMovedOSYear": 1, "ContactMovedOSMonth": 1, "ContactMovedOSDay": 1, "ContactBankruptcyOrderNumber": "sample string 10", "ContactPrisonName": "sample string 11", "ContactPrisonReleaseYear": 1, "ContactPrisonReleaseMonth": 1, "ContactPrisonReleaseDay": 1, "ContactResidency": "sample string 12", "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:08:53.0259516+00:00", "ModifyID": 1, "ModifySessionID": 1, "ModifyTS": "2025-09-02T23:08:53.0259516+00:00", "InactiveID": 1, "InactiveSessionID": 1, "InactiveTS": "2025-09-02T23:08:53.0259516+00:00", "StatusID": 1, "ContactTaxFileNumber": "sample string 13", "ContactPhotoMediaID": 1, "ContactPhysicalDescription": "sample string 14", "IsContactOnSingleIncomeFamilySupplement": true, "ContactDriversLicenseNumber": "sample string 15", "ContactDeceasedDate": "2025-09-02T23:08:53.0259516+00:00", "BecameMemberDate": "2025-09-02T23:08:53.0259516+00:00", "DCSID": 1, "AdmitDate": "2025-09-02T23:08:53.0259516+00:00", "AccountID": 1 }, "EmploymentStatusList": [ { "EmploymentStatusID": 1, "EmploymentStatus": "sample string 2" }, { "EmploymentStatusID": 1, "EmploymentStatus": "sample string 2" } ], "DisplaySettings": { "PrisonAdditionsVisible": true }, "Response": null } ]
application/xml, text/xml
Sample:
<ArrayOfContactProfileVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.ContactProfile"> <ContactProfileVM> <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" /> <ContactProfile xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ContactProfile"> <d3p1:AccountID>1</d3p1:AccountID> <d3p1:AdmitDate>2025-09-02T23:08:53.0259516+00:00</d3p1:AdmitDate> <d3p1:BecameMemberDate>2025-09-02T23:08:53.0259516+00:00</d3p1:BecameMemberDate> <d3p1:Build>sample string 3</d3p1:Build> <d3p1:ContactBankruptcyOrderNumber>sample string 10</d3p1:ContactBankruptcyOrderNumber> <d3p1:ContactDeceasedCauseOfDeath>sample string 8</d3p1:ContactDeceasedCauseOfDeath> <d3p1:ContactDeceasedDate>2025-09-02T23:08:53.0259516+00:00</d3p1:ContactDeceasedDate> <d3p1:ContactDeceasedDay>1</d3p1:ContactDeceasedDay> <d3p1:ContactDeceasedMonth>1</d3p1:ContactDeceasedMonth> <d3p1:ContactDeceasedRegNumber>sample string 7</d3p1:ContactDeceasedRegNumber> <d3p1:ContactDeceasedYear>1</d3p1:ContactDeceasedYear> <d3p1:ContactDriversLicenseNumber>sample string 15</d3p1:ContactDriversLicenseNumber> <d3p1:ContactID>1</d3p1:ContactID> <d3p1:ContactMovedOSDay>1</d3p1:ContactMovedOSDay> <d3p1:ContactMovedOSMonth>1</d3p1:ContactMovedOSMonth> <d3p1:ContactMovedOSWhere>sample string 9</d3p1:ContactMovedOSWhere> <d3p1:ContactMovedOSYear>1</d3p1:ContactMovedOSYear> <d3p1:ContactNationalInsuranceNumber>sample string 6</d3p1:ContactNationalInsuranceNumber> <d3p1:ContactOnHolidayDueBackDate>2025-09-02T23:08:53.0259516+00:00</d3p1:ContactOnHolidayDueBackDate> <d3p1:ContactPhotoMediaID>1</d3p1:ContactPhotoMediaID> <d3p1:ContactPhysicalDescription>sample string 14</d3p1:ContactPhysicalDescription> <d3p1:ContactPrisonName>sample string 11</d3p1:ContactPrisonName> <d3p1:ContactPrisonReleaseDay>1</d3p1:ContactPrisonReleaseDay> <d3p1:ContactPrisonReleaseMonth>1</d3p1:ContactPrisonReleaseMonth> <d3p1:ContactPrisonReleaseYear>1</d3p1:ContactPrisonReleaseYear> <d3p1:ContactResidency>sample string 12</d3p1:ContactResidency> <d3p1:ContactTaxFileNumber>sample string 13</d3p1:ContactTaxFileNumber> <d3p1:CreateID>1</d3p1:CreateID> <d3p1:CreateSessionID>1</d3p1:CreateSessionID> <d3p1:CreateTS>2025-09-02T23:08:53.0259516+00:00</d3p1:CreateTS> <d3p1:DCSID>1</d3p1:DCSID> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> <d3p1:Eyes>sample string 5</d3p1:Eyes> <d3p1:Hair>sample string 2</d3p1:Hair> <d3p1:Height>sample string 4</d3p1:Height> <d3p1:InactiveID>1</d3p1:InactiveID> <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID> <d3p1:InactiveTS>2025-09-02T23:08:53.0259516+00:00</d3p1:InactiveTS> <d3p1:IsContactBankrupt>true</d3p1:IsContactBankrupt> <d3p1:IsContactDeceased>true</d3p1:IsContactDeceased> <d3p1:IsContactDisabled>true</d3p1:IsContactDisabled> <d3p1:IsContactInHospital>true</d3p1:IsContactInHospital> <d3p1:IsContactInMilitary>true</d3p1:IsContactInMilitary> <d3p1:IsContactInPrison>true</d3p1:IsContactInPrison> <d3p1:IsContactLanguageProblems>true</d3p1:IsContactLanguageProblems> <d3p1:IsContactMentallyIll>true</d3p1:IsContactMentallyIll> <d3p1:IsContactOS>true</d3p1:IsContactOS> <d3p1:IsContactOnFamilyTaxCredit>true</d3p1:IsContactOnFamilyTaxCredit> <d3p1:IsContactOnHoliday>true</d3p1:IsContactOnHoliday> <d3p1:IsContactOnIncomeSupport>true</d3p1:IsContactOnIncomeSupport> <d3p1:IsContactOnInvalidityBenefit>true</d3p1:IsContactOnInvalidityBenefit> <d3p1:IsContactOnJobSeekersAllowance>true</d3p1:IsContactOnJobSeekersAllowance> <d3p1:IsContactOnLowIncome>true</d3p1:IsContactOnLowIncome> <d3p1:IsContactOnSingleIncomeFamilySupplement>true</d3p1:IsContactOnSingleIncomeFamilySupplement> <d3p1:IsContactPregnant>true</d3p1:IsContactPregnant> <d3p1:IsContactSingleParent>true</d3p1:IsContactSingleParent> <d3p1:IsContactTerminallyIll>true</d3p1:IsContactTerminallyIll> <d3p1:ModifyID>1</d3p1:ModifyID> <d3p1:ModifySessionID>1</d3p1:ModifySessionID> <d3p1:ModifyTS>2025-09-02T23:08:53.0259516+00:00</d3p1:ModifyTS> <d3p1:StatusID>1</d3p1:StatusID> </ContactProfile> <DisplaySettings> <PrisonAdditionsVisible>true</PrisonAdditionsVisible> </DisplaySettings> <EmploymentStatusList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.EmploymentStatus"> <d3p1:EmploymentStatusForList> <d3p1:EmploymentStatus>sample string 2</d3p1:EmploymentStatus> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> </d3p1:EmploymentStatusForList> <d3p1:EmploymentStatusForList> <d3p1:EmploymentStatus>sample string 2</d3p1:EmploymentStatus> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> </d3p1:EmploymentStatusForList> </EmploymentStatusList> </ContactProfileVM> <ContactProfileVM> <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" /> <ContactProfile xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ContactProfile"> <d3p1:AccountID>1</d3p1:AccountID> <d3p1:AdmitDate>2025-09-02T23:08:53.0259516+00:00</d3p1:AdmitDate> <d3p1:BecameMemberDate>2025-09-02T23:08:53.0259516+00:00</d3p1:BecameMemberDate> <d3p1:Build>sample string 3</d3p1:Build> <d3p1:ContactBankruptcyOrderNumber>sample string 10</d3p1:ContactBankruptcyOrderNumber> <d3p1:ContactDeceasedCauseOfDeath>sample string 8</d3p1:ContactDeceasedCauseOfDeath> <d3p1:ContactDeceasedDate>2025-09-02T23:08:53.0259516+00:00</d3p1:ContactDeceasedDate> <d3p1:ContactDeceasedDay>1</d3p1:ContactDeceasedDay> <d3p1:ContactDeceasedMonth>1</d3p1:ContactDeceasedMonth> <d3p1:ContactDeceasedRegNumber>sample string 7</d3p1:ContactDeceasedRegNumber> <d3p1:ContactDeceasedYear>1</d3p1:ContactDeceasedYear> <d3p1:ContactDriversLicenseNumber>sample string 15</d3p1:ContactDriversLicenseNumber> <d3p1:ContactID>1</d3p1:ContactID> <d3p1:ContactMovedOSDay>1</d3p1:ContactMovedOSDay> <d3p1:ContactMovedOSMonth>1</d3p1:ContactMovedOSMonth> <d3p1:ContactMovedOSWhere>sample string 9</d3p1:ContactMovedOSWhere> <d3p1:ContactMovedOSYear>1</d3p1:ContactMovedOSYear> <d3p1:ContactNationalInsuranceNumber>sample string 6</d3p1:ContactNationalInsuranceNumber> <d3p1:ContactOnHolidayDueBackDate>2025-09-02T23:08:53.0259516+00:00</d3p1:ContactOnHolidayDueBackDate> <d3p1:ContactPhotoMediaID>1</d3p1:ContactPhotoMediaID> <d3p1:ContactPhysicalDescription>sample string 14</d3p1:ContactPhysicalDescription> <d3p1:ContactPrisonName>sample string 11</d3p1:ContactPrisonName> <d3p1:ContactPrisonReleaseDay>1</d3p1:ContactPrisonReleaseDay> <d3p1:ContactPrisonReleaseMonth>1</d3p1:ContactPrisonReleaseMonth> <d3p1:ContactPrisonReleaseYear>1</d3p1:ContactPrisonReleaseYear> <d3p1:ContactResidency>sample string 12</d3p1:ContactResidency> <d3p1:ContactTaxFileNumber>sample string 13</d3p1:ContactTaxFileNumber> <d3p1:CreateID>1</d3p1:CreateID> <d3p1:CreateSessionID>1</d3p1:CreateSessionID> <d3p1:CreateTS>2025-09-02T23:08:53.0259516+00:00</d3p1:CreateTS> <d3p1:DCSID>1</d3p1:DCSID> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> <d3p1:Eyes>sample string 5</d3p1:Eyes> <d3p1:Hair>sample string 2</d3p1:Hair> <d3p1:Height>sample string 4</d3p1:Height> <d3p1:InactiveID>1</d3p1:InactiveID> <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID> <d3p1:InactiveTS>2025-09-02T23:08:53.0259516+00:00</d3p1:InactiveTS> <d3p1:IsContactBankrupt>true</d3p1:IsContactBankrupt> <d3p1:IsContactDeceased>true</d3p1:IsContactDeceased> <d3p1:IsContactDisabled>true</d3p1:IsContactDisabled> <d3p1:IsContactInHospital>true</d3p1:IsContactInHospital> <d3p1:IsContactInMilitary>true</d3p1:IsContactInMilitary> <d3p1:IsContactInPrison>true</d3p1:IsContactInPrison> <d3p1:IsContactLanguageProblems>true</d3p1:IsContactLanguageProblems> <d3p1:IsContactMentallyIll>true</d3p1:IsContactMentallyIll> <d3p1:IsContactOS>true</d3p1:IsContactOS> <d3p1:IsContactOnFamilyTaxCredit>true</d3p1:IsContactOnFamilyTaxCredit> <d3p1:IsContactOnHoliday>true</d3p1:IsContactOnHoliday> <d3p1:IsContactOnIncomeSupport>true</d3p1:IsContactOnIncomeSupport> <d3p1:IsContactOnInvalidityBenefit>true</d3p1:IsContactOnInvalidityBenefit> <d3p1:IsContactOnJobSeekersAllowance>true</d3p1:IsContactOnJobSeekersAllowance> <d3p1:IsContactOnLowIncome>true</d3p1:IsContactOnLowIncome> <d3p1:IsContactOnSingleIncomeFamilySupplement>true</d3p1:IsContactOnSingleIncomeFamilySupplement> <d3p1:IsContactPregnant>true</d3p1:IsContactPregnant> <d3p1:IsContactSingleParent>true</d3p1:IsContactSingleParent> <d3p1:IsContactTerminallyIll>true</d3p1:IsContactTerminallyIll> <d3p1:ModifyID>1</d3p1:ModifyID> <d3p1:ModifySessionID>1</d3p1:ModifySessionID> <d3p1:ModifyTS>2025-09-02T23:08:53.0259516+00:00</d3p1:ModifyTS> <d3p1:StatusID>1</d3p1:StatusID> </ContactProfile> <DisplaySettings> <PrisonAdditionsVisible>true</PrisonAdditionsVisible> </DisplaySettings> <EmploymentStatusList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.EmploymentStatus"> <d3p1:EmploymentStatusForList> <d3p1:EmploymentStatus>sample string 2</d3p1:EmploymentStatus> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> </d3p1:EmploymentStatusForList> <d3p1:EmploymentStatusForList> <d3p1:EmploymentStatus>sample string 2</d3p1:EmploymentStatus> <d3p1:EmploymentStatusID>1</d3p1:EmploymentStatusID> </d3p1:EmploymentStatusForList> </EmploymentStatusList> </ContactProfileVM> </ArrayOfContactProfileVM>