Class ListAgent

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Inheritance

Object

AgentBase<IListAgent>

ListAgent

Implements

IDisposable

IListAgent

IAgent

Inherited Members

AgentBase<IListAgent>.Dispose()

AgentBase<IListAgent>.InnerAgent

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

public class ListAgent : AgentBase<IListAgent>, IDisposable, IListAgent, IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

Constructors

ListAgent()

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public ListAgent()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

Methods

AddFromListDefinition(Int32, ListItemEntity)

Save a new list item for the specified list defintion

Declaration

public ListItemEntity AddFromListDefinition(int udListDefinitionId, ListItemEntity item)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The name of the list definition, indicating which list to save the item to.
ListItemEntity	item	The item to save

Returns

Type	Description
ListItemEntity	The saved list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

AddFromListName(String, ListItemEntity)

Save a new list item for the specified list defintion

Declaration

public ListItemEntity AddFromListName(string udListDefinitionName, ListItemEntity item)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to save the item to.
ListItemEntity	item	The item to save

Returns

Type	Description
ListItemEntity	The saved list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

AddHierarchyToPath(Domain, String, String)

Add a hierarchy item to a path

Declaration

public HierarchyEntity AddHierarchyToPath(Domain domain, string path, string name)

Parameters

Type	Name	Description
Domain	domain	Type of items to get
String	path	Hierarchy path to parent item
String	name	Name of node to add

Returns

Type	Description
HierarchyEntity	The hierarchy node added to the path

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

ChangeCurrency(Double, String, String)

Recalculates the amount to the new currency.

Declaration

public double ChangeCurrency(double amount, string fromCurrency, string toCurrency)

Parameters

Type	Name	Description
Double	amount	The amount in the old currency
String	fromCurrency	The old currency name
String	toCurrency	The new currency name

Returns

Type	Description
Double	Amount in new currency

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultAmountClassEntity()

Loading default values into a new AmountClassEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public AmountClassEntity CreateDefaultAmountClassEntity()

Returns

Type	Description
AmountClassEntity	New AmountClassEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultCountry()

Gets a new country

Declaration

public Country CreateDefaultCountry()

Returns

Type	Description
Country	A new country with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultCurrencyEntity()

Loading default values into a new CurrencyEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public CurrencyEntity CreateDefaultCurrencyEntity()

Returns

Type	Description
CurrencyEntity	New CurrencyEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultDocumentTemplateEntity()

Loading default values into a new DocumentTemplateEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public DocumentTemplateEntity CreateDefaultDocumentTemplateEntity()

Returns

Type	Description
DocumentTemplateEntity	New DocumentTemplateEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultDocumentTemplateLanguage(Int32, String)

Create a new document template language based on an existing template

Declaration

public void CreateDefaultDocumentTemplateLanguage(int documentTemplateId, string languageCode)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the document template
String	languageCode	The language code ('en-US, 'nb-NO', etc)

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultExtAppEntity()

Loading default values into a new ExtAppEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public ExtAppEntity CreateDefaultExtAppEntity()

Returns

Type	Description
ExtAppEntity	New ExtAppEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultHeadingEntity()

Loading default values into a new HeadingEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public HeadingEntity CreateDefaultHeadingEntity()

Returns

Type	Description
HeadingEntity	New HeadingEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultHeadingFromListDefinition(Int32)

Get a heading for the specified list defintion

Declaration

public HeadingEntity CreateDefaultHeadingFromListDefinition(int udListDefinitionId)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list definition, indicating which list to get the item from

Returns

Type	Description
HeadingEntity	The loaded heading

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultHierarchyEntity()

Loading default values into a new HierarchyEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public HierarchyEntity CreateDefaultHierarchyEntity()

Returns

Type	Description
HierarchyEntity	New HierarchyEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultListEntity()

Loading default values into a new ListEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public ListEntity CreateDefaultListEntity()

Returns

Type	Description
ListEntity	New ListEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultListItemEntity()

Loading default values into a new ListItemEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public ListItemEntity CreateDefaultListItemEntity()

Returns

Type	Description
ListItemEntity	New ListItemEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultProjectTypeEntity()

Loading default values into a new ProjectTypeEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public ProjectTypeEntity CreateDefaultProjectTypeEntity()

Returns

Type	Description
ProjectTypeEntity	New ProjectTypeEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultRelationDefinitionEntity()

Loading default values into a new RelationDefinitionEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public RelationDefinitionEntity CreateDefaultRelationDefinitionEntity()

Returns

Type	Description
RelationDefinitionEntity	New RelationDefinitionEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultResourceEntity()

Loading default values into a new ResourceEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public ResourceEntity CreateDefaultResourceEntity()

Returns

Type	Description
ResourceEntity	New ResourceEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultSaleStageEntity()

Loading default values into a new SaleStageEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public SaleStageEntity CreateDefaultSaleStageEntity()

Returns

Type	Description
SaleStageEntity	New SaleStageEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultSaleTypeEntity()

Loading default values into a new SaleTypeEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public SaleTypeEntity CreateDefaultSaleTypeEntity()

Returns

Type	Description
SaleTypeEntity	New SaleTypeEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultTaskMenu()

Loading default values into a new TaskMenu. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public TaskMenu CreateDefaultTaskMenu()

Returns

Type	Description
TaskMenu	New TaskMenu with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultTicketCategoryEntity()

Loading default values into a new TicketCategoryEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public TicketCategoryEntity CreateDefaultTicketCategoryEntity()

Returns

Type	Description
TicketCategoryEntity	New TicketCategoryEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultTicketPriorityEntity()

Loading default values into a new TicketPriorityEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public TicketPriorityEntity CreateDefaultTicketPriorityEntity()

Returns

Type	Description
TicketPriorityEntity	New TicketPriorityEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultTicketStatusEntity()

Loading default values into a new TicketStatusEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public TicketStatusEntity CreateDefaultTicketStatusEntity()

Returns

Type	Description
TicketStatusEntity	New TicketStatusEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultTicketTypeEntity()

Loading default values into a new TicketTypeEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public TicketTypeEntity CreateDefaultTicketTypeEntity()

Returns

Type	Description
TicketTypeEntity	New TicketTypeEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultWebPanelEntity()

Loading default values into a new WebPanelEntity. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

public WebPanelEntity CreateDefaultWebPanelEntity()

Returns

Type	Description
WebPanelEntity	New WebPanelEntity with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAllFromListDefinition(Int32)

Marks all items in the list deleted

Declaration

public void DeleteAllFromListDefinition(int udListDefinitionId)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAllFromListName(String)

Marks all items in the list deleted

Declaration

public void DeleteAllFromListName(string udListDefinitionName)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to delete the items from.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAllHeadingsFromListDefinition(Int32)

Delete all headings for list resolved by the provided id.

Declaration

public void DeleteAllHeadingsFromListDefinition(int id)

Parameters

Type	Name	Description
Int32	id	The id of the list to look up.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAllHeadingsFromName(String)

Delete all headings for list resolved by the provided name.

Declaration

public void DeleteAllHeadingsFromName(string name)

Parameters

Type	Name	Description
String	name	The name of the list to look up.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAppTaskMenus()

Permanentely delete all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens

Declaration

public void DeleteAppTaskMenus()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteAppWebPanels()

Permanentely delete all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken; otherwise nothing happens

Declaration

public void DeleteAppWebPanels()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteDocumentTemplateLanguage(Int32, String)

Deletes language variant of the document template

Declaration

public void DeleteDocumentTemplateLanguage(int documentTemplateId, string languageCode)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the document template
String	languageCode	The language code ('en-US, 'nb-NO', etc)

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteFromListDefinition(Int32, Int32)

Delete a list item from the specified list defintion

Declaration

public void DeleteFromListDefinition(int id, int udListDefinitionId)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to delete
Int32	udListDefinitionId	The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteFromListName(Int32, String)

Delete a list item from the specified list defintion

Declaration

public void DeleteFromListName(int id, string udListDefinitionName)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to delete
String	udListDefinitionName	The name of the list definition, indicating which list to delete the items from.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteHierarchyEntity(Int32)

Deletes the HierarchyEntity

Declaration

public void DeleteHierarchyEntity(int hierarchyEntityId)

Parameters

Type	Name	Description
Int32	hierarchyEntityId	The identity of the HierarchyEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteHierarchyFromPath(Domain, String)

Remove a hierarchy item and its children from a path

Declaration

public void DeleteHierarchyFromPath(Domain domain, string path)

Parameters

Type	Name	Description
Domain	domain	Type of items to get
String	path	Hierarchy path to item to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteListEntity(Int32)

Deletes the ListEntity

Declaration

public void DeleteListEntity(int listEntityId)

Parameters

Type	Name	Description
Int32	listEntityId	The identity of the ListEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteListEntityByName(String)

Delete a ListEntity resolved by the provided name.

Declaration

public void DeleteListEntityByName(string name)

Parameters

Type	Name	Description
String	name	The name of the list to delete.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteProjectStatus(Int32)

Deletes a project status

Declaration

public void DeleteProjectStatus(int projectStatusId)

Parameters

Type	Name	Description
Int32	projectStatusId	The project status id to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteResourceEntity(Int32)

Deletes the ResourceEntity

Declaration

public void DeleteResourceEntity(int resourceEntityId)

Parameters

Type	Name	Description
Int32	resourceEntityId	The identity of the ResourceEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteTaskMenu(Int32)

Deletes the TaskMenu

Declaration

public void DeleteTaskMenu(int taskMenuId)

Parameters

Type	Name	Description
Int32	taskMenuId	The identity of the TaskMenu

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteTicketCategoryEntity(Int32)

Deletes the TicketCategoryEntity

Declaration

public void DeleteTicketCategoryEntity(int ticketCategoryEntityId)

Parameters

Type	Name	Description
Int32	ticketCategoryEntityId	The identity of the TicketCategoryEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteTicketPriorityEntity(Int32)

Deletes the TicketPriorityEntity

Declaration

public void DeleteTicketPriorityEntity(int ticketPriorityEntityId)

Parameters

Type	Name	Description
Int32	ticketPriorityEntityId	The identity of the TicketPriorityEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteTicketStatusEntity(Int32)

Deletes the TicketStatusEntity

Declaration

public void DeleteTicketStatusEntity(int ticketStatusEntityId)

Parameters

Type	Name	Description
Int32	ticketStatusEntityId	The identity of the TicketStatusEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteTicketTypeEntity(Int32)

Deletes the TicketTypeEntity

Declaration

public void DeleteTicketTypeEntity(int ticketTypeEntityId)

Parameters

Type	Name	Description
Int32	ticketTypeEntityId	The identity of the TicketTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

DeleteWebPanel(Int32)

Hard-delete (real, permanent DELETE in the database) the given web panel. Use with care!

Declaration

public void DeleteWebPanel(int id)

Parameters

Type	Name	Description
Int32	id	Database id of web panel to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GenerateNavigationUrl(Navigation, String)

This methods generates the navigation URL to be used to navigate to the panel

Declaration

public string GenerateNavigationUrl(Navigation visibleIn, string windowName)

Parameters

Type	Name	Description
Navigation	visibleIn	The visble in/navigation to generate for
String	windowName	The name of the web panel window

Returns

Type	Description
String	The navigation url

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllConsentSource()

Gets an array of all ConsentSource objects.

Declaration

public ConsentSource[] GetAllConsentSource()

Returns

Type	Description
ConsentSource[]	Array of all ConsentSource objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllCountries(Boolean)

Returns all available countries a contact or person could belong to.

Declaration

public Country[] GetAllCountries(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
Country[]	An array of all available countries

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllCurrencies(Boolean)

Returns all currencies

Declaration

public CurrencyEntity[] GetAllCurrencies(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
CurrencyEntity[]	Array of currencies

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllDocumentTemplates(Boolean)

Returns all templates

Declaration

public DocumentTemplateEntity[] GetAllDocumentTemplates(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
DocumentTemplateEntity[]	Array of all template items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllDomains()

Get list of all domains

Declaration

public Domain[] GetAllDomains()

Returns

Type	Description
Domain[]	Domain types (scripts, extra tables, etc)

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllFromListDefinition(Int32, Boolean)

Get all list items for the specified list defintion

Declaration

public ListItemEntity[] GetAllFromListDefinition(int udListDefinitionId, bool includeDeleted)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list definition, indicating which list to get the item from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
ListItemEntity[]	The list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllFromListName(String, Boolean)

Get all list items for the specified list defintion

Declaration

public ListItemEntity[] GetAllFromListName(string udListDefinitionName, bool includeDeleted)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to get the item from.
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
ListItemEntity[]	The list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllInDomain(Domain, Boolean)

Get all items in a domain

Declaration

public HierarchyEntity[] GetAllInDomain(Domain domain, bool children)

Parameters

Type	Name	Description
Domain	domain	Type of items to get (scripts, extra tables, etc)
Boolean	children	Include sub-items?

Returns

Type	Description
HierarchyEntity[]	All items and child items within a domain

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllLegalBase()

Gets an array of all LegalBase objects.

Declaration

public LegalBase[] GetAllLegalBase()

Returns

Type	Description
LegalBase[]	Array of all LegalBase objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllReasonSold()

Gets an array of all ReasonSold objects.

Declaration

public ReasonSold[] GetAllReasonSold()

Returns

Type	Description
ReasonSold[]	Array of all ReasonSold objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllReasonStalled()

Gets an array of all ReasonStalled objects.

Declaration

public ReasonStalled[] GetAllReasonStalled()

Returns

Type	Description
ReasonStalled[]	Array of all ReasonStalled objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllSaleStages(Boolean)

Returns all ratings

Declaration

public SaleStageEntity[] GetAllSaleStages(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
SaleStageEntity[]	Array of sale stage ratings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllSaleType()

Returns all sale types as simple list items

Declaration

public SaleType[] GetAllSaleType()

Returns

Type	Description
SaleType[]	Array of simple sale type list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllSaleTypeEntities(Boolean)

Returns all sale types as entities with stakeholders, guide and quote properties

Declaration

public SaleTypeEntity[] GetAllSaleTypeEntities(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
SaleTypeEntity[]	Array of sale type entities with stakeholders, guide and quote properties

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllSelectionCategory()

Gets an array of all SelectionCategory objects.

Declaration

public SelectionCategory[] GetAllSelectionCategory()

Returns

Type	Description
SelectionCategory[]	Array of all SelectionCategory objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllTasks(Boolean)

Returns all appointment tasks

Declaration

public TaskListItem[] GetAllTasks(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
TaskListItem[]	An array of all available tasks

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAllTicketPriorities(Boolean)

Returns all available ticket priorities.

Declaration

public TicketPriorityEntity[] GetAllTicketPriorities(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
TicketPriorityEntity[]	An array of all available ticket priorities

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAmountClassEntity(Int32)

Gets a AmountClassEntity object.

Declaration

public AmountClassEntity GetAmountClassEntity(int amountClassEntityId)

Parameters

Type	Name	Description
Int32	amountClassEntityId	The identifier of the AmountClassEntity object

Returns

Type	Description
AmountClassEntity	AmountClassEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAppTaskMenus()

Get all task menus owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

Declaration

public TaskMenu[] GetAppTaskMenus()

Returns

Type	Description
TaskMenu[]	List of all task menus owned by the current App

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetAppWebPanels()

Get all web panels owned by your app; works in Online only, for registered Apps that send a valid ApplicationToken

Declaration

public WebPanelEntity[] GetAppWebPanels()

Returns

Type	Description
WebPanelEntity[]	List of all web panels owned by the current App

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetBaseCurrency()

Get the base currency, used for calculating exchange rates

Declaration

public CurrencyEntity GetBaseCurrency()

Returns

Type	Description
CurrencyEntity	The base currency that other currencies are expressed in terms of

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetBusiness(Int32)

Gets a Business object.

Declaration

public Business GetBusiness(int businessId)

Parameters

Type	Name	Description
Int32	businessId	The identifier of the Business object

Returns

Type	Description
Business	Business

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetBusinesses()

Returns all available businesses that a contact could have.

Declaration

public Business[] GetBusinesses()

Returns

Type	Description
Business[]	An array of all available businesses

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetBusinessList(Int32[])

Gets an array of Business objects.

Declaration

public Business[] GetBusinessList(int[] businessIds)

Parameters

Type	Name	Description
Int32[]	businessIds	The identifiers of the Business object

Returns

Type	Description
Business[]	Array of Business objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCategories()

Returns all categories a contact could belong to

Declaration

public Category[] GetCategories()

Returns

Type	Description
Category[]	An array of all available categories

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCategory(Int32)

Gets a Category object.

Declaration

public Category GetCategory(int categoryId)

Parameters

Type	Name	Description
Int32	categoryId	The identifier of the Category object

Returns

Type	Description
Category	Category

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCategoryList(Int32[])

Gets an array of Category objects.

Declaration

public Category[] GetCategoryList(int[] categoryIds)

Parameters

Type	Name	Description
Int32[]	categoryIds	The identifiers of the Category object

Returns

Type	Description
Category[]	Array of Category objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCompetitor(Int32)

Gets a Competitor object.

Declaration

public Competitor GetCompetitor(int competitorId)

Parameters

Type	Name	Description
Int32	competitorId	The identifier of the Competitor object

Returns

Type	Description
Competitor	Competitor

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCompetitorList(Int32[])

Gets an array of Competitor objects.

Declaration

public Competitor[] GetCompetitorList(int[] competitorIds)

Parameters

Type	Name	Description
Int32[]	competitorIds	The identifiers of the Competitor object

Returns

Type	Description
Competitor[]	Array of Competitor objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCompetitors()

Returns all competitors

Declaration

public Competitor[] GetCompetitors()

Returns

Type	Description
Competitor[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentPurpose(Int32)

Gets a ConsentPurpose object.

Declaration

public ConsentPurpose GetConsentPurpose(int consentPurposeId)

Parameters

Type	Name	Description
Int32	consentPurposeId	The identifier of the ConsentPurpose object

Returns

Type	Description
ConsentPurpose	ConsentPurpose

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentPurposeList(Int32[])

Gets an array of ConsentPurpose objects.

Declaration

public ConsentPurpose[] GetConsentPurposeList(int[] consentPurposeIds)

Parameters

Type	Name	Description
Int32[]	consentPurposeIds	The identifiers of the ConsentPurpose object

Returns

Type	Description
ConsentPurpose[]	Array of ConsentPurpose objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentPurposes()

Returns all defined purposes.

Declaration

public ConsentPurpose[] GetConsentPurposes()

Returns

Type	Description
ConsentPurpose[]	An array of all defined purposes

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentSource(Int32)

Gets a ConsentSource object.

Declaration

public ConsentSource GetConsentSource(int consentSourceId)

Parameters

Type	Name	Description
Int32	consentSourceId	The identifier of the ConsentSource object

Returns

Type	Description
ConsentSource	ConsentSource

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentSourceList(Int32[])

Gets an array of ConsentSource objects.

Declaration

public ConsentSource[] GetConsentSourceList(int[] consentSourceIds)

Parameters

Type	Name	Description
Int32[]	consentSourceIds	The identifiers of the ConsentSource object

Returns

Type	Description
ConsentSource[]	Array of ConsentSource objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetConsentSources()

Returns all defined Sources.

Declaration

public ConsentSource[] GetConsentSources()

Returns

Type	Description
ConsentSource[]	An array of all defined Sources

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCountries()

Returns all available countries a contact or person could belong to.

Declaration

public Country[] GetCountries()

Returns

Type	Description
Country[]	An array of all available countries

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCountry(Int32)

Gets a Country object.

Declaration

public Country GetCountry(int countryId)

Parameters

Type	Name	Description
Int32	countryId	The identifier of the Country object

Returns

Type	Description
Country	Country

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCountryList(Int32[])

Gets an array of Country objects.

Declaration

public Country[] GetCountryList(int[] countryIds)

Parameters

Type	Name	Description
Int32[]	countryIds	The identifiers of the Country object

Returns

Type	Description
Country[]	Array of Country objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCredited(Int32)

Gets a Credited object.

Declaration

public Credited GetCredited(int creditedId)

Parameters

Type	Name	Description
Int32	creditedId	The identifier of the Credited object

Returns

Type	Description
Credited	Credited

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCreditedList(Int32[])

Gets an array of Credited objects.

Declaration

public Credited[] GetCreditedList(int[] creditedIds)

Parameters

Type	Name	Description
Int32[]	creditedIds	The identifiers of the Credited object

Returns

Type	Description
Credited[]	Array of Credited objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCrediteds()

Returns all credited

Declaration

public Credited[] GetCrediteds()

Returns

Type	Description
Credited[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCurrencies()

Returns all currencies

Declaration

public Currency[] GetCurrencies()

Returns

Type	Description
Currency[]	Array of currencies

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCurrency(Int32)

Gets a Currency object.

Declaration

public Currency GetCurrency(int currencyId)

Parameters

Type	Name	Description
Int32	currencyId	The identifier of the Currency object

Returns

Type	Description
Currency	Currency

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCurrencyEntity(Int32)

Gets a CurrencyEntity object.

Declaration

public CurrencyEntity GetCurrencyEntity(int currencyEntityId)

Parameters

Type	Name	Description
Int32	currencyEntityId	The identifier of the CurrencyEntity object

Returns

Type	Description
CurrencyEntity	CurrencyEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCurrencyList(Int32[])

Gets an array of Currency objects.

Declaration

public Currency[] GetCurrencyList(int[] currencyIds)

Parameters

Type	Name	Description
Int32[]	currencyIds	The identifiers of the Currency object

Returns

Type	Description
Currency[]	Array of Currency objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCustomerLanguage(Int32)

Gets a CustomerLanguage object.

Declaration

public CustomerLanguage GetCustomerLanguage(int customerLanguageId)

Parameters

Type	Name	Description
Int32	customerLanguageId	The identifier of the CustomerLanguage object

Returns

Type	Description
CustomerLanguage	CustomerLanguage

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCustomerLanguageList(Int32[])

Gets an array of CustomerLanguage objects.

Declaration

public CustomerLanguage[] GetCustomerLanguageList(int[] customerLanguageIds)

Parameters

Type	Name	Description
Int32[]	customerLanguageIds	The identifiers of the CustomerLanguage object

Returns

Type	Description
CustomerLanguage[]	Array of CustomerLanguage objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetCustomerLanguages()

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public CustomerLanguage[] GetCustomerLanguages()

Returns

Type	Description
CustomerLanguage[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDeliveryTerm(Int32)

Gets a DeliveryTerm object.

Declaration

public DeliveryTerm GetDeliveryTerm(int deliveryTermId)

Parameters

Type	Name	Description
Int32	deliveryTermId	The identifier of the DeliveryTerm object

Returns

Type	Description
DeliveryTerm	DeliveryTerm

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDeliveryTerms()

Returns all DeliveryTerms in SuperOffice db.

Declaration

public DeliveryTerm[] GetDeliveryTerms()

Returns

Type	Description
DeliveryTerm[]	An array of all available DeliveryTerms

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDeliveryType(Int32)

Gets a DeliveryType object.

Declaration

public DeliveryType GetDeliveryType(int deliveryTypeId)

Parameters

Type	Name	Description
Int32	deliveryTypeId	The identifier of the DeliveryType object

Returns

Type	Description
DeliveryType	DeliveryType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDeliveryTypes()

Returns all DeliveryTypes in SuperOffice db.

Declaration

public DeliveryType[] GetDeliveryTypes()

Returns

Type	Description
DeliveryType[]	An array of all available DeliveryType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDepartment(Int32)

Gets a Department object.

Declaration

public Department GetDepartment(int departmentId)

Parameters

Type	Name	Description
Int32	departmentId	The identifier of the Department object

Returns

Type	Description
Department	Department

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDepartmentList(Int32[])

Gets an array of Department objects.

Declaration

public Department[] GetDepartmentList(int[] departmentIds)

Parameters

Type	Name	Description
Int32[]	departmentIds	The identifiers of the Department object

Returns

Type	Description
Department[]	Array of Department objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDepartments()

Getting all departments/user groups for the internal phone list with the user's colleagues.

Declaration

public Department[] GetDepartments()

Returns

Type	Description
Department[]	Returns all departments.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplate(Int32)

Gets a DocumentTemplate object.

Declaration

public DocumentTemplate GetDocumentTemplate(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	The identifier of the DocumentTemplate object

Returns

Type	Description
DocumentTemplate	DocumentTemplate

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateEntity(Int32)

Gets a DocumentTemplateEntity object.

Declaration

public DocumentTemplateEntity GetDocumentTemplateEntity(int documentTemplateEntityId)

Parameters

Type	Name	Description
Int32	documentTemplateEntityId	The identifier of the DocumentTemplateEntity object

Returns

Type	Description
DocumentTemplateEntity	DocumentTemplateEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateExtension(Int32)

Get the file extension for the document template

Declaration

public string GetDocumentTemplateExtension(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	The primary key of the document template

Returns

Type	Description
String	File name extension including '.': '.doc' or '.xlsx'

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateLanguages(Int32)

Get the supported language variations for a document template

Declaration

public string[] GetDocumentTemplateLanguages(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the document template

Returns

Type	Description
String[]	Returns the list of languages as ISO cultures (en-US, no, sv, etc)

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateList(Int32[])

Gets an array of DocumentTemplate objects.

Declaration

public DocumentTemplate[] GetDocumentTemplateList(int[] documentTemplateIds)

Parameters

Type	Name	Description
Int32[]	documentTemplateIds	The identifiers of the DocumentTemplate object

Returns

Type	Description
DocumentTemplate[]	Array of DocumentTemplate objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateProperties(Int32, String[])

Get document template properties

Declaration

public StringDictionary GetDocumentTemplateProperties(int documentTemplateId, string[] requestedProperties)

Parameters

Type	Name	Description
Int32	documentTemplateId	The primary key id of the document template
String[]	requestedProperties	An array of properties to get the values for

Returns

Type	Description
StringDictionary	Dictionary of key=value pairs of requested properties

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplates()

Returns all available document templates

Declaration

public DocumentTemplate[] GetDocumentTemplates()

Returns

Type	Description
DocumentTemplate[]	Array of DocumentTemplates

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplatesTasks()

The appointment's task is a Document template item when the appointment is a document.

Declaration

public Task[] GetDocumentTemplatesTasks()

Returns

Type	Description
Task[]	Document Template list as a array of Tasks

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateStreamFromId(Int32, String)

Retrieve a stream to a document template based on its id

Declaration

public Stream GetDocumentTemplateStreamFromId(int documentTemplateId, string languageCode)

Parameters

Type	Name	Description
Int32	documentTemplateId	Id of template to retrieve
String	languageCode	Language variation of template to use. (ISO code: "en-US" or "nb-NO" etc). Used to select a template of the appropriate language. Can be overridden in SO ARC by user preference "PreferDocLang".

Returns

Type	Description
Stream	Open stream to the template content

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateTask(Int32)

Returns a Document Template list item as a TaskListItem. The appointment's task is a Document template item when the appointment is a document.

Declaration

public Task GetDocumentTemplateTask(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	Id of the document template, i.e. the Appointment.TaskIdx

Returns

Type	Description
Task	Document Template item as TaskListItem.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateUrl(Int32, Boolean, String)

Get a url to the document template

Declaration

public string GetDocumentTemplateUrl(int documentTemplateId, bool writableUrl, string languageCode)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the template
Boolean	writableUrl	Get a writeable url to the document template?
String	languageCode	The language code ('en-US', 'nb-NO', etc). Use empty string if not supported or used.

Returns

Type	Description
String	The URL to the document template

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateUsedInProjectStage(Int32)

Get a String array of names in project guide that this template is used in

Declaration

public string[] GetDocumentTemplateUsedInProjectStage(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the template

Returns

Type	Description
String[]	The name of the projectguides that use this template

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTemplateUsedInSalesStage(Int32)

Get a String array of names in sales guide that this template is used in

Declaration

public string[] GetDocumentTemplateUsedInSalesStage(int documentTemplateId)

Parameters

Type	Name	Description
Int32	documentTemplateId	The id of the template

Returns

Type	Description
String[]	The name of the salesguides that use this template

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetDocumentTypesForPlugin(Int32)

Get a list of document types supported by a given document plugin. Use the document template type when creating a new template.

Declaration

public IntStringDictionary GetDocumentTypesForPlugin(int pluginId)

Parameters

Type	Name	Description
Int32	pluginId	Numeric document plugin id, corresponding to the doctmpl.AutoeventId, doctmpl.LoadTemplateFromPlugin.

Returns

Type	Description
IntStringDictionary	Dictionary mapping document type id=name

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetEmarketingStrictMode()

Get the value of the Emarketing strict mode setting

Declaration

public bool GetEmarketingStrictMode()

Returns

Type	Description
Boolean	Returns true if Emarkerint strict mode is set, false otherwise

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetExtAppEntity(Int32)

Gets a ExtAppEntity object.

Declaration

public ExtAppEntity GetExtAppEntity(int extAppEntityId)

Parameters

Type	Name	Description
Int32	extAppEntityId	The identifier of the ExtAppEntity object

Returns

Type	Description
ExtAppEntity	ExtAppEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetFromListDefinition(Int32, Int32)

Get a list item for the specified list defintion

Declaration

public ListItemEntity GetFromListDefinition(int id, int udListDefinitionId)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to load
Int32	udListDefinitionId	The id of the list definition, indicating which list to get the item from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.

Returns

Type	Description
ListItemEntity	The loaded list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetFromListName(Int32, String)

Get a list item for the specified list defintion

Declaration

public ListItemEntity GetFromListName(int id, string udListDefinitionName)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to load
String	udListDefinitionName	The name of the list definition, indicating which list to get the item from.

Returns

Type	Description
ListItemEntity	The loaded list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHeadingEntity(Int32)

Gets a HeadingEntity object.

Declaration

public HeadingEntity GetHeadingEntity(int headingEntityId)

Parameters

Type	Name	Description
Int32	headingEntityId	The identifier of the HeadingEntity object

Returns

Type	Description
HeadingEntity	HeadingEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHeadings(Int32, Int32, Boolean)

Gets a selectable MDO list of the headings for this list item

Declaration

public SelectableMDOListItem[] GetHeadings(int udListDefinitionId, int listItemId, bool showDeleted)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The id of the list item
Boolean	showDeleted	Set to true if you want deleted headings

Returns

Type	Description
SelectableMDOListItem[]	Array of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHeadingsForListItemFromListName(String, Int32, Boolean)

Gets a selectable MDO list of the headings for this list item

Declaration

public SelectableMDOListItem[] GetHeadingsForListItemFromListName(string udListDefinitionName, int listItemId, bool showDeleted)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to delete the items from.
Int32	listItemId	The id of the list item
Boolean	showDeleted	Set to true if you want deleted headings

Returns

Type	Description
SelectableMDOListItem[]	Array of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHeadingsFromListDefinition(Int32)

Gets headings for list resolved by the provided id.

Declaration

public HeadingEntity[] GetHeadingsFromListDefinition(int id)

Parameters

Type	Name	Description
Int32	id	The id of the list to look up.

Returns

Type	Description
HeadingEntity[]	List of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHeadingsFromName(String)

Gets headings for list resolved by the provided name.

Declaration

public HeadingEntity[] GetHeadingsFromName(string name)

Parameters

Type	Name	Description
String	name	The name of the list to look up.

Returns

Type	Description
HeadingEntity[]	List of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHierarchyEntity(Int32)

Gets a HierarchyEntity object.

Declaration

public HierarchyEntity GetHierarchyEntity(int hierarchyEntityId)

Parameters

Type	Name	Description
Int32	hierarchyEntityId	The identifier of the HierarchyEntity object

Returns

Type	Description
HierarchyEntity	HierarchyEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetHierarchyFromPath(Domain, String, Boolean)

Get a hierarchy item from a path

Declaration

public HierarchyEntity GetHierarchyFromPath(Domain domain, string path, bool children)

Parameters

Type	Name	Description
Domain	domain	Type of items to get
String	path	Hierarchy path to item
Boolean	children	Include sub-items?

Returns

Type	Description
HierarchyEntity	The hierarchy node at the path

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetInstalledLanguages()

Returns the list of all languages installed in this database.

Declaration

public LanguageInfo[] GetInstalledLanguages()

Returns

Type	Description
LanguageInfo[]	Array of installed languages

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLanguageInfo(Int32)

Gets a LanguageInfo object.

Declaration

public LanguageInfo GetLanguageInfo(int languageInfoId)

Parameters

Type	Name	Description
Int32	languageInfoId	The identifier of the LanguageInfo object

Returns

Type	Description
LanguageInfo	LanguageInfo

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLanguageInfoList(Int32[])

Gets an array of LanguageInfo objects.

Declaration

public LanguageInfo[] GetLanguageInfoList(int[] languageInfoIds)

Parameters

Type	Name	Description
Int32[]	languageInfoIds	The identifiers of the LanguageInfo object

Returns

Type	Description
LanguageInfo[]	Array of LanguageInfo objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLegalBase(Int32)

Gets a LegalBase object.

Declaration

public LegalBase GetLegalBase(int legalBaseId)

Parameters

Type	Name	Description
Int32	legalBaseId	The identifier of the LegalBase object

Returns

Type	Description
LegalBase	LegalBase

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLegalBaseList(Int32[])

Gets an array of LegalBase objects.

Declaration

public LegalBase[] GetLegalBaseList(int[] legalBaseIds)

Parameters

Type	Name	Description
Int32[]	legalBaseIds	The identifiers of the LegalBase object

Returns

Type	Description
LegalBase[]	Array of LegalBase objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLegalBases()

Returns all defined bases.

Declaration

public LegalBase[] GetLegalBases()

Returns

Type	Description
LegalBase[]	An array of all defined bases

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLink(Int32)

Gets a Link object.

Declaration

public Link GetLink(int linkId)

Parameters

Type	Name	Description
Int32	linkId	The identifier of the Link object

Returns

Type	Description
Link	Link

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLinkList(Int32[])

Gets an array of Link objects.

Declaration

public Link[] GetLinkList(int[] linkIds)

Parameters

Type	Name	Description
Int32[]	linkIds	The identifiers of the Link object

Returns

Type	Description
Link[]	Array of Link objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListDefinitions(Boolean)

Get a list of the lists - built-in and user-defined.

Declaration

public ListEntity[] GetListDefinitions(bool includeDeleted)

Parameters

Type	Name	Description
Boolean	includeDeleted	Include deleted items in result?

Returns

Type	Description
ListEntity[]	The list definitions

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListEntity(Int32)

Gets a ListEntity object.

Declaration

public ListEntity GetListEntity(int listEntityId)

Parameters

Type	Name	Description
Int32	listEntityId	The identifier of the ListEntity object

Returns

Type	Description
ListEntity	ListEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListEntityByName(String)

Gets a ListEntity resolved by the provided name.

Declaration

public ListEntity GetListEntityByName(string name)

Parameters

Type	Name	Description
String	name	The name of the list to look up.

Returns

Type	Description
ListEntity	A ListEntity or null.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListItemsForHeading(Int32, Int32)

List of list items that is selected if under this heading

Declaration

public SelectableMDOListItem[] GetListItemsForHeading(int udListDefinitionId, int headingId)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	headingId	The id of the heading

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListItemsForHeadingFromListName(String, Int32)

List of list items that is selected if under this heading

Declaration

public SelectableMDOListItem[] GetListItemsForHeadingFromListName(string udListDefinitionName, int headingId)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition.
Int32	headingId	The id of the heading

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListItemsForUserGroup(Int32, Int32)

List of list items that is visible in the usergroup

Declaration

public SelectableMDOListItem[] GetListItemsForUserGroup(int udListDefinitionId, int groupId)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	groupId	The id of the usergroup

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetListItemsForUserGroupFromListName(String, Int32)

List of list items that is visible in the usergroup

Declaration

public SelectableMDOListItem[] GetListItemsForUserGroupFromListName(string udListDefinitionName, int groupId)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition.
Int32	groupId	The id of the usergroup

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedText(Int32)

Gets a LocalizedText object.

Declaration

public LocalizedText GetLocalizedText(int localizedTextId)

Parameters

Type	Name	Description
Int32	localizedTextId	The identifier of the LocalizedText object

Returns

Type	Description
LocalizedText	LocalizedText

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedTextByType(LocalizedTextType, Int32, Int32)

Returns a localized text based on the resource id for the selected language.

Declaration

public LocalizedText GetLocalizedTextByType(LocalizedTextType textType, int resourceId, int languageId)

Parameters

Type	Name	Description
LocalizedTextType	textType	Type of the localized text
Int32	resourceId	The resource id. This id has different meaning based on the LocalizedTextType.
Int32	languageId	The LCID number of the language.

Returns

Type	Description
LocalizedText	A LocalizedText carrier.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedTextList(Int32[])

Gets an array of LocalizedText objects.

Declaration

public LocalizedText[] GetLocalizedTextList(int[] localizedTextIds)

Parameters

Type	Name	Description
Int32[]	localizedTextIds	The identifiers of the LocalizedText object

Returns

Type	Description
LocalizedText[]	Array of LocalizedText objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedTexts()

Gets all localized texts in the CRM database.

Declaration

public LocalizedText[] GetLocalizedTexts()

Returns

Type	Description
LocalizedText[]	Array of LocalizedText objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedTextsByLanguageId(Int32)

Gets all localized text belonging to a specific language.

Declaration

public LocalizedText[] GetLocalizedTextsByLanguageId(int languageId)

Parameters

Type	Name	Description
Int32	languageId	The LCID number of the language.

Returns

Type	Description
LocalizedText[]	Array of LocalizedText objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetLocalizedTextsByType(LocalizedTextType[])

Gets localized text by their type

Declaration

public LocalizedText[] GetLocalizedTextsByType(LocalizedTextType[] textTypes)

Parameters

Type	Name	Description
LocalizedTextType[]	textTypes	Array of LocalizedTextTypes. If null all texts are returned.

Returns

Type	Description
LocalizedText[]	Array of LocalizedText objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetMrMrs(Int32)

Gets a MrMrs object.

Declaration

public MrMrs GetMrMrs(int mrMrsId)

Parameters

Type	Name	Description
Int32	mrMrsId	The identifier of the MrMrs object

Returns

Type	Description
MrMrs	MrMrs

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetMrMrses()

Returns all Items from the MrMrs table sorted by their value.

Declaration

public MrMrs[] GetMrMrses()

Returns

Type	Description
MrMrs[]	All items from the MrMrs table sorted by their value

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetMrMrsList(Int32[])

Gets an array of MrMrs objects.

Declaration

public MrMrs[] GetMrMrsList(int[] mrMrsIds)

Parameters

Type	Name	Description
Int32[]	mrMrsIds	The identifiers of the MrMrs object

Returns

Type	Description
MrMrs[]	Array of MrMrs objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetOurCurrency()

Gets the Our currency object if currency is enabled

Declaration

public Currency GetOurCurrency()

Returns

Type	Description
Currency	Our currency

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetOwnerCompanysCurrency()

Get the currency of the user's owner company

Declaration

public Currency GetOwnerCompanysCurrency()

Returns

Type	Description
Currency	Currency of the user's owner company

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPaymentTerm(Int32)

Gets a PaymentTerm object.

Declaration

public PaymentTerm GetPaymentTerm(int paymentTermId)

Parameters

Type	Name	Description
Int32	paymentTermId	The identifier of the PaymentTerm object

Returns

Type	Description
PaymentTerm	PaymentTerm

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPaymentTerms()

Returns all PaymentTerms in SuperOffice db.

Declaration

public PaymentTerm[] GetPaymentTerms()

Returns

Type	Description
PaymentTerm[]	An array of all available PaymentTerms

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPaymentType(Int32)

Gets a PaymentType object.

Declaration

public PaymentType GetPaymentType(int paymentTypeId)

Parameters

Type	Name	Description
Int32	paymentTypeId	The identifier of the PaymentType object

Returns

Type	Description
PaymentType	PaymentType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPaymentTypes()

Returns all PaymentTypes in SuperOffice db.

Declaration

public PaymentType[] GetPaymentTypes()

Returns

Type	Description
PaymentType[]	An array of all available PaymentTypes

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPluginCapabilities(Int32)

Get a list of plugin-dependent capabilities for a given document archive plugin.<br/>A standard set of properties is defined in SuperOffice.CRM.Documents.Constants.Capabilities.

Declaration

public StringDictionary GetPluginCapabilities(int pluginId)

Parameters

Type	Name	Description
Int32	pluginId	Numeric document plugin id, corresponding to the document.archiveProvider id or doctmpl.AutoeventId.

Returns

Type	Description
StringDictionary	Dictionary mapping capability names=values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPluginList()

Get a list of installed document plugins

Declaration

public StringDictionary GetPluginList()

Returns

Type	Description
StringDictionary	Dictionary mapping plugin id=plugin name

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPosition(Int32)

Gets a Position object.

Declaration

public Position GetPosition(int positionId)

Parameters

Type	Name	Description
Int32	positionId	The identifier of the Position object

Returns

Type	Description
Position	Position

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPositionList(Int32[])

Gets an array of Position objects.

Declaration

public Position[] GetPositionList(int[] positionIds)

Parameters

Type	Name	Description
Int32[]	positionIds	The identifiers of the Position object

Returns

Type	Description
Position[]	Array of Position objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPositions()

Returns all the positions a person could have.

Declaration

public Position[] GetPositions()

Returns

Type	Description
Position[]	An array of all available positions

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPriorities()

Returns all priorities an appointment could have.

Declaration

public Priority[] GetPriorities()

Returns

Type	Description
Priority[]	An array of all available priorities

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPriority(Int32)

Gets a Priority object.

Declaration

public Priority GetPriority(int priorityId)

Parameters

Type	Name	Description
Int32	priorityId	The identifier of the Priority object

Returns

Type	Description
Priority	Priority

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetPriorityList(Int32[])

Gets an array of Priority objects.

Declaration

public Priority[] GetPriorityList(int[] priorityIds)

Parameters

Type	Name	Description
Int32[]	priorityIds	The identifiers of the Priority object

Returns

Type	Description
Priority[]	Array of Priority objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductCategories()

Returns all ProductCategories in SuperOffice list.

Declaration

public ProductCategory[] GetProductCategories()

Returns

Type	Description
ProductCategory[]	An array of all available ProductCategory

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductCategory(Int32)

Gets a ProductCategory object.

Declaration

public ProductCategory GetProductCategory(int productCategoryId)

Parameters

Type	Name	Description
Int32	productCategoryId	The identifier of the ProductCategory object

Returns

Type	Description
ProductCategory	ProductCategory

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductFamilies()

Returns all ProductFamily in SuperOffice list.

Declaration

public ProductFamily[] GetProductFamilies()

Returns

Type	Description
ProductFamily[]	An array of all available ProductFamilies

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductFamily(Int32)

Gets a ProductFamily object.

Declaration

public ProductFamily GetProductFamily(int productFamilyId)

Parameters

Type	Name	Description
Int32	productFamilyId	The identifier of the ProductFamily object

Returns

Type	Description
ProductFamily	ProductFamily

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductType(Int32)

Gets a ProductType object.

Declaration

public ProductType GetProductType(int productTypeId)

Parameters

Type	Name	Description
Int32	productTypeId	The identifier of the ProductType object

Returns

Type	Description
ProductType	ProductType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProductTypes()

Returns all ProductTypes in SuperOffice list.

Declaration

public ProductType[] GetProductTypes()

Returns

Type	Description
ProductType[]	An array of all available ProductTypes

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectStatus(Int32)

Gets a ProjectStatus object.

Declaration

public ProjectStatus GetProjectStatus(int projectStatusId)

Parameters

Type	Name	Description
Int32	projectStatusId	The identifier of the ProjectStatus object

Returns

Type	Description
ProjectStatus	ProjectStatus

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectStatuses()

Gets all items from the Project Status (ProjStatus) table.

Declaration

public ProjectStatus[] GetProjectStatuses()

Returns

Type	Description
ProjectStatus[]	List of all Project statuses.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectStatusList(Int32[])

Gets an array of ProjectStatus objects.

Declaration

public ProjectStatus[] GetProjectStatusList(int[] projectStatusIds)

Parameters

Type	Name	Description
Int32[]	projectStatusIds	The identifiers of the ProjectStatus object

Returns

Type	Description
ProjectStatus[]	Array of ProjectStatus objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectType(Int32)

Gets a ProjectType object.

Declaration

public ProjectType GetProjectType(int projectTypeId)

Parameters

Type	Name	Description
Int32	projectTypeId	The identifier of the ProjectType object

Returns

Type	Description
ProjectType	ProjectType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectTypeEntity(Int32)

Gets a ProjectTypeEntity object.

Declaration

public ProjectTypeEntity GetProjectTypeEntity(int projectTypeEntityId)

Parameters

Type	Name	Description
Int32	projectTypeEntityId	The identifier of the ProjectTypeEntity object

Returns

Type	Description
ProjectTypeEntity	ProjectTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectTypeList(Int32[])

Gets an array of ProjectType objects.

Declaration

public ProjectType[] GetProjectTypeList(int[] projectTypeIds)

Parameters

Type	Name	Description
Int32[]	projectTypeIds	The identifiers of the ProjectType object

Returns

Type	Description
ProjectType[]	Array of ProjectType objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetProjectTypes()

Gets all items from the Project Type (ProjType) table.

Declaration

public ProjectType[] GetProjectTypes()

Returns

Type	Description
ProjectType[]	List of all project types.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuickReplies()

Method to return all quick replies for a given associate

Declaration

public QuickReply[] GetQuickReplies()

Returns

Type	Description
QuickReply[]	Array of quick replies

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteApproveReason(Int32)

Gets a QuoteApproveReason object.

Declaration

public QuoteApproveReason GetQuoteApproveReason(int quoteApproveReasonId)

Parameters

Type	Name	Description
Int32	quoteApproveReasonId	The identifier of the QuoteApproveReason object

Returns

Type	Description
QuoteApproveReason	QuoteApproveReason

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteApproveReasonList(Int32[])

Gets an array of QuoteApproveReason objects.

Declaration

public QuoteApproveReason[] GetQuoteApproveReasonList(int[] quoteApproveReasonIds)

Parameters

Type	Name	Description
Int32[]	quoteApproveReasonIds	The identifiers of the QuoteApproveReason object

Returns

Type	Description
QuoteApproveReason[]	Array of QuoteApproveReason objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteApproveReasons()

Returns all available QuoteApproveReasons.

Declaration

public QuoteApproveReason[] GetQuoteApproveReasons()

Returns

Type	Description
QuoteApproveReason[]	An array of all non-deleted QuoteApproveReason

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteDenyReason(Int32)

Gets a QuoteDenyReason object.

Declaration

public QuoteDenyReason GetQuoteDenyReason(int quoteDenyReasonId)

Parameters

Type	Name	Description
Int32	quoteDenyReasonId	The identifier of the QuoteDenyReason object

Returns

Type	Description
QuoteDenyReason	QuoteDenyReason

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteDenyReasonList(Int32[])

Gets an array of QuoteDenyReason objects.

Declaration

public QuoteDenyReason[] GetQuoteDenyReasonList(int[] quoteDenyReasonIds)

Parameters

Type	Name	Description
Int32[]	quoteDenyReasonIds	The identifiers of the QuoteDenyReason object

Returns

Type	Description
QuoteDenyReason[]	Array of QuoteDenyReason objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetQuoteDenyReasons()

Returns all available QuoteDenyReasons.

Declaration

public QuoteDenyReason[] GetQuoteDenyReasons()

Returns

Type	Description
QuoteDenyReason[]	An array of all non-deleted QuoteDenyReason

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetRating(Int32)

Gets a Rating object.

Declaration

public Rating GetRating(int ratingId)

Parameters

Type	Name	Description
Int32	ratingId	The identifier of the Rating object

Returns

Type	Description
Rating	Rating

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetRatingList(Int32[])

Gets an array of Rating objects.

Declaration

public Rating[] GetRatingList(int[] ratingIds)

Parameters

Type	Name	Description
Int32[]	ratingIds	The identifiers of the Rating object

Returns

Type	Description
Rating[]	Array of Rating objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetRatings()

Returns all ratings

Declaration

public Rating[] GetRatings()

Returns

Type	Description
Rating[]	Array of ratings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReason(Int32)

Gets a Reason object.

Declaration

public Reason GetReason(int reasonId)

Parameters

Type	Name	Description
Int32	reasonId	The identifier of the Reason object

Returns

Type	Description
Reason	Reason

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasonList(Int32[])

Gets an array of Reason objects.

Declaration

public Reason[] GetReasonList(int[] reasonIds)

Parameters

Type	Name	Description
Int32[]	reasonIds	The identifiers of the Reason object

Returns

Type	Description
Reason[]	Array of Reason objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasons()

Returns all reasons

Declaration

public Reason[] GetReasons()

Returns

Type	Description
Reason[]	Array of reasons

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasonSold(Int32)

Gets a ReasonSold object.

Declaration

public ReasonSold GetReasonSold(int reasonSoldId)

Parameters

Type	Name	Description
Int32	reasonSoldId	The identifier of the ReasonSold object

Returns

Type	Description
ReasonSold	ReasonSold

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasonSoldList(Int32[])

Gets an array of ReasonSold objects.

Declaration

public ReasonSold[] GetReasonSoldList(int[] reasonSoldIds)

Parameters

Type	Name	Description
Int32[]	reasonSoldIds	The identifiers of the ReasonSold object

Returns

Type	Description
ReasonSold[]	Array of ReasonSold objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasonStalled(Int32)

Gets a ReasonStalled object.

Declaration

public ReasonStalled GetReasonStalled(int reasonStalledId)

Parameters

Type	Name	Description
Int32	reasonStalledId	The identifier of the ReasonStalled object

Returns

Type	Description
ReasonStalled	ReasonStalled

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetReasonStalledList(Int32[])

Gets an array of ReasonStalled objects.

Declaration

public ReasonStalled[] GetReasonStalledList(int[] reasonStalledIds)

Parameters

Type	Name	Description
Int32[]	reasonStalledIds	The identifiers of the ReasonStalled object

Returns

Type	Description
ReasonStalled[]	Array of ReasonStalled objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetRelationDefinitionEntity(Int32)

Gets a RelationDefinitionEntity object.

Declaration

public RelationDefinitionEntity GetRelationDefinitionEntity(int relationDefinitionEntityId)

Parameters

Type	Name	Description
Int32	relationDefinitionEntityId	The identifier of the RelationDefinitionEntity object

Returns

Type	Description
RelationDefinitionEntity	RelationDefinitionEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetResourceEntity(Int32)

Gets a ResourceEntity object.

Declaration

public ResourceEntity GetResourceEntity(int resourceEntityId)

Parameters

Type	Name	Description
Int32	resourceEntityId	The identifier of the ResourceEntity object

Returns

Type	Description
ResourceEntity	ResourceEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSaleStageEntity(Int32)

Gets a SaleStageEntity object.

Declaration

public SaleStageEntity GetSaleStageEntity(int saleStageEntityId)

Parameters

Type	Name	Description
Int32	saleStageEntityId	The identifier of the SaleStageEntity object

Returns

Type	Description
SaleStageEntity	SaleStageEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSaleType(Int32)

Gets a SaleType object.

Declaration

public SaleType GetSaleType(int saleTypeId)

Parameters

Type	Name	Description
Int32	saleTypeId	The identifier of the SaleType object

Returns

Type	Description
SaleType	SaleType

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSaleTypeEntity(Int32)

Gets a SaleTypeEntity object.

Declaration

public SaleTypeEntity GetSaleTypeEntity(int saleTypeEntityId)

Parameters

Type	Name	Description
Int32	saleTypeEntityId	The identifier of the SaleTypeEntity object

Returns

Type	Description
SaleTypeEntity	SaleTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSaleTypeList(Int32[])

Gets an array of SaleType objects.

Declaration

public SaleType[] GetSaleTypeList(int[] saleTypeIds)

Parameters

Type	Name	Description
Int32[]	saleTypeIds	The identifiers of the SaleType object

Returns

Type	Description
SaleType[]	Array of SaleType objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectionCategory(Int32)

Gets a SelectionCategory object.

Declaration

public SelectionCategory GetSelectionCategory(int selectionCategoryId)

Parameters

Type	Name	Description
Int32	selectionCategoryId	The identifier of the SelectionCategory object

Returns

Type	Description
SelectionCategory	SelectionCategory

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSelectionCategoryList(Int32[])

Gets an array of SelectionCategory objects.

Declaration

public SelectionCategory[] GetSelectionCategoryList(int[] selectionCategoryIds)

Parameters

Type	Name	Description
Int32[]	selectionCategoryIds	The identifiers of the SelectionCategory object

Returns

Type	Description
SelectionCategory[]	Array of SelectionCategory objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSource(Int32)

Gets a Source object.

Declaration

public Source GetSource(int sourceId)

Parameters

Type	Name	Description
Int32	sourceId	The identifier of the Source object

Returns

Type	Description
Source	Source

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSourceList(Int32[])

Gets an array of Source objects.

Declaration

public Source[] GetSourceList(int[] sourceIds)

Parameters

Type	Name	Description
Int32[]	sourceIds	The identifiers of the Source object

Returns

Type	Description
Source[]	Array of Source objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetSources()

Returns all sources

Declaration

public Source[] GetSources()

Returns

Type	Description
Source[]	Array of sources

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTask(Int32)

Gets a Task object.

Declaration

public Task GetTask(int taskId)

Parameters

Type	Name	Description
Int32	taskId	The identifier of the Task object

Returns

Type	Description
Task	Task

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTaskList(Int32[])

Gets an array of Task objects.

Declaration

public Task[] GetTaskList(int[] taskIds)

Parameters

Type	Name	Description
Int32[]	taskIds	The identifiers of the Task object

Returns

Type	Description
Task[]	Array of Task objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTaskMenu(Int32)

Gets a TaskMenu object.

Declaration

public TaskMenu GetTaskMenu(int taskMenuId)

Parameters

Type	Name	Description
Int32	taskMenuId	The identifier of the TaskMenu object

Returns

Type	Description
TaskMenu	TaskMenu

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTaskMenuByProgId(String)

Get a task menu using the ProgId key that was specified when it was created

Declaration

public TaskMenu GetTaskMenuByProgId(string progId)

Parameters

Type	Name	Description
String	progId	String key that can be used to uniquely retrieve the taskmenu, set in the TaskMenu when saving

Returns

Type	Description
TaskMenu	The task menu

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTasks()

Returns all appointment tasks

Declaration

public Task[] GetTasks()

Returns

Type	Description
Task[]	An array of all available tasks

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketCategories()

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public TicketCategoryEntity[] GetTicketCategories()

Returns

Type	Description
TicketCategoryEntity[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketCategoriesForUserGroups(Int32[])

Ticket categories for user groups

Declaration

public MDOListItem[] GetTicketCategoriesForUserGroups(int[] userGroupIds)

Parameters

Type	Name	Description
Int32[]	userGroupIds	The ids of the user groups we want tickets categories from

Returns

Type	Description
MDOListItem[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketCategory(Int32)

Gets a TicketCategory object.

Declaration

public TicketCategory GetTicketCategory(int ticketCategoryId)

Parameters

Type	Name	Description
Int32	ticketCategoryId	The identifier of the TicketCategory object

Returns

Type	Description
TicketCategory	TicketCategory

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketCategoryEntity(Int32)

Gets a TicketCategoryEntity object.

Declaration

public TicketCategoryEntity GetTicketCategoryEntity(int ticketCategoryEntityId)

Parameters

Type	Name	Description
Int32	ticketCategoryEntityId	The identifier of the TicketCategoryEntity object

Returns

Type	Description
TicketCategoryEntity	TicketCategoryEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketCategoryList(Int32[])

Gets an array of TicketCategoryEntity objects.

Declaration

public TicketCategoryEntity[] GetTicketCategoryList(int[] ticketCategoryEntityIds)

Parameters

Type	Name	Description
Int32[]	ticketCategoryEntityIds	The identifiers of the TicketCategoryEntity object

Returns

Type	Description
TicketCategoryEntity[]	Array of TicketCategoryEntity objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketPriorities()

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public TicketPriority[] GetTicketPriorities()

Returns

Type	Description
TicketPriority[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketPriority(Int32)

Gets a TicketPriority object.

Declaration

public TicketPriority GetTicketPriority(int ticketPriorityId)

Parameters

Type	Name	Description
Int32	ticketPriorityId	The identifier of the TicketPriority object

Returns

Type	Description
TicketPriority	TicketPriority

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketPriorityEntity(Int32)

Gets a TicketPriorityEntity object.

Declaration

public TicketPriorityEntity GetTicketPriorityEntity(int ticketPriorityEntityId)

Parameters

Type	Name	Description
Int32	ticketPriorityEntityId	The identifier of the TicketPriorityEntity object

Returns

Type	Description
TicketPriorityEntity	TicketPriorityEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketPriorityList(Int32[])

Gets an array of TicketPriority objects.

Declaration

public TicketPriority[] GetTicketPriorityList(int[] ticketPriorityIds)

Parameters

Type	Name	Description
Int32[]	ticketPriorityIds	The identifiers of the TicketPriority object

Returns

Type	Description
TicketPriority[]	Array of TicketPriority objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketStatusEntity(Int32)

Gets a TicketStatusEntity object.

Declaration

public TicketStatusEntity GetTicketStatusEntity(int ticketStatusEntityId)

Parameters

Type	Name	Description
Int32	ticketStatusEntityId	The identifier of the TicketStatusEntity object

Returns

Type	Description
TicketStatusEntity	TicketStatusEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketStatuses()

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public TicketStatusEntity[] GetTicketStatuses()

Returns

Type	Description
TicketStatusEntity[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketStatusList(Int32[])

Gets an array of TicketStatusEntity objects.

Declaration

public TicketStatusEntity[] GetTicketStatusList(int[] ticketStatusEntityIds)

Parameters

Type	Name	Description
Int32[]	ticketStatusEntityIds	The identifiers of the TicketStatusEntity object

Returns

Type	Description
TicketStatusEntity[]	Array of TicketStatusEntity objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketTypeEntity(Int32)

Gets a TicketTypeEntity object.

Declaration

public TicketTypeEntity GetTicketTypeEntity(int ticketTypeEntityId)

Parameters

Type	Name	Description
Int32	ticketTypeEntityId	The identifier of the TicketTypeEntity object

Returns

Type	Description
TicketTypeEntity	TicketTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketTypeList(Int32[])

Gets an array of TicketTypeEntity objects.

Declaration

public TicketTypeEntity[] GetTicketTypeList(int[] ticketTypeEntityIds)

Parameters

Type	Name	Description
Int32[]	ticketTypeEntityIds	The identifiers of the TicketTypeEntity object

Returns

Type	Description
TicketTypeEntity[]	Array of TicketTypeEntity objects

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetTicketTypes()

Get all TicketTypes

Declaration

public TicketTypeEntity[] GetTicketTypes()

Returns

Type	Description
TicketTypeEntity[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetVisibleForUserGroups(Int32, Int32)

List of User groups that this list item is visible for

Declaration

public SelectableMDOListItem[] GetVisibleForUserGroups(int udListDefinitionId, int listItemId)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The id of the list item

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable user groups

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetVisibleForUserGroupsFromListName(String, Int32)

List of User groups that this list item is visible for

Declaration

public SelectableMDOListItem[] GetVisibleForUserGroupsFromListName(string udListDefinitionName, int listItemId)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition.
Int32	listItemId	The id of the list item

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable user groups

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetWebPanelByProgId(String)

Get a web panel using the ProgId key that was specified when it was created

Declaration

public WebPanelEntity GetWebPanelByProgId(string progId)

Parameters

Type	Name	Description
String	progId	String key that can be used to uniquely retrieve the panel, set in the WebPanelEntity when saving

Returns

Type	Description
WebPanelEntity	The Web panel information

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetWebPanelEntity(Int32)

Gets a WebPanelEntity object.

Declaration

public WebPanelEntity GetWebPanelEntity(int webPanelEntityId)

Parameters

Type	Name	Description
Int32	webPanelEntityId	The identifier of the WebPanelEntity object

Returns

Type	Description
WebPanelEntity	WebPanelEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GetWebPanelList()

Return a list of all web panels.

Declaration

public WebPanelEntity[] GetWebPanelList()

Returns

Type	Description
WebPanelEntity[]	List of all web panels

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GlobalChangeTicketStatus(Int32, Int32)

This method will change all references from one ticket status to another. Typically used in conjuction with delete

Declaration

public void GlobalChangeTicketStatus(int fromTicketStatusId, int toTicketStatusId)

Parameters

Type	Name	Description
Int32	fromTicketStatusId	The id of the ticket status to change from
Int32	toTicketStatusId	The id of the ticket status to change to

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

GlobalChangeTicketType(Int32, Int32)

Change all references from one ticket type to another. Typically used in conjuction with ticket type delete

Declaration

public void GlobalChangeTicketType(int fromTicketTypeId, int toTicketTypeId)

Parameters

Type	Name	Description
Int32	fromTicketTypeId	The id of the ticket type to change from
Int32	toTicketTypeId	The id of the ticket type to change to

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

MoveAllTickets(Int32, Int32)

Move all tickets from one ticket category to another

Declaration

public void MoveAllTickets(int fromTicketCategoryId, int toTicketCategoryId)

Parameters

Type	Name	Description
Int32	fromTicketCategoryId	The id of the category we want to move tickets from
Int32	toTicketCategoryId	The id of the category we want to move the tickets to

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

MoveListItem(Int32, Int32, Int32)

Move a list item up or down in the list based on rank

Declaration

public void MoveListItem(int udListDefinitionId, int listItemId, int direction)

Parameters

Type	Name	Description
Int32	udListDefinitionId	Id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	Id of the list item
Int32	direction	-1 moves the item up one position, 1 moves the item down one position

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

RebuildFullnames()

Update the fullname field of all categories. Use this e.g. when changing parentId or renaming a category with children.

Declaration

public void RebuildFullnames()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveAllFromListDefinition(Int32, ListItemEntity[])

Save all list items for the specified list defintion

Declaration

public ListItemEntity[] SaveAllFromListDefinition(int udListDefinitionId, ListItemEntity[] items)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list definition, indicating which list to save the items to. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
ListItemEntity[]	items	The list items

Returns

Type	Description
ListItemEntity[]	The list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveAllFromListName(String, ListItemEntity[])

Save all list items for the specified list defintion

Declaration

public ListItemEntity[] SaveAllFromListName(string udListDefinitionName, ListItemEntity[] items)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to save the items to.
ListItemEntity[]	items	The list items

Returns

Type	Description
ListItemEntity[]	The list items

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveAmountClassEntity(AmountClassEntity)

Updates the existing AmountClassEntity or creates a new AmountClassEntity if the id parameter is empty

Declaration

public AmountClassEntity SaveAmountClassEntity(AmountClassEntity amountClassEntity)

Parameters

Type	Name	Description
AmountClassEntity	amountClassEntity	The AmountClassEntity that is saved.

Returns

Type	Description
AmountClassEntity	New or updated AmountClassEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveConsentPurpose(ConsentPurpose)

Save a ConsentPurpose object

Declaration

public ConsentPurpose SaveConsentPurpose(ConsentPurpose consentPurpose)

Parameters

Type	Name	Description
ConsentPurpose	consentPurpose	The ConsentPurpose object to save

Returns

Type	Description
ConsentPurpose	The saved ConsentPurpose object, updated with the ConsentPurposeId if it is a new database entry

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveConsentSource(ConsentSource)

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public ConsentSource SaveConsentSource(ConsentSource consentSource)

Parameters

Type	Name	Description
ConsentSource	consentSource

Returns

Type	Description
ConsentSource

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveCountry(Country)

Saves a country

Declaration

public Country SaveCountry(Country country)

Parameters

Type	Name	Description
Country	country	The country to save

Returns

Type	Description
Country	The country that is saved

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveCurrencyEntity(CurrencyEntity)

Updates the existing CurrencyEntity or creates a new CurrencyEntity if the id parameter is empty

Declaration

public CurrencyEntity SaveCurrencyEntity(CurrencyEntity currencyEntity)

Parameters

Type	Name	Description
CurrencyEntity	currencyEntity	The CurrencyEntity that is saved.

Returns

Type	Description
CurrencyEntity	New or updated CurrencyEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveDocumentTemplateEntity(DocumentTemplateEntity)

Updates the existing DocumentTemplateEntity or creates a new DocumentTemplateEntity if the id parameter is empty

Declaration

public DocumentTemplateEntity SaveDocumentTemplateEntity(DocumentTemplateEntity documentTemplateEntity)

Parameters

Type	Name	Description
DocumentTemplateEntity	documentTemplateEntity	The DocumentTemplateEntity that is saved.

Returns

Type	Description
DocumentTemplateEntity	New or updated DocumentTemplateEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveDocumentTemplateStream(Int32, Stream, String, Int32)

Writes content in stream to document template file

Declaration

public TemplateInfo SaveDocumentTemplateStream(int documentTemplateId, Stream content, string languageCode, int pluginId)

Parameters

Type	Name	Description
Int32	documentTemplateId	Identifier for document template
Stream	content	Stream containing content to be saved to document template file
String	languageCode	Language variation of template to update. (ISO code: "en-US" or "nb-NO" etc). Used to select a template of the appropriate language. Can be overridden in SO ARC by user preference "PreferDocLang".
Int32	pluginId	Plugin to use for storing document content. 0 = SOARC. Use -1 to use the plugin specified in the template.

Returns

Type	Description
TemplateInfo	Template info

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveExtAppEntity(ExtAppEntity)

Updates the existing ExtAppEntity or creates a new ExtAppEntity if the id parameter is empty

Declaration

public ExtAppEntity SaveExtAppEntity(ExtAppEntity extAppEntity)

Parameters

Type	Name	Description
ExtAppEntity	extAppEntity	The ExtAppEntity that is saved.

Returns

Type	Description
ExtAppEntity	New or updated ExtAppEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveFromListDefinition(Int32, Int32, ListItemEntity)

Save a list item for the specified list defintion

Declaration

public ListItemEntity SaveFromListDefinition(int id, int udListDefinitionId, ListItemEntity item)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to load
Int32	udListDefinitionId	The id of the list definition, indicating which list to save the item to. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
ListItemEntity	item	The item to save

Returns

Type	Description
ListItemEntity	The saved list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveFromListName(Int32, String, ListItemEntity)

Save a list item for the specified list defintion

Declaration

public ListItemEntity SaveFromListName(int id, string udListDefinitionName, ListItemEntity item)

Parameters

Type	Name	Description
Int32	id	The identity of the list item to load
String	udListDefinitionName	The name of the list definition, indicating which list to save the item to.
ListItemEntity	item	The item to save

Returns

Type	Description
ListItemEntity	The saved list item

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingEntity(HeadingEntity)

Updates the existing HeadingEntity or creates a new HeadingEntity if the id parameter is empty

Declaration

public HeadingEntity SaveHeadingEntity(HeadingEntity headingEntity)

Parameters

Type	Name	Description
HeadingEntity	headingEntity	The HeadingEntity that is saved.

Returns

Type	Description
HeadingEntity	New or updated HeadingEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingFromListDefinition(Int32, HeadingEntity)

Save new heading for list resolved by the provided id.

Declaration

public HeadingEntity SaveHeadingFromListDefinition(int id, HeadingEntity entity)

Parameters

Type	Name	Description
Int32	id	The id of the list to look up.
HeadingEntity	entity	The new heading to save

Returns

Type	Description
HeadingEntity	The saved entity.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingFromName(String, HeadingEntity)

Save new heading for list resolved by the provided name.

Declaration

public HeadingEntity SaveHeadingFromName(string name, HeadingEntity entity)

Parameters

Type	Name	Description
String	name	The name of the list to look up.
HeadingEntity	entity	The new heading to save

Returns

Type	Description
HeadingEntity	The saved entity.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingsForListItemFromListDefinition(Int32, Int32, SelectableMDOListItem[])

Saves the active headings for the list item.

Declaration

public SelectableMDOListItem[] SaveHeadingsForListItemFromListDefinition(int udListDefinitionId, int listItemId, SelectableMDOListItem[] headings)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list definition, indicating which list to delete the items from. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The identity of the list item to delete
SelectableMDOListItem[]	headings	The headings to save.

Returns

Type	Description
SelectableMDOListItem[]	Array of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingsForListItemFromListName(String, Int32, SelectableMDOListItem[])

Saves the headings for the list item.

Declaration

public SelectableMDOListItem[] SaveHeadingsForListItemFromListName(string udListDefinitionName, int listItemId, SelectableMDOListItem[] headings)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to update.
Int32	listItemId	The identity of the list item
SelectableMDOListItem[]	headings	The headings to save.

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingsFromListDefinition(Int32, HeadingEntity[])

Save headings for list resolved by the provided id.

Declaration

public HeadingEntity[] SaveHeadingsFromListDefinition(int id, HeadingEntity[] entities)

Parameters

Type	Name	Description
Int32	id	The id of the list to look up.
HeadingEntity[]	entities	The headings to save

Returns

Type	Description
HeadingEntity[]	List of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHeadingsFromName(String, HeadingEntity[])

Save headings for list resolved by the provided name.

Declaration

public HeadingEntity[] SaveHeadingsFromName(string name, HeadingEntity[] entities)

Parameters

Type	Name	Description
String	name	The name of the list to look up.
HeadingEntity[]	entities	The headings to save

Returns

Type	Description
HeadingEntity[]	List of headings

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveHierarchyEntity(HierarchyEntity)

Updates the existing HierarchyEntity or creates a new HierarchyEntity if the id parameter is empty

Declaration

public HierarchyEntity SaveHierarchyEntity(HierarchyEntity hierarchyEntity)

Parameters

Type	Name	Description
HierarchyEntity	hierarchyEntity	The HierarchyEntity that is saved.

Returns

Type	Description
HierarchyEntity	New or updated HierarchyEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveLegalBase(LegalBase)

Facade for the List Agent Collection of all services that works with Lists. These are typical lists of data shown in dropdown list, checkbox lists, etc.

Declaration

public LegalBase SaveLegalBase(LegalBase legalBase)

Parameters

Type	Name	Description
LegalBase	legalBase

Returns

Type	Description
LegalBase

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveListEntity(ListEntity)

Updates the existing ListEntity or creates a new ListEntity if the id parameter is empty

Declaration

public ListEntity SaveListEntity(ListEntity listEntity)

Parameters

Type	Name	Description
ListEntity	listEntity	The ListEntity that is saved.

Returns

Type	Description
ListEntity	New or updated ListEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveListEntityByName(String, ListEntity)

Save a ListEntity resolved by the provided name.

Declaration

public ListEntity SaveListEntityByName(string name, ListEntity listEntity)

Parameters

Type	Name	Description
String	name	The name of the list to save.
ListEntity	listEntity	The ListEntity to save.

Returns

Type	Description
ListEntity	A ListEntity or null.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveListItemEntity(ListItemEntity)

Save the ListItemEntity.

Declaration

public ListItemEntity SaveListItemEntity(ListItemEntity listItemEntity)

Parameters

Type	Name	Description
ListItemEntity	listItemEntity	The ListItemEntity to save.

Returns

Type	Description
ListItemEntity	The saved ListItemEntity.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveProjectTypeEntity(ProjectTypeEntity)

Updates the existing ProjectTypeEntity or creates a new ProjectTypeEntity if the id parameter is empty

Declaration

public ProjectTypeEntity SaveProjectTypeEntity(ProjectTypeEntity projectTypeEntity)

Parameters

Type	Name	Description
ProjectTypeEntity	projectTypeEntity	The ProjectTypeEntity that is saved.

Returns

Type	Description
ProjectTypeEntity	New or updated ProjectTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveQuickReplies(QuickReply[])

Method to save all quick replies for a given associate

Declaration

public void SaveQuickReplies(QuickReply[] quickReplies)

Parameters

Type	Name	Description
QuickReply[]	quickReplies	Array of quick replies

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveRelationDefinitionEntity(RelationDefinitionEntity)

Updates the existing RelationDefinitionEntity or creates a new RelationDefinitionEntity if the id parameter is empty

Declaration

public RelationDefinitionEntity SaveRelationDefinitionEntity(RelationDefinitionEntity relationDefinitionEntity)

Parameters

Type	Name	Description
RelationDefinitionEntity	relationDefinitionEntity	The RelationDefinitionEntity that is saved.

Returns

Type	Description
RelationDefinitionEntity	New or updated RelationDefinitionEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveResourceEntity(ResourceEntity)

Updates the existing ResourceEntity or creates a new ResourceEntity if the id parameter is empty

Declaration

public ResourceEntity SaveResourceEntity(ResourceEntity resourceEntity)

Parameters

Type	Name	Description
ResourceEntity	resourceEntity	The ResourceEntity that is saved.

Returns

Type	Description
ResourceEntity	New or updated ResourceEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveSaleStageEntity(SaleStageEntity)

Updates the existing SaleStageEntity or creates a new SaleStageEntity if the id parameter is empty

Declaration

public SaleStageEntity SaveSaleStageEntity(SaleStageEntity saleStageEntity)

Parameters

Type	Name	Description
SaleStageEntity	saleStageEntity	The SaleStageEntity that is saved.

Returns

Type	Description
SaleStageEntity	New or updated SaleStageEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveSaleTypeEntity(SaleTypeEntity)

Updates the existing SaleTypeEntity or creates a new SaleTypeEntity if the id parameter is empty

Declaration

public SaleTypeEntity SaveSaleTypeEntity(SaleTypeEntity saleTypeEntity)

Parameters

Type	Name	Description
SaleTypeEntity	saleTypeEntity	The SaleTypeEntity that is saved.

Returns

Type	Description
SaleTypeEntity	New or updated SaleTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveTaskMenu(TaskMenu)

Updates the existing TaskMenu or creates a new TaskMenu if the id parameter is empty

Declaration

public TaskMenu SaveTaskMenu(TaskMenu taskMenu)

Parameters

Type	Name	Description
TaskMenu	taskMenu	The TaskMenu that is saved.

Returns

Type	Description
TaskMenu	New or updated TaskMenu

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveTicketCategoryEntity(TicketCategoryEntity)

Updates the existing TicketCategoryEntity or creates a new TicketCategoryEntity if the id parameter is empty

Declaration

public TicketCategoryEntity SaveTicketCategoryEntity(TicketCategoryEntity ticketCategoryEntity)

Parameters

Type	Name	Description
TicketCategoryEntity	ticketCategoryEntity	The TicketCategoryEntity that is saved.

Returns

Type	Description
TicketCategoryEntity	New or updated TicketCategoryEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveTicketPriorityEntity(TicketPriorityEntity)

Updates the existing TicketPriorityEntity or creates a new TicketPriorityEntity if the id parameter is empty

Declaration

public TicketPriorityEntity SaveTicketPriorityEntity(TicketPriorityEntity ticketPriorityEntity)

Parameters

Type	Name	Description
TicketPriorityEntity	ticketPriorityEntity	The TicketPriorityEntity that is saved.

Returns

Type	Description
TicketPriorityEntity	New or updated TicketPriorityEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveTicketStatusEntity(TicketStatusEntity)

Updates the existing TicketStatusEntity or creates a new TicketStatusEntity if the id parameter is empty

Declaration

public TicketStatusEntity SaveTicketStatusEntity(TicketStatusEntity ticketStatusEntity)

Parameters

Type	Name	Description
TicketStatusEntity	ticketStatusEntity	The TicketStatusEntity that is saved.

Returns

Type	Description
TicketStatusEntity	New or updated TicketStatusEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveTicketTypeEntity(TicketTypeEntity)

Updates the existing TicketTypeEntity or creates a new TicketTypeEntity if the id parameter is empty

Declaration

public TicketTypeEntity SaveTicketTypeEntity(TicketTypeEntity ticketTypeEntity)

Parameters

Type	Name	Description
TicketTypeEntity	ticketTypeEntity	The TicketTypeEntity that is saved.

Returns

Type	Description
TicketTypeEntity	New or updated TicketTypeEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SaveWebPanelEntity(WebPanelEntity)

Updates the existing WebPanelEntity or creates a new WebPanelEntity if the id parameter is empty

Declaration

public WebPanelEntity SaveWebPanelEntity(WebPanelEntity webPanelEntity)

Parameters

Type	Name	Description
WebPanelEntity	webPanelEntity	The WebPanelEntity that is saved.

Returns

Type	Description
WebPanelEntity	New or updated WebPanelEntity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetDocumentPluginForAllDocumentTemplates(Int32)

Sets the document-plugin to be used for all templates of type 'document'.

Declaration

public void SetDocumentPluginForAllDocumentTemplates(int documentPluginId)

Parameters

Type	Name	Description
Int32	documentPluginId	The numerical ID of the document-plugin to use.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetDocumentTemplateFromDocumentTemplate(Int32, DocumentTemplateEntity)

Create a new document template based on another template

Declaration

public DocumentTemplateEntity SetDocumentTemplateFromDocumentTemplate(int sourceDocumentTemplateId, DocumentTemplateEntity documentTemplateEntity)

Parameters

Type	Name	Description
Int32	sourceDocumentTemplateId	The document template to copy contents from.
DocumentTemplateEntity	documentTemplateEntity	The new document template entity

Returns

Type	Description
DocumentTemplateEntity	The new document template entity

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetDocumentTemplateStream(DocumentTemplateEntity, Stream, String, Int32)

Store a document template from its stream. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.

Declaration

public DocumentTemplateEntity SetDocumentTemplateStream(DocumentTemplateEntity documentTemplateEntity, Stream stream, string languageCode, int pluginId)

Parameters

Type	Name	Description
DocumentTemplateEntity	documentTemplateEntity	The document entity object that the binary data (document) should be stored to. Its file name may be amended by this call, see the return value
Stream	stream	The document as a stream.
String	languageCode	The language code ('en-US', 'nb-NO', etc). Use empty string if not supported or used.
Int32	pluginId	The plugin id to store the template with. 0 for SOArc

Returns

Type	Description
DocumentTemplateEntity	Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetEmarketingStrictMode(Boolean)

Turn on the Emarketing strict mode, which will enable full GDPR rules concerning Emarketing consents and subscriptions

Declaration

public void SetEmarketingStrictMode(bool enable)

Parameters

Type	Name	Description
Boolean	enable	Set to true to enable strict mode

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetHeadingsForListItem(Int32, Int32, Int32[], Boolean)

Set headings which this list item should be listed under

Declaration

public void SetHeadingsForListItem(int udListDefinitionId, int listItemId, int[] headingIds, bool enable)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The id of the list item
Int32[]	headingIds	The ids of the headings to set for this list item
Boolean	enable	Set to true to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetListItemsForHeading(Int32, Int32, Int32[], Boolean)

Update listItems that will be visible for this usergroup

Declaration

public void SetListItemsForHeading(int udListDefinitionId, int headingId, int[] listItemIds, bool enable)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	headingId	The id of the heading
Int32[]	listItemIds	The ids of the list items.
Boolean	enable	True to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetListItemsForHeadingFromListName(String, Int32, Int32[], Boolean)

Update listItems under this heading

Declaration

public void SetListItemsForHeadingFromListName(string udListDefinitionName, int headingId, int[] listItemIds, bool enable)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition.
Int32	headingId	The id of the heading
Int32[]	listItemIds	The ids of the list items.
Boolean	enable	True to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetListItemsForUserGroup(Int32, Int32, Int32[], Boolean)

Update listItems that will be visible for this usergroup

Declaration

public void SetListItemsForUserGroup(int udListDefinitionId, int usergroupId, int[] listItemIds, bool enable)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	usergroupId	The id of the userGroup
Int32[]	listItemIds	The id of the list items.
Boolean	enable	True to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetListItemsForUserGroupFromListName(String, Int32, Int32[], Boolean)

Update listItems that will be visible for this usergroup

Declaration

public void SetListItemsForUserGroupFromListName(string udListDefinitionName, int usergroupId, int[] listItemsID, bool enable)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition.
Int32	usergroupId	The id of the userGroup
Int32[]	listItemsID	The id of the list items.
Boolean	enable	True to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnHeadings(Int32, Int32[])

Set rank order on headings

Declaration

public void SetRankOnHeadings(int udListDefinitionId, int[] headingIds)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32[]	headingIds	The ids of the headings in the order you want

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnProjectActivity(Int32, Int32[])

Set rank order on project activity

Declaration

public void SetRankOnProjectActivity(int projectTypeStatusLinkId, int[] itemsIds)

Parameters

Type	Name	Description
Int32	projectTypeStatusLinkId	The id of the list
Int32[]	itemsIds	The ids of the items in the order you want

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnProjectDocument(Int32, Int32[])

Set rank order on project document

Declaration

public void SetRankOnProjectDocument(int projectTypeStatusLinkId, int[] itemsIds)

Parameters

Type	Name	Description
Int32	projectTypeStatusLinkId	The id of the list
Int32[]	itemsIds	The ids of the items in the order you want

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnSaleActivity(Int32, Int32[])

Set rank order on sale activity

Declaration

public void SetRankOnSaleActivity(int saleTypeStageLinkId, int[] itemsIds)

Parameters

Type	Name	Description
Int32	saleTypeStageLinkId	The id of the list
Int32[]	itemsIds	The ids of the items in the order you want

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnSaleDocument(Int32, Int32[])

Set rank order on project document

Declaration

public void SetRankOnSaleDocument(int saleTypeStageLinkId, int[] itemsIds)

Parameters

Type	Name	Description
Int32	saleTypeStageLinkId	The id of the list
Int32[]	itemsIds	The ids of the items in the order you want

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetTicketCategoriesForUserGroup(Int32, Int32[])

Set ticket categories for one user group

Declaration

public void SetTicketCategoriesForUserGroup(int userGroupId, int[] categoryIds)

Parameters

Type	Name	Description
Int32	userGroupId	The ids of the user groups we want tickets categories from
Int32[]	categoryIds	The ids of the user groups we want tickets categories from

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetTicketPrioritySortOrder(Int32, Int32)

This method will set sort order of ticket priority in a list

Declaration

public void SetTicketPrioritySortOrder(int ticketPriorityId, int sortOrder)

Parameters

Type	Name	Description
Int32	ticketPriorityId	Id of ticket priority
Int32	sortOrder	Indicates the sort order for this priority. 1 is first. Any records following this one will be renumbered automatically

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetTicketStatusSortOrder(Int32, Int32)

This method will set sort order of ticket status in a list

Declaration

public void SetTicketStatusSortOrder(int ticketStatusId, int sortOrder)

Parameters

Type	Name	Description
Int32	ticketStatusId	Id of ticket status
Int32	sortOrder	Indicates the sort order for this status. 1 is first. Any records following this one will be renumbered automatically

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetTicketTypeSortOrder(Int32, Int32)

This method will set sort order of ticket type in a list

Declaration

public void SetTicketTypeSortOrder(int ticketTypeId, int sortOrder)

Parameters

Type	Name	Description
Int32	ticketTypeId	Id of ticket type
Int32	sortOrder	Indicates the sort order for this ticket type. 1 is first. Any records following this one will be renumbered automatically

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetVisibleForUserGroup(Int32, Int32, Int32[], Boolean)

Set a group which this list item should be visible for

Declaration

public void SetVisibleForUserGroup(int udListDefinitionId, int listItemId, int[] userGroupId, bool enable)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The id of the list item
Int32[]	userGroupId	The id of the user groups to set for this list item
Boolean	enable	Set to true to enable, false to disable

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetVisibleForUserGroups(Int32, Int32, SelectableMDOListItem[])

Update User groups that this list item is visible for

Declaration

public SelectableMDOListItem[] SetVisibleForUserGroups(int udListDefinitionId, int listItemId, SelectableMDOListItem[] userGroups)

Parameters

Type	Name	Description
Int32	udListDefinitionId	The id of the list. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
Int32	listItemId	The id of the list item
SelectableMDOListItem[]	userGroups	The selectable user groups.

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable user groups

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SetVisibleForUserGroupsFromListName(String, Int32, SelectableMDOListItem[])

Update User groups that this list item is visible for

Declaration

public SelectableMDOListItem[] SetVisibleForUserGroupsFromListName(string udListDefinitionName, int listItemId, SelectableMDOListItem[] userGroups)

Parameters

Type	Name	Description
String	udListDefinitionName	The name of the list definition, indicating which list to update the items from.
Int32	listItemId	The id of the list item
SelectableMDOListItem[]	userGroups	The selectable user groups.

Returns

Type	Description
SelectableMDOListItem[]	Array of selectable user groups

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

SortListItems(Int32, String)

Sort the list items in a given list alphabetically

Declaration

public void SortListItems(int udListDefinitionId, string cultureName)

Parameters

Type	Name	Description
Int32	udListDefinitionId	Id of the list you want to sort. Negative numbers indicate TableNumber value instead of UDListDefId. e.g. -64 = category.
String	cultureName	Sort list in this language

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

UpdateCategoryMemberships(Int32, TicketCategoryMembershipEntity[], TicketCategoryMembershipEntity[], TicketCategoryMembershipEntity[])

Updates category memberships

Declaration

public void UpdateCategoryMemberships(int ticketCategoryId, TicketCategoryMembershipEntity[] membershipsToAdd, TicketCategoryMembershipEntity[] membershipsToUpdate, TicketCategoryMembershipEntity[] membershipsToDelete)

Parameters

Type	Name	Description
Int32	ticketCategoryId	Id of ticket category to update memberships for
TicketCategoryMembershipEntity[]	membershipsToAdd	List of memberships to add
TicketCategoryMembershipEntity[]	membershipsToUpdate	List of memberships to update
TicketCategoryMembershipEntity[]	membershipsToDelete	List of memberships to delete

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

UpdateHierarchyFromPath(Domain, String, HierarchyEntity)

Update a hierarchy item from a path

Declaration

public HierarchyEntity UpdateHierarchyFromPath(Domain domain, string path, HierarchyEntity entity)

Parameters

Type	Name	Description
Domain	domain	Type of items to get
String	path	Hierarchy path to item
HierarchyEntity	entity	The hierarchy node to update.

Returns

Type	Description
HierarchyEntity	The hierarchy node updated to the path

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (ListAgent agent = new ListAgent())
     {
        // call methods on agent here...
     }
  }

Implements

System.IDisposable

IListAgent

IAgent