POST api/collectionsbuildingstages

Insert a new CollectionsBuildingStage

Request Information

URI Parameters

None.

Body Parameters

CollectionsBuildingStageViewModel>ViewModel

Name	Description	Type	Additional information
PolicyProfileID	BuildingPolicyProfileID	integer	Required Range: inclusive between 1 and 2147483647
Name	Name	string	Required Max length: 100
StageDay	StageDay	integer	Required Range: inclusive between 1 and 2147483647
CalendarDay	CalendarDay	integer	Required Range: inclusive between 1 and 2147483647
GraceDay	GraceDAy	integer	Required Range: inclusive between 0 and 2147483647
ChargesDateThrough	ChargesDateThrough	integer	Required Range: inclusive between 0 and 2147483647
IsManual	IsManual	boolean	Required
IsInLegal	IsInLegal	boolean	None.
IncludeDevelopers	IncludeDevelopers	boolean	None.
HoldStartDate	StartDate	date	None.
HoldEndDate	EndDate	date	None.
IsParcelIdReq	IsParcelIdReq	boolean	None.
LegalUnitNumber	LegalUnitNumber	boolean	None.
IsActive	IsActive	boolean	None.
CreditHistoryIds	CreditHistoryIds	Collection of integer	None.
SubAccountIds	SubAccountId	Collection of integer	None.
LastRunDate		date	None.
IsChargePostingOnRunDate	Gets or sets IsChargePostingOnRunDate	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "policyProfileID": 1,
  "name": "sample string 2",
  "stageDay": 3,
  "calendarDay": 4,
  "graceDay": 1,
  "chargesDateThrough": 5,
  "isManual": true,
  "isInLegal": true,
  "includeDevelopers": true,
  "holdStartDate": "2024-10-14T08:18:47.6725201-04:00",
  "holdEndDate": "2024-10-14T08:18:47.6725201-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "isActive": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ],
  "lastRunDate": "2024-10-14T08:18:47.6725201-04:00",
  "isChargePostingOnRunDate": true
}

application/xml, text/xml

Sample:

<CollectionsBuildingStageCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CalendarDay>4</CalendarDay>
  <ChargesDateThrough>5</ChargesDateThrough>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditHistoryIds>
  <GraceDay>1</GraceDay>
  <HoldEndDate>2024-10-14T08:18:47.6725201-04:00</HoldEndDate>
  <HoldStartDate>2024-10-14T08:18:47.6725201-04:00</HoldStartDate>
  <IncludeDevelopers>true</IncludeDevelopers>
  <IsActive>true</IsActive>
  <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
  <IsInLegal>true</IsInLegal>
  <IsManual>true</IsManual>
  <IsParcelIdReq>true</IsParcelIdReq>
  <LastRunDate>2024-10-14T08:18:47.6725201-04:00</LastRunDate>
  <LegalUnitNumber>true</LegalUnitNumber>
  <Name>sample string 2</Name>
  <StageDay>3</StageDay>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
  <PolicyProfileID>1</PolicyProfileID>
</CollectionsBuildingStageCreateViewModel>

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 'CollectionsBuildingStageCreateViewModel'.

Response Information

Resource Description

CollectionsBuildingStageViewModel>ViewModel

CollectionsBuildingStageCreatedReturnViewModel

Name	Description	Type	Additional information
ActionStageLinks		Collection of CollectionsBuildingActionStageLinkCreatedReturnViewModel	None.
Id	BuildingStageID	integer	None.
BuildingPolicyProfileID	BuildingPolicyProfileID	integer	None.
GlobalStageID	Global StageID	integer	None.
Name	Name	string	None.
Number	Number	integer	None.
StageDay	StageDay	integer	None.
CalendarDay	CalendarDay	integer	None.
GraceDay	GraceDAy	integer	None.
ChargesDateThrough	ChargesDateThrough	integer	None.
IsManual	IsManual	boolean	None.
IsInLegal	IsInLegal	boolean	None.
IncludeDevelopers	IncludeDevelopers	boolean	None.
StartDate	StartDate	date	None.
EndDate	EndDate	date	None.
IsActive	IsActive	boolean	None.
IsDeleted	IsDeleted	boolean	None.
CreatedBy	CreatedBy	integer	None.
CreatedOn	CreatedOn	date	None.
ModifiedBy	ModifiedBy	integer	None.
ModifiedOn	ModifiedOn	date	None.
IsParcelIdReq	IsParcelIdReq	boolean	None.
LegalUnitNumber	LegalUnitNumber	boolean	None.
CreditHistoryIds	CreditHistoryIds	Collection of integer	None.
SubAccountIds	SubAccountId	Collection of integer	None.
LastRunDate	LastRunDate	date	None.
IsChargePostingOnRunDate	Gets or sets IsChargePostingOnRunDate	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "actionStageLinks": [
    {
      "stageActionAttributeLinks": [
        {
          "id": 1,
          "buildingActionStageLinkId": 2,
          "actionAttributeId": 3,
          "stageActionAttributeLinkId": 1,
          "value": "sample string 4",
          "createdBy": 5,
          "createdOn": "2024-10-14T08:18:47.6725201-04:00",
          "modifiedBy": 1,
          "modifiedOn": "2024-10-14T08:18:47.6725201-04:00"
        },
        {
          "id": 1,
          "buildingActionStageLinkId": 2,
          "actionAttributeId": 3,
          "stageActionAttributeLinkId": 1,
          "value": "sample string 4",
          "createdBy": 5,
          "createdOn": "2024-10-14T08:18:47.6725201-04:00",
          "modifiedBy": 1,
          "modifiedOn": "2024-10-14T08:18:47.6725201-04:00"
        }
      ],
      "id": 1,
      "buildingStageId": 2,
      "actionStageLinkId": 1,
      "actionId": 3,
      "displayOrder": 4,
      "isActive": true,
      "isDeleted": true,
      "createdBy": 7,
      "createdOn": "2024-10-14T08:18:47.6881376-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T08:18:47.6881376-04:00"
    },
    {
      "stageActionAttributeLinks": [
        {
          "id": 1,
          "buildingActionStageLinkId": 2,
          "actionAttributeId": 3,
          "stageActionAttributeLinkId": 1,
          "value": "sample string 4",
          "createdBy": 5,
          "createdOn": "2024-10-14T08:18:47.6725201-04:00",
          "modifiedBy": 1,
          "modifiedOn": "2024-10-14T08:18:47.6725201-04:00"
        },
        {
          "id": 1,
          "buildingActionStageLinkId": 2,
          "actionAttributeId": 3,
          "stageActionAttributeLinkId": 1,
          "value": "sample string 4",
          "createdBy": 5,
          "createdOn": "2024-10-14T08:18:47.6725201-04:00",
          "modifiedBy": 1,
          "modifiedOn": "2024-10-14T08:18:47.6725201-04:00"
        }
      ],
      "id": 1,
      "buildingStageId": 2,
      "actionStageLinkId": 1,
      "actionId": 3,
      "displayOrder": 4,
      "isActive": true,
      "isDeleted": true,
      "createdBy": 7,
      "createdOn": "2024-10-14T08:18:47.6881376-04:00",
      "modifiedBy": 1,
      "modifiedOn": "2024-10-14T08:18:47.6881376-04:00"
    }
  ],
  "id": 1,
  "buildingPolicyProfileID": 2,
  "globalStageID": 1,
  "name": "sample string 3",
  "number": 4,
  "stageDay": 5,
  "calendarDay": 6,
  "graceDay": 7,
  "chargesDateThrough": 8,
  "isManual": true,
  "isInLegal": true,
  "includeDevelopers": true,
  "startDate": "2024-10-14T08:18:47.6884584-04:00",
  "endDate": "2024-10-14T08:18:47.6884584-04:00",
  "isActive": true,
  "isDeleted": true,
  "createdBy": 14,
  "createdOn": "2024-10-14T08:18:47.6885553-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T08:18:47.6885553-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ],
  "lastRunDate": "2024-10-14T08:18:47.6885553-04:00",
  "isChargePostingOnRunDate": true
}

application/xml, text/xml

Sample:

<CollectionsBuildingStageCreatedReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BuildingPolicyProfileID>2</BuildingPolicyProfileID>
  <CalendarDay>6</CalendarDay>
  <ChargesDateThrough>8</ChargesDateThrough>
  <CreatedBy>14</CreatedBy>
  <CreatedOn>2024-10-14T08:18:47.6885553-04:00</CreatedOn>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditHistoryIds>
  <EndDate>2024-10-14T08:18:47.6884584-04:00</EndDate>
  <GlobalStageID>1</GlobalStageID>
  <GraceDay>7</GraceDay>
  <Id>1</Id>
  <IncludeDevelopers>true</IncludeDevelopers>
  <IsActive>true</IsActive>
  <IsChargePostingOnRunDate>true</IsChargePostingOnRunDate>
  <IsDeleted>true</IsDeleted>
  <IsInLegal>true</IsInLegal>
  <IsManual>true</IsManual>
  <IsParcelIdReq>true</IsParcelIdReq>
  <LastRunDate>2024-10-14T08:18:47.6885553-04:00</LastRunDate>
  <LegalUnitNumber>true</LegalUnitNumber>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:18:47.6885553-04:00</ModifiedOn>
  <Name>sample string 3</Name>
  <Number>4</Number>
  <StageDay>5</StageDay>
  <StartDate>2024-10-14T08:18:47.6884584-04:00</StartDate>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
  <ActionStageLinks>
    <CollectionsBuildingActionStageLinkCreatedReturnViewModel>
      <ActionId>3</ActionId>
      <ActionStageLinkId>1</ActionStageLinkId>
      <BuildingStageId>2</BuildingStageId>
      <CreatedBy>7</CreatedBy>
      <CreatedOn>2024-10-14T08:18:47.6881376-04:00</CreatedOn>
      <DisplayOrder>4</DisplayOrder>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T08:18:47.6881376-04:00</ModifiedOn>
      <StageActionAttributeLinks>
        <CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
          <ActionAttributeId>3</ActionAttributeId>
          <BuildingActionStageLinkId>2</BuildingActionStageLinkId>
          <CreatedBy>5</CreatedBy>
          <CreatedOn>2024-10-14T08:18:47.6725201-04:00</CreatedOn>
          <Id>1</Id>
          <ModifiedBy>1</ModifiedBy>
          <ModifiedOn>2024-10-14T08:18:47.6725201-04:00</ModifiedOn>
          <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
          <Value>sample string 4</Value>
        </CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
        <CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
          <ActionAttributeId>3</ActionAttributeId>
          <BuildingActionStageLinkId>2</BuildingActionStageLinkId>
          <CreatedBy>5</CreatedBy>
          <CreatedOn>2024-10-14T08:18:47.6725201-04:00</CreatedOn>
          <Id>1</Id>
          <ModifiedBy>1</ModifiedBy>
          <ModifiedOn>2024-10-14T08:18:47.6725201-04:00</ModifiedOn>
          <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
          <Value>sample string 4</Value>
        </CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
      </StageActionAttributeLinks>
    </CollectionsBuildingActionStageLinkCreatedReturnViewModel>
    <CollectionsBuildingActionStageLinkCreatedReturnViewModel>
      <ActionId>3</ActionId>
      <ActionStageLinkId>1</ActionStageLinkId>
      <BuildingStageId>2</BuildingStageId>
      <CreatedBy>7</CreatedBy>
      <CreatedOn>2024-10-14T08:18:47.6881376-04:00</CreatedOn>
      <DisplayOrder>4</DisplayOrder>
      <Id>1</Id>
      <IsActive>true</IsActive>
      <IsDeleted>true</IsDeleted>
      <ModifiedBy>1</ModifiedBy>
      <ModifiedOn>2024-10-14T08:18:47.6881376-04:00</ModifiedOn>
      <StageActionAttributeLinks>
        <CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
          <ActionAttributeId>3</ActionAttributeId>
          <BuildingActionStageLinkId>2</BuildingActionStageLinkId>
          <CreatedBy>5</CreatedBy>
          <CreatedOn>2024-10-14T08:18:47.6725201-04:00</CreatedOn>
          <Id>1</Id>
          <ModifiedBy>1</ModifiedBy>
          <ModifiedOn>2024-10-14T08:18:47.6725201-04:00</ModifiedOn>
          <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
          <Value>sample string 4</Value>
        </CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
        <CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
          <ActionAttributeId>3</ActionAttributeId>
          <BuildingActionStageLinkId>2</BuildingActionStageLinkId>
          <CreatedBy>5</CreatedBy>
          <CreatedOn>2024-10-14T08:18:47.6725201-04:00</CreatedOn>
          <Id>1</Id>
          <ModifiedBy>1</ModifiedBy>
          <ModifiedOn>2024-10-14T08:18:47.6725201-04:00</ModifiedOn>
          <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
          <Value>sample string 4</Value>
        </CollectionsBuildingStageActionAttributeLinkCreatedReturnViewModel>
      </StageActionAttributeLinks>
    </CollectionsBuildingActionStageLinkCreatedReturnViewModel>
  </ActionStageLinks>
</CollectionsBuildingStageCreatedReturnViewModel>