POST API/Budget/LoadBudgetIDList

Request Information

URI Parameters

None.

Body Parameters

LoadBudgetIDsRequest
NameDescriptionTypeAdditional information
CustomerID

integer

None.

Token

string

None.

ValidationMessage

string

None.

ErrorCode

ErrorCodes

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": 1,
  "Token": "sample string 2",
  "ValidationMessage": "sample string 3",
  "ErrorCode": 101
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BudgetIDList
NameDescriptionTypeAdditional information
CustomerID

integer

None.

BudgetIDs

Collection of BudgetID

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,
  "BudgetIDs": null,
  "AccountType": "sample string 2",
  "ActiveAccount": true,
  "ExpirationDate": "2025-12-09T21:19:02.7286013+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:
<BudgetIDList 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:19:02.7286013+00:00</ExpirationDate>
  <BudgetIDs i:nil="true" />
  <CustomerID>1</CustomerID>
</BudgetIDList>