POST api/collectionsbuildingstages/orderpreview

GET: api/collectionsbuildingstages

Request Information

URI Parameters

None.

Body Parameters

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

Request Formats

application/json, text/json

Sample:

{
  "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:23:38.2047099-04:00",
  "endDate": "2024-10-14T08:23:38.2047099-04:00",
  "isActive": true,
  "isDeleted": true,
  "createdBy": 14,
  "createdOn": "2024-10-14T08:23:38.2047099-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T08:23:38.2047099-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ],
  "lastRunDate": "2024-10-14T08:23:38.2047099-04:00",
  "isChargePostingOnRunDate": true
}

application/xml, text/xml

Sample:

<CollectionsBuildingStageViewModel 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:23:38.2047099-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:23:38.2047099-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:23:38.2047099-04:00</LastRunDate>
  <LegalUnitNumber>true</LegalUnitNumber>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-14T08:23:38.2047099-04:00</ModifiedOn>
  <Name>sample string 3</Name>
  <Number>4</Number>
  <StageDay>5</StageDay>
  <StartDate>2024-10-14T08:23:38.2047099-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>
</CollectionsBuildingStageViewModel>

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

Response Information

Resource Description

List of CollectionsStageViewModel

Collection of CollectionsBuildingStageReturnViewModel

Name	Description	Type	Additional information
ActionStageLinks		Collection of CollectionsBuildingActionStageLinkReturnViewModel	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": [
      {
        "actionStageLinkId": 1,
        "buildingStageId": 2,
        "globalActionStageLinkId": 1,
        "actionCategoryId": 3,
        "actionId": 4,
        "actionName": "sample string 5",
        "displayOrder": 6,
        "isActive": true,
        "isParcelIdReq": true,
        "legalUnitNumber": true,
        "stageActionAttributeLinks": [
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          },
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          }
        ],
        "subAccountId": 1
      },
      {
        "actionStageLinkId": 1,
        "buildingStageId": 2,
        "globalActionStageLinkId": 1,
        "actionCategoryId": 3,
        "actionId": 4,
        "actionName": "sample string 5",
        "displayOrder": 6,
        "isActive": true,
        "isParcelIdReq": true,
        "legalUnitNumber": true,
        "stageActionAttributeLinks": [
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          },
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          }
        ],
        "subAccountId": 1
      }
    ],
    "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:23:38.2202641-04:00",
    "endDate": "2024-10-14T08:23:38.2202641-04:00",
    "isActive": true,
    "isDeleted": true,
    "createdBy": 14,
    "createdOn": "2024-10-14T08:23:38.2202641-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:23:38.2202641-04:00",
    "isParcelIdReq": true,
    "legalUnitNumber": true,
    "creditHistoryIds": [
      1,
      2
    ],
    "subAccountIds": [
      1,
      2
    ],
    "lastRunDate": "2024-10-14T08:23:38.2202641-04:00",
    "isChargePostingOnRunDate": true
  },
  {
    "actionStageLinks": [
      {
        "actionStageLinkId": 1,
        "buildingStageId": 2,
        "globalActionStageLinkId": 1,
        "actionCategoryId": 3,
        "actionId": 4,
        "actionName": "sample string 5",
        "displayOrder": 6,
        "isActive": true,
        "isParcelIdReq": true,
        "legalUnitNumber": true,
        "stageActionAttributeLinks": [
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          },
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          }
        ],
        "subAccountId": 1
      },
      {
        "actionStageLinkId": 1,
        "buildingStageId": 2,
        "globalActionStageLinkId": 1,
        "actionCategoryId": 3,
        "actionId": 4,
        "actionName": "sample string 5",
        "displayOrder": 6,
        "isActive": true,
        "isParcelIdReq": true,
        "legalUnitNumber": true,
        "stageActionAttributeLinks": [
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          },
          {
            "stageActionAttributeLinkId": 1,
            "globalStageActionAttributeLinkId": 1,
            "actionAttributeId": 2,
            "name": "sample string 3",
            "value": "sample string 4",
            "valueToDisplay": "sample string 5"
          }
        ],
        "subAccountId": 1
      }
    ],
    "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:23:38.2202641-04:00",
    "endDate": "2024-10-14T08:23:38.2202641-04:00",
    "isActive": true,
    "isDeleted": true,
    "createdBy": 14,
    "createdOn": "2024-10-14T08:23:38.2202641-04:00",
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:23:38.2202641-04:00",
    "isParcelIdReq": true,
    "legalUnitNumber": true,
    "creditHistoryIds": [
      1,
      2
    ],
    "subAccountIds": [
      1,
      2
    ],
    "lastRunDate": "2024-10-14T08:23:38.2202641-04:00",
    "isChargePostingOnRunDate": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfCollectionsBuildingStageReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CollectionsBuildingStageReturnViewModel>
    <BuildingPolicyProfileID>2</BuildingPolicyProfileID>
    <CalendarDay>6</CalendarDay>
    <ChargesDateThrough>8</ChargesDateThrough>
    <CreatedBy>14</CreatedBy>
    <CreatedOn>2024-10-14T08:23:38.2202641-04:00</CreatedOn>
    <CreditHistoryIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CreditHistoryIds>
    <EndDate>2024-10-14T08:23:38.2202641-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:23:38.2202641-04:00</LastRunDate>
    <LegalUnitNumber>true</LegalUnitNumber>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:23:38.2202641-04:00</ModifiedOn>
    <Name>sample string 3</Name>
    <Number>4</Number>
    <StageDay>5</StageDay>
    <StartDate>2024-10-14T08:23:38.2202641-04:00</StartDate>
    <SubAccountIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SubAccountIds>
    <ActionStageLinks>
      <CollectionsBuildingActionStageLinkReturnViewModel>
        <ActionCategoryId>3</ActionCategoryId>
        <ActionId>4</ActionId>
        <ActionName>sample string 5</ActionName>
        <ActionStageLinkId>1</ActionStageLinkId>
        <BuildingStageId>2</BuildingStageId>
        <DisplayOrder>6</DisplayOrder>
        <GlobalActionStageLinkId>1</GlobalActionStageLinkId>
        <IsActive>true</IsActive>
        <IsParcelIdReq>true</IsParcelIdReq>
        <LegalUnitNumber>true</LegalUnitNumber>
        <StageActionAttributeLinks>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
        </StageActionAttributeLinks>
        <SubAccountId>1</SubAccountId>
      </CollectionsBuildingActionStageLinkReturnViewModel>
      <CollectionsBuildingActionStageLinkReturnViewModel>
        <ActionCategoryId>3</ActionCategoryId>
        <ActionId>4</ActionId>
        <ActionName>sample string 5</ActionName>
        <ActionStageLinkId>1</ActionStageLinkId>
        <BuildingStageId>2</BuildingStageId>
        <DisplayOrder>6</DisplayOrder>
        <GlobalActionStageLinkId>1</GlobalActionStageLinkId>
        <IsActive>true</IsActive>
        <IsParcelIdReq>true</IsParcelIdReq>
        <LegalUnitNumber>true</LegalUnitNumber>
        <StageActionAttributeLinks>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
        </StageActionAttributeLinks>
        <SubAccountId>1</SubAccountId>
      </CollectionsBuildingActionStageLinkReturnViewModel>
    </ActionStageLinks>
  </CollectionsBuildingStageReturnViewModel>
  <CollectionsBuildingStageReturnViewModel>
    <BuildingPolicyProfileID>2</BuildingPolicyProfileID>
    <CalendarDay>6</CalendarDay>
    <ChargesDateThrough>8</ChargesDateThrough>
    <CreatedBy>14</CreatedBy>
    <CreatedOn>2024-10-14T08:23:38.2202641-04:00</CreatedOn>
    <CreditHistoryIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CreditHistoryIds>
    <EndDate>2024-10-14T08:23:38.2202641-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:23:38.2202641-04:00</LastRunDate>
    <LegalUnitNumber>true</LegalUnitNumber>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:23:38.2202641-04:00</ModifiedOn>
    <Name>sample string 3</Name>
    <Number>4</Number>
    <StageDay>5</StageDay>
    <StartDate>2024-10-14T08:23:38.2202641-04:00</StartDate>
    <SubAccountIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </SubAccountIds>
    <ActionStageLinks>
      <CollectionsBuildingActionStageLinkReturnViewModel>
        <ActionCategoryId>3</ActionCategoryId>
        <ActionId>4</ActionId>
        <ActionName>sample string 5</ActionName>
        <ActionStageLinkId>1</ActionStageLinkId>
        <BuildingStageId>2</BuildingStageId>
        <DisplayOrder>6</DisplayOrder>
        <GlobalActionStageLinkId>1</GlobalActionStageLinkId>
        <IsActive>true</IsActive>
        <IsParcelIdReq>true</IsParcelIdReq>
        <LegalUnitNumber>true</LegalUnitNumber>
        <StageActionAttributeLinks>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
        </StageActionAttributeLinks>
        <SubAccountId>1</SubAccountId>
      </CollectionsBuildingActionStageLinkReturnViewModel>
      <CollectionsBuildingActionStageLinkReturnViewModel>
        <ActionCategoryId>3</ActionCategoryId>
        <ActionId>4</ActionId>
        <ActionName>sample string 5</ActionName>
        <ActionStageLinkId>1</ActionStageLinkId>
        <BuildingStageId>2</BuildingStageId>
        <DisplayOrder>6</DisplayOrder>
        <GlobalActionStageLinkId>1</GlobalActionStageLinkId>
        <IsActive>true</IsActive>
        <IsParcelIdReq>true</IsParcelIdReq>
        <LegalUnitNumber>true</LegalUnitNumber>
        <StageActionAttributeLinks>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
          <CollectionsBuildingStageActionAttributeLinkReturnViewModel>
            <ActionAttributeId>2</ActionAttributeId>
            <GlobalStageActionAttributeLinkId>1</GlobalStageActionAttributeLinkId>
            <Name>sample string 3</Name>
            <StageActionAttributeLinkId>1</StageActionAttributeLinkId>
            <Value>sample string 4</Value>
            <ValueToDisplay>sample string 5</ValueToDisplay>
          </CollectionsBuildingStageActionAttributeLinkReturnViewModel>
        </StageActionAttributeLinks>
        <SubAccountId>1</SubAccountId>
      </CollectionsBuildingActionStageLinkReturnViewModel>
    </ActionStageLinks>
  </CollectionsBuildingStageReturnViewModel>
</ArrayOfCollectionsBuildingStageReturnViewModel>