Class Document
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for Document.
Inheritance
object ←
Carrier ←
Document
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get Document 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new DocumentAgent(configuration);
var document = agent.GetDocument( 123 );
Constructors
Document()
Default constructor - defaults any enum props to 0.
Properties
AssociateFullName
The associate’s culture formatted fullname (firstname, middleName and lastname)
Property Value
string
AssociateId
ID of associate whose diary the appointment is in, REQUIRED
Property Value
int
Attention
Attention/salutation
Property Value
string
Contact ID of owning contact, may be 0
Property Value
int
Contact name
Property Value
string
Description
The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases
Property Value
string
DocumentId
Primary key
Property Value
int
DocumentTemplate
Property Value
string
Visible document name
Property Value
string
IsPublished
True if document have an entry in published table
Property Value
bool
Name
File name
Property Value
string
OurRef
Our reference, searchable field from freetext search
Property Value
string
PersonFullName
The full name of the person this document belongs to.
Property Value
string
PersonId
Person ID of person the appointment is with, may be 0
Property Value
int
ProjectId
ID of project referred to, may be 0
Property Value
int
ProjectName
Project name
Property Value
string
SaleId
Owning sale, if any (may be 0)
Property Value
int
SaleName
Heading of Owning sale, if any. (may be blank)
Property Value
string
Snum
The sequence number allocated from refcount on used template when creating the document
Property Value
int
YourRef
Your reference
Property Value
string
See Also
DocumentAgent
