Show / Hide Table of Contents

Class ShipmentMessageBlockEntity

This entity contains information about design blocks that can be used in a shipment/mailing message

Carrier object for ShipmentMessageBlockEntity. Services for the ShipmentMessageBlockEntity Carrier is available from the IMarketingAgent.
Inheritance
Object
ShipmentMessageBlockEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ShipmentMessageBlockEntity : Carrier
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }

Constructors

ShipmentMessageBlockEntity()

Default constructor

Declaration
public ShipmentMessageBlockEntity()
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

Properties

AssociateId

The associate that owns this block

Declaration
public virtual int AssociateId { get; set; }
Property Value
Type Description
Int32
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

Block

The block definition. Normally this will be a json structure

Declaration
public virtual string Block { get; set; }
Property Value
Type Description
String
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

Registered

Registered when in UTC.

Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

RegisteredAssociateId

Registered by whom

Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
Int32
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

ShipmentMessageBlockId

Primary key

Declaration
public virtual int ShipmentMessageBlockId { get; set; }
Property Value
Type Description
Int32
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

Updated

Last updated when in UTC.

Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

UpdatedAssociateId

Last updated by whom

Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
Int32
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

UpdatedCount

Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)

Returns
Type Description
String

The carrier contents.

Examples

Get ShipmentMessageBlockEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new MarketingAgent();
    var shipmentMessageBlockEntity = agent.GetShipmentMessageBlockEntity( 123 );
 }
See Also
MarketingAgent
IMarketingAgent

See Also

MarketingAgent
IMarketingAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top