POST api/JobNote

Creates a Note on a Job

Request Information

URI Parameters

None.

Body Parameters

JobNote
NameDescriptionTypeAdditional information
NoteId

Sedona internal autonumber for the OE_Job_Notes record (assigned automatically on POST)

integer

None.

JobCode

Value from OE_Job

string

Required

Note

The note text, limited to 1024 characters

string

Required

String length: inclusive between 0 and 1024

AccessLevel

Allowed values: 1 = viewed by all including customers, 2 = viewed by office users, 3 = highest level of security; defaults to 2 if not supplied

integer

None.

NoteType

value from SS_Note_Type; defaults to N/A if not supplied

string

None.

UserCode

The user making this change; defaults to UserCode value from config file if not set explicitly

string

String length: inclusive between 0 and 30

EnteredDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "JobCode": "sample string 2",
  "Note": "sample string 3",
  "AccessLevel": 1,
  "NoteType": "sample string 4",
  "UserCode": "sample string 5",
  "EnteredDate": "2018-09-24T07:11:10.6153072-04:00"
}

application/xml, text/xml

Sample:
<JobNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AccessLevel>1</AccessLevel>
  <EnteredDate>2018-09-24T07:11:10.6153072-04:00</EnteredDate>
  <JobCode>sample string 2</JobCode>
  <Note>sample string 3</Note>
  <NoteId>1</NoteId>
  <NoteType>sample string 4</NoteType>
  <UserCode>sample string 5</UserCode>
</JobNote>

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

Response Information

Resource Description

JobNote
NameDescriptionTypeAdditional information
NoteId

Sedona internal autonumber for the OE_Job_Notes record (assigned automatically on POST)

integer

None.

JobCode

Value from OE_Job

string

Required

Note

The note text, limited to 1024 characters

string

Required

String length: inclusive between 0 and 1024

AccessLevel

Allowed values: 1 = viewed by all including customers, 2 = viewed by office users, 3 = highest level of security; defaults to 2 if not supplied

integer

None.

NoteType

value from SS_Note_Type; defaults to N/A if not supplied

string

None.

UserCode

The user making this change; defaults to UserCode value from config file if not set explicitly

string

String length: inclusive between 0 and 30

EnteredDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "NoteId": 1,
  "JobCode": "sample string 2",
  "Note": "sample string 3",
  "AccessLevel": 1,
  "NoteType": "sample string 4",
  "UserCode": "sample string 5",
  "EnteredDate": "2018-09-24T07:11:10.6153072-04:00"
}

application/xml, text/xml

Sample:
<JobNote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AccessLevel>1</AccessLevel>
  <EnteredDate>2018-09-24T07:11:10.6153072-04:00</EnteredDate>
  <JobCode>sample string 2</JobCode>
  <Note>sample string 3</Note>
  <NoteId>1</NoteId>
  <NoteType>sample string 4</NoteType>
  <UserCode>sample string 5</UserCode>
</JobNote>