POST api/Notes

Internal Secure API to write Scouter Notes to FIRES database (pre 2019)

Request Information

URI Parameters

None.

Body Parameters

Collection of Note

Name	Type	Additional information
NoteID	integer	None.
NoteCode	string	Required String length: inclusive between 0 and 10
InstanceID	integer	None.
NotesValue	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "NoteID": 1,
    "NoteCode": "sample string 2",
    "InstanceID": 3,
    "NotesValue": "sample string 4"
  },
  {
    "NoteID": 1,
    "NoteCode": "sample string 2",
    "InstanceID": 3,
    "NotesValue": "sample string 4"
  }
]

application/xml, text/xml

Sample:

<ArrayOfNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FiresUniAPI.Models">
  <Note>
    <InstanceID>3</InstanceID>
    <NoteCode>sample string 2</NoteCode>
    <NoteID>1</NoteID>
    <NotesValue>sample string 4</NotesValue>
  </Note>
  <Note>
    <InstanceID>3</InstanceID>
    <NoteCode>sample string 2</NoteCode>
    <NoteID>1</NoteID>
    <NotesValue>sample string 4</NotesValue>
  </Note>
</ArrayOfNote>

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 'Note[]'.

Response Information

Resource Description

Note

Name	Type	Additional information
NoteID	integer	None.
NoteCode	string	Required String length: inclusive between 0 and 10
InstanceID	integer	None.
NotesValue	string	None.

Response Formats

application/json, text/json

Sample:

{
  "NoteID": 1,
  "NoteCode": "sample string 2",
  "InstanceID": 3,
  "NotesValue": "sample string 4"
}

application/xml, text/xml

Sample:

<Note xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FiresUniAPI.Models">
  <InstanceID>3</InstanceID>
  <NoteCode>sample string 2</NoteCode>
  <NoteID>1</NoteID>
  <NotesValue>sample string 4</NotesValue>
</Note>