POST api/mobile/upr/PersonNoteModify

Saves a new or modifies an existing Person Note and returns all the notes for a person for a specific season and time zone offset

Request Information

URI Parameters

None.

Body Parameters

NoteRequest
NameDescriptionTypeAdditional information
NoteID

If this is a modify, include the NoteID

 integer

None.
PersonID

The Person associated with the note

 integer

None.
UserPersonID

The Author associated with this note (the logged in user)

 integer

None.
SeasonID

The optional seasonID associated with this note

 integer

None.
CategoryID

The categoryID should not be null --- if it is null, it should be set to 1 to represent "General"

 integer

None.
HouseholdID

The optional household associated with the note, if the note is not person specific

 integer

None.
NoteText

The text of the note

 string

None.
IsPrivate

Determines if the note is private

 boolean

None.
TimeZoneOffset

The modify call will return person notes using the time zone offset for the display date/time

 decimal number

None.
SeasonIDPersonNotesGet

The modify call will return person notes using the seasonID of SeasonIDPersonNotesGet

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "NoteID": 1,
  "PersonID": 1,
  "UserPersonID": 2,
  "SeasonID": 1,
  "CategoryID": 1,
  "HouseholdID": 1,
  "NoteText": "sample string 3",
  "IsPrivate": true,
  "TimeZoneOffset": 5.1,
  "SeasonIDPersonNotesGet": 6
}

application/javascript

Sample: 
{"NoteID":1,"PersonID":1,"UserPersonID":2,"SeasonID":1,"CategoryID":1,"HouseholdID":1,"NoteText":"sample string 3","IsPrivate":true,"TimeZoneOffset":5.1,"SeasonIDPersonNotesGet":6}

application/xml, text/xml

Sample: 
<NoteRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <NoteID>1</NoteID>
  <PersonID>1</PersonID>
  <UserPersonID>2</UserPersonID>
  <SeasonID>1</SeasonID>
  <CategoryID>1</CategoryID>
  <HouseholdID>1</HouseholdID>
  <NoteText>sample string 3</NoteText>
  <IsPrivate>true</IsPrivate>
  <TimeZoneOffset>5.1</TimeZoneOffset>
  <SeasonIDPersonNotesGet>6</SeasonIDPersonNotesGet>
</NoteRequest>

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

Response Information

Resource Description

WebMethodResultOfListOfNote
NameDescriptionTypeAdditional information
Result

Collection of Note

None.
Success

boolean

None.
ErrorText

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": [
    {
      "ID": 1,
      "PersonID": 2,
      "UserPersonID": 1,
      "UserName": "sample string 3",
      "SeasonID": 1,
      "CategoryID": 1,
      "HouseholdID": 1,
      "NoteText": "sample string 4",
      "FileName": "sample string 5",
      "OriginalFileName": "sample string 6",
      "IsPrivate": true,
      "NoteDateAsString": "2025-05-05T04:30:10.9847221-06:00",
      "FileNameToDelete": "sample string 10",
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2",
        "NickName": "sample string 3",
        "MaidenName": "sample string 4",
        "MiddleName": "sample string 5",
        "TitleID": 0,
        "SuffixID": 0,
        "FullName": "sample string 2 sample string 1",
        "FullNameWithNickName": "sample string 2 (sample string 3) sample string 1",
        "FullNameUPR": "sample string 10",
        "FullNameUPRShort": "sample string 11",
        "FullNameUPRShortNoMaiden": "sample string 12"
      },
      "AvatarURL": "sample string 11",
      "ProfilePhotoURL": "sample string 12",
      "ProfilePhotoMaxURL": "sample string 13",
      "UserGenderID": 0,
      "UserGender": 0,
      "IsSessionUser": true,
      "LocalDisplayDateAsString": "2025-05-05T04:30:10.9847221-06:00"
    },
    {
      "ID": 1,
      "PersonID": 2,
      "UserPersonID": 1,
      "UserName": "sample string 3",
      "SeasonID": 1,
      "CategoryID": 1,
      "HouseholdID": 1,
      "NoteText": "sample string 4",
      "FileName": "sample string 5",
      "OriginalFileName": "sample string 6",
      "IsPrivate": true,
      "NoteDateAsString": "2025-05-05T04:30:10.9847221-06:00",
      "FileNameToDelete": "sample string 10",
      "Name": {
        "LastName": "sample string 1",
        "FirstName": "sample string 2",
        "NickName": "sample string 3",
        "MaidenName": "sample string 4",
        "MiddleName": "sample string 5",
        "TitleID": 0,
        "SuffixID": 0,
        "FullName": "sample string 2 sample string 1",
        "FullNameWithNickName": "sample string 2 (sample string 3) sample string 1",
        "FullNameUPR": "sample string 10",
        "FullNameUPRShort": "sample string 11",
        "FullNameUPRShortNoMaiden": "sample string 12"
      },
      "AvatarURL": "sample string 11",
      "ProfilePhotoURL": "sample string 12",
      "ProfilePhotoMaxURL": "sample string 13",
      "UserGenderID": 0,
      "UserGender": 0,
      "IsSessionUser": true,
      "LocalDisplayDateAsString": "2025-05-05T04:30:10.9847221-06:00"
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample: 
{"Result":[{"ID":1,"PersonID":2,"UserPersonID":1,"UserName":"sample string 3","SeasonID":1,"CategoryID":1,"HouseholdID":1,"NoteText":"sample string 4","FileName":"sample string 5","OriginalFileName":"sample string 6","IsPrivate":true,"NoteDateAsString":"2025-05-05T04:30:10.9847221-06:00","FileNameToDelete":"sample string 10","Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","TitleID":0,"SuffixID":0,"FullName":"sample string 2 sample string 1","FullNameWithNickName":"sample string 2 (sample string 3) sample string 1","FullNameUPR":"sample string 10","FullNameUPRShort":"sample string 11","FullNameUPRShortNoMaiden":"sample string 12"},"AvatarURL":"sample string 11","ProfilePhotoURL":"sample string 12","ProfilePhotoMaxURL":"sample string 13","UserGenderID":0,"UserGender":0,"IsSessionUser":true,"LocalDisplayDateAsString":"2025-05-05T04:30:10.9847221-06:00"},{"ID":1,"PersonID":2,"UserPersonID":1,"UserName":"sample string 3","SeasonID":1,"CategoryID":1,"HouseholdID":1,"NoteText":"sample string 4","FileName":"sample string 5","OriginalFileName":"sample string 6","IsPrivate":true,"NoteDateAsString":"2025-05-05T04:30:10.9847221-06:00","FileNameToDelete":"sample string 10","Name":{"LastName":"sample string 1","FirstName":"sample string 2","NickName":"sample string 3","MaidenName":"sample string 4","MiddleName":"sample string 5","TitleID":0,"SuffixID":0,"FullName":"sample string 2 sample string 1","FullNameWithNickName":"sample string 2 (sample string 3) sample string 1","FullNameUPR":"sample string 10","FullNameUPRShort":"sample string 11","FullNameUPRShortNoMaiden":"sample string 12"},"AvatarURL":"sample string 11","ProfilePhotoURL":"sample string 12","ProfilePhotoMaxURL":"sample string 13","UserGenderID":0,"UserGender":0,"IsSessionUser":true,"LocalDisplayDateAsString":"2025-05-05T04:30:10.9847221-06:00"}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample: 
<WebMethodResultOfListOfNote xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <Note>
      <ID>1</ID>
      <PersonID>2</PersonID>
      <UserPersonID>1</UserPersonID>
      <UserName>sample string 3</UserName>
      <SeasonID>1</SeasonID>
      <CategoryID>1</CategoryID>
      <HouseholdID>1</HouseholdID>
      <NoteText>sample string 4</NoteText>
      <FileName>sample string 5</FileName>
      <OriginalFileName>sample string 6</OriginalFileName>
      <IsPrivate>true</IsPrivate>
      <NoteDateAsString>2025-05-05T04:30:10.9847221-06:00</NoteDateAsString>
      <NoteDate>2025-05-05T04:30:10.9847221-06:00</NoteDate>
      <FileNameToDelete>sample string 10</FileNameToDelete>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
        <NickName>sample string 3</NickName>
        <MaidenName>sample string 4</MaidenName>
        <MiddleName>sample string 5</MiddleName>
        <TitleID>0</TitleID>
        <Title>Undefined</Title>
        <SuffixID>0</SuffixID>
        <Suffix>Undefined</Suffix>
        <FullName>sample string 2 sample string 1</FullName>
        <FullNameWithNickName>sample string 2 (sample string 3) sample string 1</FullNameWithNickName>
        <FullNameUPR>sample string 10</FullNameUPR>
        <FullNameUPRShort>sample string 11</FullNameUPRShort>
        <FullNameUPRShortNoMaiden>sample string 12</FullNameUPRShortNoMaiden>
      </Name>
      <AvatarURL>sample string 11</AvatarURL>
      <ProfilePhotoURL>sample string 12</ProfilePhotoURL>
      <ProfilePhotoMaxURL>sample string 13</ProfilePhotoMaxURL>
      <UserGenderID>0</UserGenderID>
      <UserGender>Female</UserGender>
      <IsSessionUser>true</IsSessionUser>
      <LocalDisplayDate>2025-05-05T04:30:10.9847221-06:00</LocalDisplayDate>
      <LocalDisplayDateAsString>2025-05-05T04:30:10.9847221-06:00</LocalDisplayDateAsString>
    </Note>
    <Note>
      <ID>1</ID>
      <PersonID>2</PersonID>
      <UserPersonID>1</UserPersonID>
      <UserName>sample string 3</UserName>
      <SeasonID>1</SeasonID>
      <CategoryID>1</CategoryID>
      <HouseholdID>1</HouseholdID>
      <NoteText>sample string 4</NoteText>
      <FileName>sample string 5</FileName>
      <OriginalFileName>sample string 6</OriginalFileName>
      <IsPrivate>true</IsPrivate>
      <NoteDateAsString>2025-05-05T04:30:10.9847221-06:00</NoteDateAsString>
      <NoteDate>2025-05-05T04:30:10.9847221-06:00</NoteDate>
      <FileNameToDelete>sample string 10</FileNameToDelete>
      <Name>
        <LastName>sample string 1</LastName>
        <FirstName>sample string 2</FirstName>
        <NickName>sample string 3</NickName>
        <MaidenName>sample string 4</MaidenName>
        <MiddleName>sample string 5</MiddleName>
        <TitleID>0</TitleID>
        <Title>Undefined</Title>
        <SuffixID>0</SuffixID>
        <Suffix>Undefined</Suffix>
        <FullName>sample string 2 sample string 1</FullName>
        <FullNameWithNickName>sample string 2 (sample string 3) sample string 1</FullNameWithNickName>
        <FullNameUPR>sample string 10</FullNameUPR>
        <FullNameUPRShort>sample string 11</FullNameUPRShort>
        <FullNameUPRShortNoMaiden>sample string 12</FullNameUPRShortNoMaiden>
      </Name>
      <AvatarURL>sample string 11</AvatarURL>
      <ProfilePhotoURL>sample string 12</ProfilePhotoURL>
      <ProfilePhotoMaxURL>sample string 13</ProfilePhotoMaxURL>
      <UserGenderID>0</UserGenderID>
      <UserGender>Female</UserGender>
      <IsSessionUser>true</IsSessionUser>
      <LocalDisplayDate>2025-05-05T04:30:10.9847221-06:00</LocalDisplayDate>
      <LocalDisplayDateAsString>2025-05-05T04:30:10.9847221-06:00</LocalDisplayDateAsString>
    </Note>
  </Result>
</WebMethodResultOfListOfNote>