POST api/collectionsexecution/actionmanagerupdate
Execute the actions based on the action execution rules
Request Information
URI Parameters
None.
Body Parameters
UpdateActionRequestViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Items |
|
Collection of ResidentActionResponseViewModel |
None. |
| ExecutionMode |
|
MicroServiceModeEnum |
None. |
| ExecutionBatchId |
|
integer |
None. |
| RunFor |
|
date |
None. |
| ResidentIds |
Gets or sets resident ids to be processed. If this property is null then all eligible residents are processed. Optional property - USE ONLY FOR DEV TROUBLESHOOTING !!! |
Collection of integer |
None. |
| BuildingStageIds |
Gets or sets BuildingStage ids to be processed. If this property is null then all eligible stages are processed. |
Collection of integer |
None. |
| EmailReportRecepient |
Gets or sets a single email address to be used for engine overall report. Optional property - USE ONLY FOR DEV TROUBLESHOOTING !!! |
string |
None. |
Request Formats
application/json, text/json
{
"items": [
{
"residentId": 1,
"referenceId": "sample string 2",
"processStatusId": 2,
"messages": [
"sample string 1",
"sample string 2"
],
"httpCode": 100
},
{
"residentId": 1,
"referenceId": "sample string 2",
"processStatusId": 2,
"messages": [
"sample string 1",
"sample string 2"
],
"httpCode": 100
}
],
"executionMode": 1,
"executionBatchId": 1,
"runFor": "2025-10-29T06:33:37.930706-04:00",
"residentIds": [
1,
2
],
"buildingStageIds": [
1,
2
],
"emailReportRecepient": "sample string 3"
}
application/xml, text/xml
<UpdateActionRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Host.Shared.ViewModels.Collections.Execution">
<BuildingStageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</BuildingStageIds>
<EmailReportRecepient>sample string 3</EmailReportRecepient>
<ExecutionBatchId>1</ExecutionBatchId>
<ExecutionMode>PushAndCallback</ExecutionMode>
<ResidentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ResidentIds>
<RunFor>2025-10-29T06:33:37.930706-04:00</RunFor>
<Items>
<ResidentActionResponseViewModel>
<HttpCode>Continue</HttpCode>
<Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Messages>
<ProcessStatusId>Queued</ProcessStatusId>
<ReferenceId>sample string 2</ReferenceId>
<ResidentId>1</ResidentId>
</ResidentActionResponseViewModel>
<ResidentActionResponseViewModel>
<HttpCode>Continue</HttpCode>
<Messages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</Messages>
<ProcessStatusId>Queued</ProcessStatusId>
<ReferenceId>sample string 2</ReferenceId>
<ResidentId>1</ResidentId>
</ResidentActionResponseViewModel>
</Items>
</UpdateActionRequestViewModel>
application/x-www-form-urlencoded
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.