GET api/Principal/GetPrincipalSummaryExtendedByPrincipalID?principalID={principalID}&showInactive={showInactive}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| principalID | integer |
Required |
|
| showInactive | boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
PrincipalSummaryExtendedVM| Name | Description | Type | Additional information |
|---|---|---|---|
| PrincipalSummary | PrincipalSummaryExtendedByPrincipalID |
None. |
|
| PrincipalComponentList | Collection of PrincipalComponentModel |
None. |
|
| PrincipalDetailList | Collection of PrincipalDetailSummaryByPrincipalID |
None. |
|
| ReissueHistoryList | Collection of PrincipalReissueHistoryModel |
None. |
|
| CurrencyCharacter | string |
None. |
|
| CourtEventList | Collection of CourtEventVM |
None. |
|
| PrincipalStatusHistoryList | Collection of PrincipalStatusHistoryByPrincipalID |
None. |
Response Formats
application/json, text/json
Sample:
{
"PrincipalSummary": {
"PrincipalID": 1,
"TransactionDesc": "sample string 2",
"TransactionAmount": 3.0,
"LUPBalance": 1.0,
"External_RefNo": "sample string 4",
"External_PreviousContact": true,
"External_Review": true,
"PrincipalType": "sample string 5",
"PrincipalTypeCategory": "sample string 6",
"PrincipalStatus": "sample string 7",
"IssuingEntity": "sample string 8",
"TransactionDate": "2026-01-15T08:44:15.1900822+00:00",
"IssueDate": "2026-01-15T08:44:15.1900822+00:00",
"OriginalDueDate": "2026-01-15T08:44:15.1900822+00:00",
"EnforceDate": "2026-01-15T08:44:15.1900822+00:00",
"DueDate": "2026-01-15T08:44:15.1900822+00:00",
"AggregationDate": "2026-01-15T08:44:15.1900822+00:00",
"Original_Name": "sample string 10",
"Original_DOB": "sample string 11",
"Original_DriverLicence": "sample string 12",
"Original_DriverLicenceState": "sample string 13",
"Original_ReminderNoticeDate": "2026-01-15T08:44:15.1900822+00:00",
"Original_EnforcementWarningDate": "2026-01-15T08:44:15.1900822+00:00",
"COAStartDate": "2026-01-15T08:44:15.1900822+00:00",
"COAEndDate": "2026-01-15T08:44:15.1900822+00:00",
"CauseOfActionType": "sample string 14",
"CauseOfAction": "sample string 15",
"NextActionDate": "2026-01-15T08:44:15.1900822+00:00",
"Aggregated": true,
"External_ReturnToSenderCode": "sample string 16",
"InactiveReason": "sample string 17",
"Address": "sample string 18",
"Address2": "sample string 19",
"Address3": "sample string 20",
"Suburb": "sample string 21",
"Postcode": "sample string 22",
"State": "sample string 23",
"IsPreloaded": true,
"Country": "sample string 24"
},
"PrincipalComponentList": [
{
"PrincipalComponentID": 1,
"Amount": 1.0,
"Description": "sample string 1",
"PrincipalID": 1,
"MasterPrincipalComponentID": 1,
"MasterPrincipalComponent": "sample string 2",
"PrincipalComponentTypeID": 1,
"PrincipalComponentType": "sample string 3",
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2026-01-15T08:44:15.1900822+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2026-01-15T08:44:15.1900822+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2026-01-15T08:44:15.1900822+00:00",
"StatusID": 1,
"IsOriginalDebt": true,
"Z_DB": 1,
"Z_ID": 1,
"Z_IDSTR": "sample string 4",
"Z_REF": "sample string 5",
"Z_REF2": "sample string 6",
"Z_REF3": "sample string 7",
"LUPBalance": 1.0
},
{
"PrincipalComponentID": 1,
"Amount": 1.0,
"Description": "sample string 1",
"PrincipalID": 1,
"MasterPrincipalComponentID": 1,
"MasterPrincipalComponent": "sample string 2",
"PrincipalComponentTypeID": 1,
"PrincipalComponentType": "sample string 3",
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2026-01-15T08:44:15.1900822+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2026-01-15T08:44:15.1900822+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2026-01-15T08:44:15.1900822+00:00",
"StatusID": 1,
"IsOriginalDebt": true,
"Z_DB": 1,
"Z_ID": 1,
"Z_IDSTR": "sample string 4",
"Z_REF": "sample string 5",
"Z_REF2": "sample string 6",
"Z_REF3": "sample string 7",
"LUPBalance": 1.0
}
],
"PrincipalDetailList": [
{
"PrincipalDetailID": 1,
"ShortDescription": "sample string 2",
"Agency": "sample string 3",
"External_RefNo": "sample string 4",
"CameraIssued": true,
"Registration": "sample string 5",
"VehicleID": 1,
"PrimaryLawCodeUniqueIdentifire": "sample string 6",
"SecondaryLawCodeUniqueIdentifire": "sample string 7",
"VehicleRegistrationState": "sample string 8",
"LegislativeBase": "sample string 9",
"Act": "sample string 10",
"ActType": "sample string 11",
"Section": "sample string 12",
"LawPart": 1,
"StartDate": "2026-01-15T08:44:15.1900822+00:00",
"Location": "sample string 13",
"LongDescription": "sample string 14"
},
{
"PrincipalDetailID": 1,
"ShortDescription": "sample string 2",
"Agency": "sample string 3",
"External_RefNo": "sample string 4",
"CameraIssued": true,
"Registration": "sample string 5",
"VehicleID": 1,
"PrimaryLawCodeUniqueIdentifire": "sample string 6",
"SecondaryLawCodeUniqueIdentifire": "sample string 7",
"VehicleRegistrationState": "sample string 8",
"LegislativeBase": "sample string 9",
"Act": "sample string 10",
"ActType": "sample string 11",
"Section": "sample string 12",
"LawPart": 1,
"StartDate": "2026-01-15T08:44:15.1900822+00:00",
"Location": "sample string 13",
"LongDescription": "sample string 14"
}
],
"ReissueHistoryList": [
{
"PrincipalID": 1,
"TransactionDesc": "sample string 1",
"Entity": "sample string 2",
"External_RefNo": "sample string 3",
"Issuing_Entity": "sample string 4"
},
{
"PrincipalID": 1,
"TransactionDesc": "sample string 1",
"Entity": "sample string 2",
"External_RefNo": "sample string 3",
"Issuing_Entity": "sample string 4"
}
],
"CurrencyCharacter": "sample string 1",
"CourtEventList": [
{
"CourtEventDesc": "sample string 1",
"SittingLocation": "sample string 2",
"CourtEventDate": "2026-01-15T08:44:15.1900822+00:00",
"Response": null
},
{
"CourtEventDesc": "sample string 1",
"SittingLocation": "sample string 2",
"CourtEventDate": "2026-01-15T08:44:15.1900822+00:00",
"Response": null
}
],
"PrincipalStatusHistoryList": [
{
"PrincipalID": 1,
"PrincipalStatus": "sample string 2",
"ModifyTS": "2026-01-15T08:44:15.1900822+00:00",
"ModifiedBy": "sample string 3"
},
{
"PrincipalID": 1,
"PrincipalStatus": "sample string 2",
"ModifyTS": "2026-01-15T08:44:15.1900822+00:00",
"ModifiedBy": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<PrincipalSummaryExtendedVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal">
<CourtEventList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.CourtEvent">
<d2p1:CourtEventVM>
<Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
<d2p1:CourtEventDate>2026-01-15T08:44:15.1900822+00:00</d2p1:CourtEventDate>
<d2p1:CourtEventDesc>sample string 1</d2p1:CourtEventDesc>
<d2p1:SittingLocation>sample string 2</d2p1:SittingLocation>
</d2p1:CourtEventVM>
<d2p1:CourtEventVM>
<Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
<d2p1:CourtEventDate>2026-01-15T08:44:15.1900822+00:00</d2p1:CourtEventDate>
<d2p1:CourtEventDesc>sample string 1</d2p1:CourtEventDesc>
<d2p1:SittingLocation>sample string 2</d2p1:SittingLocation>
</d2p1:CourtEventVM>
</CourtEventList>
<CurrencyCharacter>sample string 1</CurrencyCharacter>
<PrincipalComponentList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PrincipalComponent">
<d2p1:PrincipalComponentModel>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2026-01-15T08:44:15.1900822+00:00</d2p1:CreateTS>
<d2p1:Description>sample string 1</d2p1:Description>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2026-01-15T08:44:15.1900822+00:00</d2p1:InactiveTS>
<d2p1:IsOriginalDebt>true</d2p1:IsOriginalDebt>
<d2p1:LUPBalance>1</d2p1:LUPBalance>
<d2p1:MasterPrincipalComponent>sample string 2</d2p1:MasterPrincipalComponent>
<d2p1:MasterPrincipalComponentID>1</d2p1:MasterPrincipalComponentID>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2026-01-15T08:44:15.1900822+00:00</d2p1:ModifyTS>
<d2p1:PrincipalComponentID>1</d2p1:PrincipalComponentID>
<d2p1:PrincipalComponentType>sample string 3</d2p1:PrincipalComponentType>
<d2p1:PrincipalComponentTypeID>1</d2p1:PrincipalComponentTypeID>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
<d2p1:Z_IDSTR>sample string 4</d2p1:Z_IDSTR>
<d2p1:Z_REF>sample string 5</d2p1:Z_REF>
<d2p1:Z_REF2>sample string 6</d2p1:Z_REF2>
<d2p1:Z_REF3>sample string 7</d2p1:Z_REF3>
</d2p1:PrincipalComponentModel>
<d2p1:PrincipalComponentModel>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2026-01-15T08:44:15.1900822+00:00</d2p1:CreateTS>
<d2p1:Description>sample string 1</d2p1:Description>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2026-01-15T08:44:15.1900822+00:00</d2p1:InactiveTS>
<d2p1:IsOriginalDebt>true</d2p1:IsOriginalDebt>
<d2p1:LUPBalance>1</d2p1:LUPBalance>
<d2p1:MasterPrincipalComponent>sample string 2</d2p1:MasterPrincipalComponent>
<d2p1:MasterPrincipalComponentID>1</d2p1:MasterPrincipalComponentID>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2026-01-15T08:44:15.1900822+00:00</d2p1:ModifyTS>
<d2p1:PrincipalComponentID>1</d2p1:PrincipalComponentID>
<d2p1:PrincipalComponentType>sample string 3</d2p1:PrincipalComponentType>
<d2p1:PrincipalComponentTypeID>1</d2p1:PrincipalComponentTypeID>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
<d2p1:Z_IDSTR>sample string 4</d2p1:Z_IDSTR>
<d2p1:Z_REF>sample string 5</d2p1:Z_REF>
<d2p1:Z_REF2>sample string 6</d2p1:Z_REF2>
<d2p1:Z_REF3>sample string 7</d2p1:Z_REF3>
</d2p1:PrincipalComponentModel>
</PrincipalComponentList>
<PrincipalDetailList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PrincipalDetail">
<d2p1:PrincipalDetailSummaryByPrincipalID>
<d2p1:Act>sample string 10</d2p1:Act>
<d2p1:ActType>sample string 11</d2p1:ActType>
<d2p1:Agency>sample string 3</d2p1:Agency>
<d2p1:CameraIssued>true</d2p1:CameraIssued>
<d2p1:External_RefNo>sample string 4</d2p1:External_RefNo>
<d2p1:LawPart>1</d2p1:LawPart>
<d2p1:LegislativeBase>sample string 9</d2p1:LegislativeBase>
<d2p1:Location>sample string 13</d2p1:Location>
<d2p1:LongDescription>sample string 14</d2p1:LongDescription>
<d2p1:PrimaryLawCodeUniqueIdentifire>sample string 6</d2p1:PrimaryLawCodeUniqueIdentifire>
<d2p1:PrincipalDetailID>1</d2p1:PrincipalDetailID>
<d2p1:Registration>sample string 5</d2p1:Registration>
<d2p1:SecondaryLawCodeUniqueIdentifire>sample string 7</d2p1:SecondaryLawCodeUniqueIdentifire>
<d2p1:Section>sample string 12</d2p1:Section>
<d2p1:ShortDescription>sample string 2</d2p1:ShortDescription>
<d2p1:StartDate>2026-01-15T08:44:15.1900822+00:00</d2p1:StartDate>
<d2p1:VehicleID>1</d2p1:VehicleID>
<d2p1:VehicleRegistrationState>sample string 8</d2p1:VehicleRegistrationState>
</d2p1:PrincipalDetailSummaryByPrincipalID>
<d2p1:PrincipalDetailSummaryByPrincipalID>
<d2p1:Act>sample string 10</d2p1:Act>
<d2p1:ActType>sample string 11</d2p1:ActType>
<d2p1:Agency>sample string 3</d2p1:Agency>
<d2p1:CameraIssued>true</d2p1:CameraIssued>
<d2p1:External_RefNo>sample string 4</d2p1:External_RefNo>
<d2p1:LawPart>1</d2p1:LawPart>
<d2p1:LegislativeBase>sample string 9</d2p1:LegislativeBase>
<d2p1:Location>sample string 13</d2p1:Location>
<d2p1:LongDescription>sample string 14</d2p1:LongDescription>
<d2p1:PrimaryLawCodeUniqueIdentifire>sample string 6</d2p1:PrimaryLawCodeUniqueIdentifire>
<d2p1:PrincipalDetailID>1</d2p1:PrincipalDetailID>
<d2p1:Registration>sample string 5</d2p1:Registration>
<d2p1:SecondaryLawCodeUniqueIdentifire>sample string 7</d2p1:SecondaryLawCodeUniqueIdentifire>
<d2p1:Section>sample string 12</d2p1:Section>
<d2p1:ShortDescription>sample string 2</d2p1:ShortDescription>
<d2p1:StartDate>2026-01-15T08:44:15.1900822+00:00</d2p1:StartDate>
<d2p1:VehicleID>1</d2p1:VehicleID>
<d2p1:VehicleRegistrationState>sample string 8</d2p1:VehicleRegistrationState>
</d2p1:PrincipalDetailSummaryByPrincipalID>
</PrincipalDetailList>
<PrincipalStatusHistoryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PrincipalStatus">
<d2p1:PrincipalStatusHistoryByPrincipalID>
<d2p1:ModifiedBy>sample string 3</d2p1:ModifiedBy>
<d2p1:ModifyTS>2026-01-15T08:44:15.1900822+00:00</d2p1:ModifyTS>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:PrincipalStatus>sample string 2</d2p1:PrincipalStatus>
</d2p1:PrincipalStatusHistoryByPrincipalID>
<d2p1:PrincipalStatusHistoryByPrincipalID>
<d2p1:ModifiedBy>sample string 3</d2p1:ModifiedBy>
<d2p1:ModifyTS>2026-01-15T08:44:15.1900822+00:00</d2p1:ModifyTS>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:PrincipalStatus>sample string 2</d2p1:PrincipalStatus>
</d2p1:PrincipalStatusHistoryByPrincipalID>
</PrincipalStatusHistoryList>
<PrincipalSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
<d2p1:Address>sample string 18</d2p1:Address>
<d2p1:Address2>sample string 19</d2p1:Address2>
<d2p1:Address3>sample string 20</d2p1:Address3>
<d2p1:Aggregated>true</d2p1:Aggregated>
<d2p1:AggregationDate>2026-01-15T08:44:15.1900822+00:00</d2p1:AggregationDate>
<d2p1:COAEndDate>2026-01-15T08:44:15.1900822+00:00</d2p1:COAEndDate>
<d2p1:COAStartDate>2026-01-15T08:44:15.1900822+00:00</d2p1:COAStartDate>
<d2p1:CauseOfAction>sample string 15</d2p1:CauseOfAction>
<d2p1:CauseOfActionType>sample string 14</d2p1:CauseOfActionType>
<d2p1:Country>sample string 24</d2p1:Country>
<d2p1:DueDate>2026-01-15T08:44:15.1900822+00:00</d2p1:DueDate>
<d2p1:EnforceDate>2026-01-15T08:44:15.1900822+00:00</d2p1:EnforceDate>
<d2p1:External_PreviousContact>true</d2p1:External_PreviousContact>
<d2p1:External_RefNo>sample string 4</d2p1:External_RefNo>
<d2p1:External_ReturnToSenderCode>sample string 16</d2p1:External_ReturnToSenderCode>
<d2p1:External_Review>true</d2p1:External_Review>
<d2p1:InactiveReason>sample string 17</d2p1:InactiveReason>
<d2p1:IsPreloaded>true</d2p1:IsPreloaded>
<d2p1:IssueDate>2026-01-15T08:44:15.1900822+00:00</d2p1:IssueDate>
<d2p1:IssuingEntity>sample string 8</d2p1:IssuingEntity>
<d2p1:LUPBalance>1</d2p1:LUPBalance>
<d2p1:NextActionDate>2026-01-15T08:44:15.1900822+00:00</d2p1:NextActionDate>
<d2p1:OriginalDueDate>2026-01-15T08:44:15.1900822+00:00</d2p1:OriginalDueDate>
<d2p1:Original_DOB>sample string 11</d2p1:Original_DOB>
<d2p1:Original_DriverLicence>sample string 12</d2p1:Original_DriverLicence>
<d2p1:Original_DriverLicenceState>sample string 13</d2p1:Original_DriverLicenceState>
<d2p1:Original_EnforcementWarningDate>2026-01-15T08:44:15.1900822+00:00</d2p1:Original_EnforcementWarningDate>
<d2p1:Original_Name>sample string 10</d2p1:Original_Name>
<d2p1:Original_ReminderNoticeDate>2026-01-15T08:44:15.1900822+00:00</d2p1:Original_ReminderNoticeDate>
<d2p1:Postcode>sample string 22</d2p1:Postcode>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:PrincipalStatus>sample string 7</d2p1:PrincipalStatus>
<d2p1:PrincipalType>sample string 5</d2p1:PrincipalType>
<d2p1:PrincipalTypeCategory>sample string 6</d2p1:PrincipalTypeCategory>
<d2p1:State>sample string 23</d2p1:State>
<d2p1:Suburb>sample string 21</d2p1:Suburb>
<d2p1:TransactionAmount>3</d2p1:TransactionAmount>
<d2p1:TransactionDate>2026-01-15T08:44:15.1900822+00:00</d2p1:TransactionDate>
<d2p1:TransactionDesc>sample string 2</d2p1:TransactionDesc>
</PrincipalSummary>
<ReissueHistoryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
<d2p1:PrincipalReissueHistoryModel>
<d2p1:Entity>sample string 2</d2p1:Entity>
<d2p1:External_RefNo>sample string 3</d2p1:External_RefNo>
<d2p1:Issuing_Entity>sample string 4</d2p1:Issuing_Entity>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:TransactionDesc>sample string 1</d2p1:TransactionDesc>
</d2p1:PrincipalReissueHistoryModel>
<d2p1:PrincipalReissueHistoryModel>
<d2p1:Entity>sample string 2</d2p1:Entity>
<d2p1:External_RefNo>sample string 3</d2p1:External_RefNo>
<d2p1:Issuing_Entity>sample string 4</d2p1:Issuing_Entity>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:TransactionDesc>sample string 1</d2p1:TransactionDesc>
</d2p1:PrincipalReissueHistoryModel>
</ReissueHistoryList>
</PrincipalSummaryExtendedVM>