POST api/Note/CreateNote/{auth}/{EntityGUID}/{EntityType}

Used to create a new note attached to an entity

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

The authorization GUID for this user session

string

Required

EntityGUID

The entity identifier that you want to attach a note

string

Required

EntityType

The entity type that you want to attach a note for

string

Required

Body Parameters

(See example below for values)

CreateNoteParm
NameDescriptionTypeAdditional information
Note

string

None.

VisibleToCustomers

boolean

None.

IsBillingNote

boolean

None.

IsSystemGenerated

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Note": "sample string 1",
  "VisibleToCustomers": true,
  "IsBillingNote": true,
  "IsSystemGenerated": true
}

application/xml, text/xml

Sample:
<CreateNoteParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <IsBillingNote>true</IsBillingNote>
  <IsSystemGenerated>true</IsSystemGenerated>
  <Note>sample string 1</Note>
  <VisibleToCustomers>true</VisibleToCustomers>
</CreateNoteParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

(void)

None.