POST api/AccountNotes

Request Information

URI Parameters

None.

Body Parameters

AccountNote
NameDescriptionTypeAdditional information
NoteId

integer

None.

AccountNum

integer

None.

UtilityId

integer

None.

NoteTopic

string

Max length: 200

Note

string

None.

DueDate

date

None.

Completed

string

Max length: 1

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

CreatedByName

string

None.

CustomerName

string

None.

Replies

Collection of AccountNoteReply

None.

Request Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "AccountNum": 2,
  "UtilityId": 3,
  "NoteTopic": "sample string 4",
  "Note": "sample string 5",
  "DueDate": "2024-03-28T19:15:30.9342462+00:00",
  "Completed": "sample string 6",
  "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
  "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
  "CreatedBy": 1,
  "UpdatedBy": 1,
  "CreatedByName": "sample string 7",
  "CustomerName": "sample string 8",
  "Replies": [
    {
      "NoteReplyId": 1,
      "NoteId": 2,
      "Reply": "sample string 3",
      "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
      "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
      "CreatedBy": 1,
      "UpdatedBy": 1,
      "CreatedByName": "sample string 4",
      "CustomerName": "sample string 5"
    },
    {
      "NoteReplyId": 1,
      "NoteId": 2,
      "Reply": "sample string 3",
      "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
      "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
      "CreatedBy": 1,
      "UpdatedBy": 1,
      "CreatedByName": "sample string 4",
      "CustomerName": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<AccountNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <AccountNum>2</AccountNum>
  <Completed>sample string 6</Completed>
  <CreatedBy>1</CreatedBy>
  <CreatedByName>sample string 7</CreatedByName>
  <CustomerName>sample string 8</CustomerName>
  <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
  <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
  <DueDate>2024-03-28T19:15:30.9342462+00:00</DueDate>
  <Note>sample string 5</Note>
  <NoteId>1</NoteId>
  <NoteTopic>sample string 4</NoteTopic>
  <Replies>
    <AccountNoteReply>
      <CreatedBy>1</CreatedBy>
      <CreatedByName>sample string 4</CreatedByName>
      <CustomerName>sample string 5</CustomerName>
      <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
      <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
      <NoteId>2</NoteId>
      <NoteReplyId>1</NoteReplyId>
      <Reply>sample string 3</Reply>
      <UpdatedBy>1</UpdatedBy>
    </AccountNoteReply>
    <AccountNoteReply>
      <CreatedBy>1</CreatedBy>
      <CreatedByName>sample string 4</CreatedByName>
      <CustomerName>sample string 5</CustomerName>
      <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
      <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
      <NoteId>2</NoteId>
      <NoteReplyId>1</NoteReplyId>
      <Reply>sample string 3</Reply>
      <UpdatedBy>1</UpdatedBy>
    </AccountNoteReply>
  </Replies>
  <UpdatedBy>1</UpdatedBy>
  <UtilityId>3</UtilityId>
</AccountNote>

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

Response Information

Resource Description

AccountNote
NameDescriptionTypeAdditional information
NoteId

integer

None.

AccountNum

integer

None.

UtilityId

integer

None.

NoteTopic

string

Max length: 200

Note

string

None.

DueDate

date

None.

Completed

string

Max length: 1

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

CreatedByName

string

None.

CustomerName

string

None.

Replies

Collection of AccountNoteReply

None.

Response Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "AccountNum": 2,
  "UtilityId": 3,
  "NoteTopic": "sample string 4",
  "Note": "sample string 5",
  "DueDate": "2024-03-28T19:15:30.9342462+00:00",
  "Completed": "sample string 6",
  "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
  "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
  "CreatedBy": 1,
  "UpdatedBy": 1,
  "CreatedByName": "sample string 7",
  "CustomerName": "sample string 8",
  "Replies": [
    {
      "NoteReplyId": 1,
      "NoteId": 2,
      "Reply": "sample string 3",
      "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
      "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
      "CreatedBy": 1,
      "UpdatedBy": 1,
      "CreatedByName": "sample string 4",
      "CustomerName": "sample string 5"
    },
    {
      "NoteReplyId": 1,
      "NoteId": 2,
      "Reply": "sample string 3",
      "DateCreated": "2024-03-28T19:15:30.9342462+00:00",
      "DateUpdated": "2024-03-28T19:15:30.9342462+00:00",
      "CreatedBy": 1,
      "UpdatedBy": 1,
      "CreatedByName": "sample string 4",
      "CustomerName": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<AccountNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <AccountNum>2</AccountNum>
  <Completed>sample string 6</Completed>
  <CreatedBy>1</CreatedBy>
  <CreatedByName>sample string 7</CreatedByName>
  <CustomerName>sample string 8</CustomerName>
  <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
  <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
  <DueDate>2024-03-28T19:15:30.9342462+00:00</DueDate>
  <Note>sample string 5</Note>
  <NoteId>1</NoteId>
  <NoteTopic>sample string 4</NoteTopic>
  <Replies>
    <AccountNoteReply>
      <CreatedBy>1</CreatedBy>
      <CreatedByName>sample string 4</CreatedByName>
      <CustomerName>sample string 5</CustomerName>
      <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
      <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
      <NoteId>2</NoteId>
      <NoteReplyId>1</NoteReplyId>
      <Reply>sample string 3</Reply>
      <UpdatedBy>1</UpdatedBy>
    </AccountNoteReply>
    <AccountNoteReply>
      <CreatedBy>1</CreatedBy>
      <CreatedByName>sample string 4</CreatedByName>
      <CustomerName>sample string 5</CustomerName>
      <DateCreated>2024-03-28T19:15:30.9342462+00:00</DateCreated>
      <DateUpdated>2024-03-28T19:15:30.9342462+00:00</DateUpdated>
      <NoteId>2</NoteId>
      <NoteReplyId>1</NoteReplyId>
      <Reply>sample string 3</Reply>
      <UpdatedBy>1</UpdatedBy>
    </AccountNoteReply>
  </Replies>
  <UpdatedBy>1</UpdatedBy>
  <UtilityId>3</UtilityId>
</AccountNote>