POST API/Budget/LoadProjectList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerID	integer	None.
IncludeClosedProjects	boolean	None.
Token	string	None.
ValidationMessage	string	None.
ErrorCode	ErrorCodes	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerID": 1,
  "IncludeClosedProjects": true,
  "Token": "sample string 3",
  "ValidationMessage": "sample string 4",
  "ErrorCode": 101
}

application/xml, text/xml

Sample:

<LoadProjectListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models">
  <Token>sample string 3</Token>
  <CustomerID>1</CustomerID>
  <IncludeClosedProjects>true</IncludeClosedProjects>
</LoadProjectListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProjectList

Name	Type	Additional information
CustomerID	integer	None.
Projects	Collection of ProjectQuickSummary	None.
AccountType	string	None.
ActiveAccount	boolean	None.
ExpirationDate	date	None.
CustomerMessage	CustomerMessage	None.
Success	boolean	None.
ErrorCode	ErrorCodes	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerID": 1,
  "Projects": null,
  "AccountType": "sample string 2",
  "ActiveAccount": true,
  "ExpirationDate": "2025-12-09T21:21:59.9896144+00:00",
  "CustomerMessage": {
    "Cheer": {
      "Message": "sample string 1"
    },
    "Advertisement": {
      "ID": 1,
      "ImageURL": "sample string 2",
      "DestinationURL": "sample string 3",
      "BackgroundColor": "sample string 4",
      "Sequence": 5,
      "IsNotification": true,
      "DisplayID": 7
    }
  },
  "Success": true,
  "ErrorCode": 101,
  "Message": "sample string 5"
}

application/xml, text/xml

Sample:

<ProjectList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Budget_WebAPI.Models">
  <ErrorCode>InvalidToken</ErrorCode>
  <Message>sample string 5</Message>
  <Success>true</Success>
  <AccountType>sample string 2</AccountType>
  <ActiveAccount>true</ActiveAccount>
  <CustomerMessage>
    <Advertisement>
      <BackgroundColor>sample string 4</BackgroundColor>
      <DestinationURL>sample string 3</DestinationURL>
      <DisplayID>7</DisplayID>
      <ID>1</ID>
      <ImageURL>sample string 2</ImageURL>
      <IsNotification>true</IsNotification>
      <Sequence>5</Sequence>
    </Advertisement>
    <Cheer>
      <Message>sample string 1</Message>
    </Cheer>
  </CustomerMessage>
  <ExpirationDate>2025-12-09T21:21:59.9896144+00:00</ExpirationDate>
  <CustomerID>1</CustomerID>
  <Projects i:nil="true" />
</ProjectList>