Class DocumentEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for DocumentEntity.

public class DocumentEntity : Carrier

Inheritance

object ← Carrier ← DocumentEntity

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 DocumentEntity 123 using the WebApi client: <pre><code class=“lang-csharp”>var configuration = new WebApiConfiguration(url); var agent = new DocumentAgent(configuration); var documentEntity = agent.GetDocumentEntity( 123 );</code></pre>

Remarks

Use <xref href=“SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent” data-throw-if-not-resolved=“false”></xref>: All DocumentEntity: <pre><code class=“lang-csharp”>“FindDocument”</code></pre> Links: <pre><code class=“lang-csharp”>“Links”</code></pre> with restriction <pre><code class=“lang-csharp”>“sourceDocumentRestrictionId eq ” + id</code></pre>.

Constructors

DocumentEntity()

Default constructor - defaults any enum props to 0.

public DocumentEntity()

Properties

ActiveLinks

Number of active links to sale, document, appointment.

public virtual int ActiveLinks { get; set; }

Property Value

int

Associate

The owner of the document - the associate whose checklist the document is in. <p>Use MDO List name “associate” to get list items.</p>

public virtual Associate Associate { get; set; }

Property Value

Associate

Attention

Attention/salutation

public virtual string Attention { get; set; }

Property Value

string

Completed

Document Completed state. This is the part of the Status property. NULL if unknown enum value.

[JsonIgnore]
public ActivityStatus? Completed { get; set; }

Property Value

ActivityStatus?

Completed_String

Document Completed state. This is the part of the Status property. Raw string enum value.

[JsonProperty("Completed")]
public string Completed_String { get; set; }

Property Value

string

Contact

The contact associated with the document. It may also be null if no contact is associated with the document. <p>Use MDO List name “contact” to get list items.</p>

public virtual Contact Contact { get; set; }

Property Value

Contact

CreatedBy

The person that first created the document. The property is read-only.

public virtual Associate CreatedBy { get; set; }

Property Value

Associate

CreatedDate

Registered when

public virtual DateTime CreatedDate { get; set; }

Property Value

DateTime

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual <xref href=“SuperOffice.WebApi.Data.DocumentEntity.ExtraFields” data-throw-if-not-resolved=“false”></xref> and <xref href=“SuperOffice.WebApi.Data.DocumentEntity.UserDefinedFields?text=UserDefinedFields” data-throw-if-not-resolved=“false”></xref> properties are deprecated in favor of this combined collection. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary CustomFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Extra field data</td><td class=“description”> [Extra field name]<p></p> Example: <pre><code class=“lang-csharp”>‘x_gorp’ = ‘[I:123]’</code></pre> </td></tr><tr><td class=“term”>User defined field data</td><td class=“description”> [Prog-id name]<p></p> Example: <pre><code class=“lang-csharp”>‘SuperOffice:1’ = ‘[I:123]’</code></pre><p></p> </td></tr></tbody></table>

Date

date + start time planned

public virtual DateTime Date { get; set; }

Property Value

DateTime

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

public virtual string Description { get; set; }

Property Value

string

DocumentId

Primary key

public virtual int DocumentId { get; set; }

Property Value

int

DocumentTemplate

The template type of the document. <p>Use MDO List name “doctmpl” to get list items.</p>

public virtual DocumentTemplate DocumentTemplate { get; set; }

Property Value

DocumentTemplate

ExternalRef

External reference for document plugin to resolve document identity (Notes ID, e-mail message ID, whatever)

public virtual string ExternalRef { get; set; }

Property Value

string

ExtraFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.DocumentEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc. The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary ExtraFields { get; set; }

Property Value

StringDictionary

Remarks

The naming convention of the key string is as follows: <table><tbody><tr><td class=“term”>Plug-in data</td><td class=“description”> [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType </td></tr><tr><td class=“term”>Foreign key data</td><td class=“description”> The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry </td></tr><tr><td class=“term”>User defined table data</td><td class=“description”> [Table name].[Field name] Example: Phunneling.AggregatedSales </td></tr><tr><td class=“term”>Other</td><td class=“description”> Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys). </td></tr></tbody></table>

Header

Visible document name

public virtual string Header { get; set; }

Property Value

string

IsPublished

Publication is published

public virtual bool IsPublished { get; set; }

Property Value

bool

Links

List of all elements linked to the document.

public virtual Link[] Links { get; set; }

Property Value

Link[]

LockSemantics

NULL if unknown enum value.

[JsonIgnore]
public DocumentLockSemantics? LockSemantics { get; set; }

Property Value

DocumentLockSemantics?

LockSemantics_String

Raw string enum value.

[JsonProperty("LockSemantics")]
public string LockSemantics_String { get; set; }

Property Value

string

Name

File name

public virtual string Name { get; set; }

Property Value

string

OurRef

Our reference, searchable field from freetext search

public virtual string OurRef { get; set; }

Property Value

string

Person

A document may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required. <p>Use MDO List name “person” to get list items.</p>

public virtual Person Person { get; set; }

Property Value

Person

Project

A document may also be connected to a project, so you see the document both on the company card, and on the project card. This does not mean however that a project is required. <p>Use MDO List name “project” to get list items.</p>

public virtual Project Project { get; set; }

Property Value

Project

PublishEventDate

Publish event date

public virtual DateTime PublishEventDate { get; set; }

Property Value

DateTime

PublishFrom

Publication valid from (inclusive)

public virtual DateTime PublishFrom { get; set; }

Property Value

DateTime

PublishTo

Publication valid to (inclusive)

public virtual DateTime PublishTo { get; set; }

Property Value

DateTime

Sale

A document may also be connected to a sale, so you see the document on the company card, on the project card and on the sale card. This does not mean however that a sale is required. May be null. <p>Use MDO List name “sale” to get list items.</p>

public virtual Sale Sale { get; set; }

Property Value

Sale

Snum

The sequence number allocated from refcount on used template when creating the document

public virtual int Snum { get; set; }

Property Value

int

SuggestedDocumentId

Suggested guide item that this document is an instance of (Note: NOT valid for appointments, they have their own link)

public virtual int SuggestedDocumentId { get; set; }

Property Value

int

Type

Is this a normal document or a mail-merge or report? NULL if unknown enum value.

[JsonIgnore]
public AppointmentType? Type { get; set; }

Property Value

AppointmentType?

Type_String

Is this a normal document or a mail-merge or report? Raw string enum value.

[JsonProperty("Type")]
public string Type_String { get; set; }

Property Value

string

UpdatedBy

The person that last updated the appointment.

public virtual Associate UpdatedBy { get; set; }

Property Value

Associate

UpdatedDate

Last updated when

public virtual DateTime UpdatedDate { get; set; }

Property Value

DateTime

UserDefinedFields

Deprecated: Use <xref href=“SuperOffice.WebApi.Data.DocumentEntity.CustomFields” data-throw-if-not-resolved=“false”></xref> instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format “SuperOffice:[UdefFieldIdentity]”, e.g. “SuperOffice:1234” The value string is the encoded value: “[I:123]” or “[DT:2019-09-11]”.

public virtual StringDictionary UserDefinedFields { get; set; }

Property Value

StringDictionary

VisibleFor

The set of users or groups the record is visible for

public virtual VisibleFor[] VisibleFor { get; set; }

Property Value

VisibleFor[]

YourRef

Your reference

public virtual string YourRef { get; set; }

Property Value

string

​Class DocumentEntity

​Inheritance

​Inherited Members

​Examples

​Remarks

​Constructors

​DocumentEntity()

​Properties

​ActiveLinks

​Property Value

​Associate

​Property Value

​Attention

​Property Value

​Completed

​Property Value

​See Also

​Completed_String

​Property Value

​See Also

​Contact

​Property Value

​CreatedBy

​Property Value

​CreatedDate

​Property Value

​CustomFields

​Property Value

​Remarks

​Date

​Property Value

​Description

​Property Value

​DocumentId

​Property Value

​DocumentTemplate

​Property Value

​ExternalRef

​Property Value

​ExtraFields

​Property Value

​Remarks

​Header

​Property Value

​IsPublished

​Property Value

​Links

​Property Value

​LockSemantics

​Property Value

​See Also

​LockSemantics_String

​Property Value

​See Also

​Name

​Property Value

​OurRef

​Property Value

​Person

​Property Value

​Project

​Property Value

​PublishEventDate

​Property Value

​PublishFrom

​Property Value

​PublishTo

​Property Value

​Sale

​Property Value

​Snum

​Property Value

​SuggestedDocumentId

​Property Value

​Type

​Property Value

​See Also

​Type_String

​Property Value

​See Also

Class DocumentEntity

Inheritance

Inherited Members

Examples

Remarks

Constructors

DocumentEntity()

Properties

ActiveLinks

Property Value

Associate

Property Value

Attention

Property Value

Completed

Property Value

See Also

Completed_String

Property Value

See Also

Contact

Property Value

CreatedBy

Property Value

CreatedDate

Property Value

CustomFields

Property Value

Remarks

Date

Property Value

Description

Property Value

DocumentId

Property Value

DocumentTemplate

Property Value

ExternalRef

Property Value

ExtraFields

Property Value

Remarks

Header

Property Value

IsPublished

Property Value

Links

Property Value

LockSemantics

Property Value

See Also

LockSemantics_String

Property Value

See Also

Name

Property Value

OurRef

Property Value

Person

Property Value

Project

Property Value

PublishEventDate

Property Value

PublishFrom

Property Value

PublishTo

Property Value

Sale

Property Value

Snum

Property Value

SuggestedDocumentId

Property Value

Type

Property Value

See Also

Type_String

Property Value

See Also