POST api/collectionsexecution/stagemanager

Execute the stage manager to execute all stages based on the building stage configuration

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
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

Sample:

{
  "executionMode": 1,
  "executionBatchId": 1,
  "runFor": "2025-04-03T18:05:38.5070952-04:00",
  "residentIds": [
    1,
    2
  ],
  "buildingStageIds": [
    1,
    2
  ],
  "emailReportRecepient": "sample string 3"
}

application/xml, text/xml

Sample:

<ActionRequestViewModel 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-04-03T18:05:38.5070952-04:00</RunFor>
</ActionRequestViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ActionRequestViewModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.