GET api/contacts/GetContactDetailContactByContactID?contactID={contactID}&accountID={accountID}&contactMode={contactMode}&showInactiveRelationships={showInactiveRelationships}&showInactivePreferedCmmunication={showInactivePreferedCmmunication}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactID | integer |
Required |
|
accountID | integer |
Required |
|
contactMode | ContactMode |
Required |
|
showInactiveRelationships | boolean |
Default value is False |
|
showInactivePreferedCmmunication | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ContactEditVMName | Description | Type | Additional information |
---|---|---|---|
ContactModelVM | ContactModelVM |
None. |
|
RelationshipList | Collection of RelationshipForList |
None. |
|
GenderList | Collection of GenderForList |
None. |
|
DriversLienseCountryList | Collection of CountryForList |
None. |
|
DriversLienseStateList | Collection of StateForList |
None. |
|
DisplaySettings | ContactDisplaySettings |
None. |
|
ContactList | Collection of ContactForList |
None. |
|
Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
{ "ContactModelVM": { "Contact": { "ContactID": 1, "IsPerson": true, "IsUser": true, "ContactTypeID": 1, "RoleID": 1, "Title": "sample string 1", "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4", "TitleSuffix": "sample string 5", "ContactPosition": "sample string 6", "EntityName": "sample string 7", "TradingAs": "sample string 8", "BusinessNumber": "sample string 9", "CorporationNumber": "sample string 10", "UserName": "sample string 11", "Password": "sample string 12", "DOB": "2025-09-02T23:09:30.9089256+00:00", "GenderID": 1, "Primary_AddressID": 1, "PrimaryEmail_ContactDetailID": 1, "PrimaryPhone_ContactDetailID": 1, "PrimaryFax_ContactDetailID": 1, "PrimaryInternal_ContactID": 1, "SectionName": "sample string 13", "OfficeName": "sample string 14", "LoadID": 1, "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:09:30.9089256+00:00", "ModifyID": 1, "ModifySessionID": 1, "ModifyTS": "2025-09-02T23:09:30.9089256+00:00", "InactiveID": 1, "InactiveSessionID": 1, "InactiveTS": "2025-09-02T23:09:30.9089256+00:00", "StatusID": 1, "Z_DB": 1, "Z_ID": 1, "ChargeOutRate": 1.0, "LUPPasswordChangeDate": "2025-09-02T23:09:30.9089256+00:00", "ChargeOutTaxRate": 1.0, "LoadSequence": 1, "AccountLoadID": 1, "PasswordChange_FrequencyID": 1, "LoadContactID": 1, "LUPCapitalCredit": 15.0, "LUPCapitalDebit": 16.0, "Capital_FrequencyID": 1, "LUPTotalCapital": 1.0, "LUPTotalAsset": 1.0, "LUPTotalLiability": 1.0, "Z_IDSTR": "sample string 17", "Z_REF": "sample string 18", "Z_REF2": "sample string 19", "Z_REF3": "sample string 20", "LimitAdult": 1, "LimitChild1": 1, "LimitChild2": 1, "Solicitor_Code": "sample string 21", "ContactReference": "sample string 22", "Parent_ContactID": 1, "DriversLicenceNumber": "sample string 23", "AccountContactTypeID": 1, "ContactRelatedPartyTypeID": 1, "IsLoginEnable": true, "HideFullNameOnDebtorExtranet": true, "IsUserBank": true, "UserBankId": 1, "GuarantorDate": "2025-09-02T23:09:30.9089256+00:00", "DriversLicenseCountryID": 1, "DriversLicenseStateID": 1, "BusinessID": 1, "SiteID": 1, "IsTemporaryPassword": true, "EntitiesId": "sample string 26", "DriversLicenseDescription": "sample string 27", "Acquired_CustomerID": "sample string 28" }, "CommunicationPreferenceList": [ { "CommunicationPreferenceID": 1, "CommunicationPreference": "sample string 2", "IsChecked": true }, { "CommunicationPreferenceID": 1, "CommunicationPreference": "sample string 2", "IsChecked": true } ], "AccountContactRelationship": { "ContactID": 1, "AccountID": 1, "RelationshipID": 1, "RelationshipDesc": "sample string 1", "LUPLastLetterID": 1, "LUPLastLetterSentDate": "2025-09-02T23:09:30.9089256+00:00", "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:09:30.9089256+00:00", "ModifyID": 1, "ModifySessionID": 1, "ModifyTS": "2025-09-02T23:09:30.9089256+00:00", "InactiveID": 1, "InactiveSessionID": 1, "InactiveTS": "2025-09-02T23:09:30.9089256+00:00", "StatusID": 1, "Z_DB": 1, "Z_ID": 1, "LUPLastPhoneDate": "2025-09-02T23:09:30.9089256+00:00", "Related_ContactID": 1, "Primary_Related_ContactID": 1, "Primary_Related_Contact_ActiveTS": "2025-09-02T23:09:30.9089256+00:00", "Related_ContactReference": "sample string 2", "Secondary_RelationshipID": 1 }, "DebtorStatusList": [ { "DebtorStatusID": 1, "DebtorStatus": "sample string 2", "IsChecked": true }, { "DebtorStatusID": 1, "DebtorStatus": "sample string 2", "IsChecked": true } ], "ContactMode": 0, "ContactContactVM": { "ContactRelatedPartyTypeID": 1, "RelationStartDate": "2025-09-02T23:09:30.9089256+00:00", "RelationEndDate": "2025-09-02T23:09:30.9089256+00:00", "Contact_ContactID": 1, "ContactRelatedPartyTypeList": [ { "ContactRelatedPartyTypeID": 1, "ContactRelatedPartyType": "sample string 2" }, { "ContactRelatedPartyTypeID": 1, "ContactRelatedPartyType": "sample string 2" } ] } }, "RelationshipList": [ { "RelationshipID": 1, "Relationship": "sample string 2" }, { "RelationshipID": 1, "Relationship": "sample string 2" } ], "GenderList": [ { "GenderID": 1, "Gender": "sample string 2" }, { "GenderID": 1, "Gender": "sample string 2" } ], "DriversLienseCountryList": [ { "CountryID": 1, "Country": "sample string 2" }, { "CountryID": 1, "Country": "sample string 2" } ], "DriversLienseStateList": [ { "StateID": 1, "State": "sample string 2", "StateShort": "sample string 3" }, { "StateID": 1, "State": "sample string 2", "StateShort": "sample string 3" } ], "DisplaySettings": { "PanelRelationshipVisible": true, "PanelSecondaryRelationshipVisible": true, "IsUserEnabled": true, "UserTitleEnabled": true, "CheckBoxPrimaryContactVisible": true, "CheckboxLegalContactVisible": true, "CheckboxAccountsReceivable": true, "PanelContactVisible": true, "IsUsernameValidationMandaory": true, "IsPasswordValidationMandaory": true, "PanelRelationshipGridVisible": true, "IsPersonOrCompanyVisible": true, "CompanyDetailsVisible": true, "IsUserVisible": true, "IsUserChecked": true, "UserTitleVisible": true, "PanelContactReferenceVisible": true, "CanViewPassword": true, "CanRegeneratePassword": true, "PanelCompanyDetailsVisible": true, "PanelRelatedPartyTypeVisible": true }, "ContactList": [ { "ContactID": 1, "Name": "sample string 2", "IsChecked": true, "ContactIDEncrypted": "sample string 4", "RelationshipID": 5 }, { "ContactID": 1, "Name": "sample string 2", "IsChecked": true, "ContactIDEncrypted": "sample string 4", "RelationshipID": 5 } ], "Response": null }
application/xml, text/xml
Sample:
<ContactEditVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Contact"> <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" /> <ContactList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact"> <d2p1:ContactForList> <d2p1:ContactID>1</d2p1:ContactID> <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted> <d2p1:IsChecked>true</d2p1:IsChecked> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:RelationshipID>5</d2p1:RelationshipID> </d2p1:ContactForList> <d2p1:ContactForList> <d2p1:ContactID>1</d2p1:ContactID> <d2p1:ContactIDEncrypted>sample string 4</d2p1:ContactIDEncrypted> <d2p1:IsChecked>true</d2p1:IsChecked> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:RelationshipID>5</d2p1:RelationshipID> </d2p1:ContactForList> </ContactList> <ContactModelVM> <AccountContactRelationship xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AccountContact"> <d3p1:AccountID>1</d3p1:AccountID> <d3p1:ContactID>1</d3p1:ContactID> <d3p1:CreateID>1</d3p1:CreateID> <d3p1:CreateSessionID>1</d3p1:CreateSessionID> <d3p1:CreateTS>2025-09-02T23:09:30.9089256+00:00</d3p1:CreateTS> <d3p1:InactiveID>1</d3p1:InactiveID> <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID> <d3p1:InactiveTS>2025-09-02T23:09:30.9089256+00:00</d3p1:InactiveTS> <d3p1:LUPLastLetterID>1</d3p1:LUPLastLetterID> <d3p1:LUPLastLetterSentDate>2025-09-02T23:09:30.9089256+00:00</d3p1:LUPLastLetterSentDate> <d3p1:LUPLastPhoneDate>2025-09-02T23:09:30.9089256+00:00</d3p1:LUPLastPhoneDate> <d3p1:ModifyID>1</d3p1:ModifyID> <d3p1:ModifySessionID>1</d3p1:ModifySessionID> <d3p1:ModifyTS>2025-09-02T23:09:30.9089256+00:00</d3p1:ModifyTS> <d3p1:Primary_Related_ContactID>1</d3p1:Primary_Related_ContactID> <d3p1:Primary_Related_Contact_ActiveTS>2025-09-02T23:09:30.9089256+00:00</d3p1:Primary_Related_Contact_ActiveTS> <d3p1:Related_ContactID>1</d3p1:Related_ContactID> <d3p1:Related_ContactReference>sample string 2</d3p1:Related_ContactReference> <d3p1:RelationshipDesc>sample string 1</d3p1:RelationshipDesc> <d3p1:RelationshipID>1</d3p1:RelationshipID> <d3p1:Secondary_RelationshipID>1</d3p1:Secondary_RelationshipID> <d3p1:StatusID>1</d3p1:StatusID> <d3p1:Z_DB>1</d3p1:Z_DB> <d3p1:Z_ID>1</d3p1:Z_ID> </AccountContactRelationship> <CommunicationPreferenceList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.CommunicationPrefrence"> <d3p1:CommunicationPreferenceForList> <d3p1:CommunicationPreference>sample string 2</d3p1:CommunicationPreference> <d3p1:CommunicationPreferenceID>1</d3p1:CommunicationPreferenceID> <d3p1:IsChecked>true</d3p1:IsChecked> </d3p1:CommunicationPreferenceForList> <d3p1:CommunicationPreferenceForList> <d3p1:CommunicationPreference>sample string 2</d3p1:CommunicationPreference> <d3p1:CommunicationPreferenceID>1</d3p1:CommunicationPreferenceID> <d3p1:IsChecked>true</d3p1:IsChecked> </d3p1:CommunicationPreferenceForList> </CommunicationPreferenceList> <Contact xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Contact"> <d3p1:AccountContactTypeID>1</d3p1:AccountContactTypeID> <d3p1:AccountLoadID>1</d3p1:AccountLoadID> <d3p1:Acquired_CustomerID>sample string 28</d3p1:Acquired_CustomerID> <d3p1:BusinessID>1</d3p1:BusinessID> <d3p1:BusinessNumber>sample string 9</d3p1:BusinessNumber> <d3p1:Capital_FrequencyID>1</d3p1:Capital_FrequencyID> <d3p1:ChargeOutRate>1</d3p1:ChargeOutRate> <d3p1:ChargeOutTaxRate>1</d3p1:ChargeOutTaxRate> <d3p1:ContactID>1</d3p1:ContactID> <d3p1:ContactPosition>sample string 6</d3p1:ContactPosition> <d3p1:ContactReference>sample string 22</d3p1:ContactReference> <d3p1:ContactRelatedPartyTypeID>1</d3p1:ContactRelatedPartyTypeID> <d3p1:ContactTypeID>1</d3p1:ContactTypeID> <d3p1:CorporationNumber>sample string 10</d3p1:CorporationNumber> <d3p1:CreateID>1</d3p1:CreateID> <d3p1:CreateSessionID>1</d3p1:CreateSessionID> <d3p1:CreateTS>2025-09-02T23:09:30.9089256+00:00</d3p1:CreateTS> <d3p1:DOB>2025-09-02T23:09:30.9089256+00:00</d3p1:DOB> <d3p1:DriversLicenceNumber>sample string 23</d3p1:DriversLicenceNumber> <d3p1:DriversLicenseCountryID>1</d3p1:DriversLicenseCountryID> <d3p1:DriversLicenseDescription>sample string 27</d3p1:DriversLicenseDescription> <d3p1:DriversLicenseStateID>1</d3p1:DriversLicenseStateID> <d3p1:EntitiesId>sample string 26</d3p1:EntitiesId> <d3p1:EntityName>sample string 7</d3p1:EntityName> <d3p1:FirstName>sample string 2</d3p1:FirstName> <d3p1:GenderID>1</d3p1:GenderID> <d3p1:GuarantorDate>2025-09-02T23:09:30.9089256+00:00</d3p1:GuarantorDate> <d3p1:HideFullNameOnDebtorExtranet>true</d3p1:HideFullNameOnDebtorExtranet> <d3p1:InactiveID>1</d3p1:InactiveID> <d3p1:InactiveSessionID>1</d3p1:InactiveSessionID> <d3p1:InactiveTS>2025-09-02T23:09:30.9089256+00:00</d3p1:InactiveTS> <d3p1:IsLoginEnable>true</d3p1:IsLoginEnable> <d3p1:IsPerson>true</d3p1:IsPerson> <d3p1:IsTemporaryPassword>true</d3p1:IsTemporaryPassword> <d3p1:IsUser>true</d3p1:IsUser> <d3p1:IsUserBank>true</d3p1:IsUserBank> <d3p1:LUPCapitalCredit>15</d3p1:LUPCapitalCredit> <d3p1:LUPCapitalDebit>16</d3p1:LUPCapitalDebit> <d3p1:LUPPasswordChangeDate>2025-09-02T23:09:30.9089256+00:00</d3p1:LUPPasswordChangeDate> <d3p1:LUPTotalAsset>1</d3p1:LUPTotalAsset> <d3p1:LUPTotalCapital>1</d3p1:LUPTotalCapital> <d3p1:LUPTotalLiability>1</d3p1:LUPTotalLiability> <d3p1:LastName>sample string 4</d3p1:LastName> <d3p1:LimitAdult>1</d3p1:LimitAdult> <d3p1:LimitChild1>1</d3p1:LimitChild1> <d3p1:LimitChild2>1</d3p1:LimitChild2> <d3p1:LoadContactID>1</d3p1:LoadContactID> <d3p1:LoadID>1</d3p1:LoadID> <d3p1:LoadSequence>1</d3p1:LoadSequence> <d3p1:MiddleName>sample string 3</d3p1:MiddleName> <d3p1:ModifyID>1</d3p1:ModifyID> <d3p1:ModifySessionID>1</d3p1:ModifySessionID> <d3p1:ModifyTS>2025-09-02T23:09:30.9089256+00:00</d3p1:ModifyTS> <d3p1:OfficeName>sample string 14</d3p1:OfficeName> <d3p1:Parent_ContactID>1</d3p1:Parent_ContactID> <d3p1:Password>sample string 12</d3p1:Password> <d3p1:PasswordChange_FrequencyID>1</d3p1:PasswordChange_FrequencyID> <d3p1:PrimaryEmail_ContactDetailID>1</d3p1:PrimaryEmail_ContactDetailID> <d3p1:PrimaryFax_ContactDetailID>1</d3p1:PrimaryFax_ContactDetailID> <d3p1:PrimaryInternal_ContactID>1</d3p1:PrimaryInternal_ContactID> <d3p1:PrimaryPhone_ContactDetailID>1</d3p1:PrimaryPhone_ContactDetailID> <d3p1:Primary_AddressID>1</d3p1:Primary_AddressID> <d3p1:RoleID>1</d3p1:RoleID> <d3p1:SectionName>sample string 13</d3p1:SectionName> <d3p1:SiteID>1</d3p1:SiteID> <d3p1:Solicitor_Code>sample string 21</d3p1:Solicitor_Code> <d3p1:StatusID>1</d3p1:StatusID> <d3p1:Title>sample string 1</d3p1:Title> <d3p1:TitleSuffix>sample string 5</d3p1:TitleSuffix> <d3p1:TradingAs>sample string 8</d3p1:TradingAs> <d3p1:UserBankId>1</d3p1:UserBankId> <d3p1:UserName>sample string 11</d3p1:UserName> <d3p1:Z_DB>1</d3p1:Z_DB> <d3p1:Z_ID>1</d3p1:Z_ID> <d3p1:Z_IDSTR>sample string 17</d3p1:Z_IDSTR> <d3p1:Z_REF>sample string 18</d3p1:Z_REF> <d3p1:Z_REF2>sample string 19</d3p1:Z_REF2> <d3p1:Z_REF3>sample string 20</d3p1:Z_REF3> </Contact> <ContactContactVM xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.ContactContact"> <d3p1:ContactRelatedPartyTypeID>1</d3p1:ContactRelatedPartyTypeID> <d3p1:ContactRelatedPartyTypeList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ContactRelatedPartyType"> <d4p1:ContactRelatedPartyTypeForList> <d4p1:ContactRelatedPartyType>sample string 2</d4p1:ContactRelatedPartyType> <d4p1:ContactRelatedPartyTypeID>1</d4p1:ContactRelatedPartyTypeID> </d4p1:ContactRelatedPartyTypeForList> <d4p1:ContactRelatedPartyTypeForList> <d4p1:ContactRelatedPartyType>sample string 2</d4p1:ContactRelatedPartyType> <d4p1:ContactRelatedPartyTypeID>1</d4p1:ContactRelatedPartyTypeID> </d4p1:ContactRelatedPartyTypeForList> </d3p1:ContactRelatedPartyTypeList> <d3p1:Contact_ContactID>1</d3p1:Contact_ContactID> <d3p1:RelationEndDate>2025-09-02T23:09:30.9089256+00:00</d3p1:RelationEndDate> <d3p1:RelationStartDate>2025-09-02T23:09:30.9089256+00:00</d3p1:RelationStartDate> </ContactContactVM> <ContactMode>None</ContactMode> <DebtorStatusList xmlns:d3p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.DebtorStatus"> <d3p1:DebtorStatusForList> <d3p1:DebtorStatus>sample string 2</d3p1:DebtorStatus> <d3p1:DebtorStatusID>1</d3p1:DebtorStatusID> <d3p1:IsChecked>true</d3p1:IsChecked> </d3p1:DebtorStatusForList> <d3p1:DebtorStatusForList> <d3p1:DebtorStatus>sample string 2</d3p1:DebtorStatus> <d3p1:DebtorStatusID>1</d3p1:DebtorStatusID> <d3p1:IsChecked>true</d3p1:IsChecked> </d3p1:DebtorStatusForList> </DebtorStatusList> </ContactModelVM> <DisplaySettings> <CanRegeneratePassword>true</CanRegeneratePassword> <CanViewPassword>true</CanViewPassword> <CheckBoxPrimaryContactVisible>true</CheckBoxPrimaryContactVisible> <CheckboxAccountsReceivable>true</CheckboxAccountsReceivable> <CheckboxLegalContactVisible>true</CheckboxLegalContactVisible> <CompanyDetailsVisible>true</CompanyDetailsVisible> <IsPasswordValidationMandaory>true</IsPasswordValidationMandaory> <IsPersonOrCompanyVisible>true</IsPersonOrCompanyVisible> <IsUserChecked>true</IsUserChecked> <IsUserEnabled>true</IsUserEnabled> <IsUserVisible>true</IsUserVisible> <IsUsernameValidationMandaory>true</IsUsernameValidationMandaory> <PanelCompanyDetailsVisible>true</PanelCompanyDetailsVisible> <PanelContactReferenceVisible>true</PanelContactReferenceVisible> <PanelContactVisible>true</PanelContactVisible> <PanelRelatedPartyTypeVisible>true</PanelRelatedPartyTypeVisible> <PanelRelationshipGridVisible>true</PanelRelationshipGridVisible> <PanelRelationshipVisible>true</PanelRelationshipVisible> <PanelSecondaryRelationshipVisible>true</PanelSecondaryRelationshipVisible> <UserTitleEnabled>true</UserTitleEnabled> <UserTitleVisible>true</UserTitleVisible> </DisplaySettings> <DriversLienseCountryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Country"> <d2p1:CountryForList> <d2p1:Country>sample string 2</d2p1:Country> <d2p1:CountryID>1</d2p1:CountryID> </d2p1:CountryForList> <d2p1:CountryForList> <d2p1:Country>sample string 2</d2p1:Country> <d2p1:CountryID>1</d2p1:CountryID> </d2p1:CountryForList> </DriversLienseCountryList> <DriversLienseStateList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.State"> <d2p1:StateForList> <d2p1:State>sample string 2</d2p1:State> <d2p1:StateID>1</d2p1:StateID> <d2p1:StateShort>sample string 3</d2p1:StateShort> </d2p1:StateForList> <d2p1:StateForList> <d2p1:State>sample string 2</d2p1:State> <d2p1:StateID>1</d2p1:StateID> <d2p1:StateShort>sample string 3</d2p1:StateShort> </d2p1:StateForList> </DriversLienseStateList> <GenderList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Gender"> <d2p1:GenderForList> <d2p1:Gender>sample string 2</d2p1:Gender> <d2p1:GenderID>1</d2p1:GenderID> </d2p1:GenderForList> <d2p1:GenderForList> <d2p1:Gender>sample string 2</d2p1:Gender> <d2p1:GenderID>1</d2p1:GenderID> </d2p1:GenderForList> </GenderList> <RelationshipList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Relationship"> <d2p1:RelationshipForList> <d2p1:Relationship>sample string 2</d2p1:Relationship> <d2p1:RelationshipID>1</d2p1:RelationshipID> </d2p1:RelationshipForList> <d2p1:RelationshipForList> <d2p1:Relationship>sample string 2</d2p1:Relationship> <d2p1:RelationshipID>1</d2p1:RelationshipID> </d2p1:RelationshipForList> </RelationshipList> </ContactEditVM>