POST api/principalStatus/ChangePrincipalStatus
Request Information
URI Parameters
None.
Body Parameters
PrincipalStatusChangeVMName | Description | Type | Additional information |
---|---|---|---|
WorkflowLineID | integer |
None. |
|
WorkflowLine | string |
None. |
|
PrincipalList | Collection of PrincipalSelectableVM |
None. |
|
PrincipalStatusList | Collection of PrincipalStatusForList |
None. |
|
MasterWorkflowList | Collection of MasterWorkflowByMasterWorkFlowIDs |
None. |
|
DueDate | date |
None. |
|
SelectedPrincipalStatus | integer |
None. |
|
CreateWorkFlowGroup | boolean |
None. |
|
Selectedmasterworkflow | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "WorkflowLineID": 1, "WorkflowLine": "sample string 1", "PrincipalList": [ { "PrincipalID": 1, "PrincipalType": "sample string 2", "PrincipalStatus": "sample string 3", "Balance": 4.0, "TransactionDesc": "sample string 5", "TransactionDate": "2025-09-02T23:06:53.7162942+00:00", "Shortdescription": "sample string 7", "Issuing_Entity": "sample string 8", "Principal": "sample string 9", "Amount": 10.0, "StatusID": 11, "Included": true, "InitiallyIncluded": true, "CanBeSelected": true, "CanAggregate": true, "PrincipalStatusID": 1, "PrincipalTypeCategoryID": 1 }, { "PrincipalID": 1, "PrincipalType": "sample string 2", "PrincipalStatus": "sample string 3", "Balance": 4.0, "TransactionDesc": "sample string 5", "TransactionDate": "2025-09-02T23:06:53.7162942+00:00", "Shortdescription": "sample string 7", "Issuing_Entity": "sample string 8", "Principal": "sample string 9", "Amount": 10.0, "StatusID": 11, "Included": true, "InitiallyIncluded": true, "CanBeSelected": true, "CanAggregate": true, "PrincipalStatusID": 1, "PrincipalTypeCategoryID": 1 } ], "PrincipalStatusList": [ { "PrincipalStatusID": 1, "PrincipalStatus": "sample string 2" }, { "PrincipalStatusID": 1, "PrincipalStatus": "sample string 2" } ], "MasterWorkflowList": [ { "MasterWorkflowID": 1, "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:06:53.7162942+00:00", "StatusID": 1, "Z_DB": 1, "Z_ID": 1, "MasterWorkflow": "sample string 2", "Description": "sample string 3" }, { "MasterWorkflowID": 1, "CreateID": 1, "CreateSessionID": 1, "CreateTS": "2025-09-02T23:06:53.7162942+00:00", "StatusID": 1, "Z_DB": 1, "Z_ID": 1, "MasterWorkflow": "sample string 2", "Description": "sample string 3" } ], "DueDate": "2025-09-02T23:06:53.7162942+00:00", "SelectedPrincipalStatus": 1, "CreateWorkFlowGroup": true, "Selectedmasterworkflow": 1 }
application/xml, text/xml
Sample:
<PrincipalStatusChangeVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.PrincipalStatus"> <CreateWorkFlowGroup>true</CreateWorkFlowGroup> <DueDate>2025-09-02T23:06:53.7162942+00:00</DueDate> <MasterWorkflowList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.MasterWorkflow"> <d2p1:MasterWorkflowByMasterWorkFlowIDs> <d2p1:CreateID>1</d2p1:CreateID> <d2p1:CreateSessionID>1</d2p1:CreateSessionID> <d2p1:CreateTS>2025-09-02T23:06:53.7162942+00:00</d2p1:CreateTS> <d2p1:Description>sample string 3</d2p1:Description> <d2p1:MasterWorkflow>sample string 2</d2p1:MasterWorkflow> <d2p1:MasterWorkflowID>1</d2p1:MasterWorkflowID> <d2p1:StatusID>1</d2p1:StatusID> <d2p1:Z_DB>1</d2p1:Z_DB> <d2p1:Z_ID>1</d2p1:Z_ID> </d2p1:MasterWorkflowByMasterWorkFlowIDs> <d2p1:MasterWorkflowByMasterWorkFlowIDs> <d2p1:CreateID>1</d2p1:CreateID> <d2p1:CreateSessionID>1</d2p1:CreateSessionID> <d2p1:CreateTS>2025-09-02T23:06:53.7162942+00:00</d2p1:CreateTS> <d2p1:Description>sample string 3</d2p1:Description> <d2p1:MasterWorkflow>sample string 2</d2p1:MasterWorkflow> <d2p1:MasterWorkflowID>1</d2p1:MasterWorkflowID> <d2p1:StatusID>1</d2p1:StatusID> <d2p1:Z_DB>1</d2p1:Z_DB> <d2p1:Z_ID>1</d2p1:Z_ID> </d2p1:MasterWorkflowByMasterWorkFlowIDs> </MasterWorkflowList> <PrincipalList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal"> <d2p1:PrincipalSelectableVM> <d2p1:Amount>10</d2p1:Amount> <d2p1:Balance>4</d2p1:Balance> <d2p1:CanAggregate>true</d2p1:CanAggregate> <d2p1:CanBeSelected>true</d2p1:CanBeSelected> <d2p1:Included>true</d2p1:Included> <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded> <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity> <d2p1:Principal>sample string 9</d2p1:Principal> <d2p1:PrincipalID>1</d2p1:PrincipalID> <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus> <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID> <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType> <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID> <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription> <d2p1:StatusID>11</d2p1:StatusID> <d2p1:TransactionDate>2025-09-02T23:06:53.7162942+00:00</d2p1:TransactionDate> <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc> </d2p1:PrincipalSelectableVM> <d2p1:PrincipalSelectableVM> <d2p1:Amount>10</d2p1:Amount> <d2p1:Balance>4</d2p1:Balance> <d2p1:CanAggregate>true</d2p1:CanAggregate> <d2p1:CanBeSelected>true</d2p1:CanBeSelected> <d2p1:Included>true</d2p1:Included> <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded> <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity> <d2p1:Principal>sample string 9</d2p1:Principal> <d2p1:PrincipalID>1</d2p1:PrincipalID> <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus> <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID> <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType> <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID> <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription> <d2p1:StatusID>11</d2p1:StatusID> <d2p1:TransactionDate>2025-09-02T23:06:53.7162942+00:00</d2p1:TransactionDate> <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc> </d2p1:PrincipalSelectableVM> </PrincipalList> <PrincipalStatusList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PrincipalStatus"> <d2p1:PrincipalStatusForList> <d2p1:PrincipalStatus>sample string 2</d2p1:PrincipalStatus> <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID> </d2p1:PrincipalStatusForList> <d2p1:PrincipalStatusForList> <d2p1:PrincipalStatus>sample string 2</d2p1:PrincipalStatus> <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID> </d2p1:PrincipalStatusForList> </PrincipalStatusList> <SelectedPrincipalStatus>1</SelectedPrincipalStatus> <Selectedmasterworkflow>1</Selectedmasterworkflow> <WorkflowLine>sample string 1</WorkflowLine> <WorkflowLineID>1</WorkflowLineID> </PrincipalStatusChangeVM>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActionResultVMName | Description | Type | Additional information |
---|---|---|---|
Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
{ "Response": null }
application/xml, text/xml
Sample:
<ActionResultVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels"> <Response i:nil="true" /> </ActionResultVM>