Skip to main content
Create Temporary Contact Selection From Selection Member Ids

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

SelectionId, SelectionMemberIds

CreateTemporaryContactSelectionFromSelectionMemberIds: Creates a temporary selection with members from a collection of selectionmember id's.

SelectionId
integer<int32>
SelectionMemberIds
integer<int32>[]

Response

OK

Carrier object for SelectionEntity. Services for the SelectionEntity Carrier is available from the Selection Agent.

Description
string

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

Postit
string

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

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

SelectionCategory
object

Carrier object for SelectionCategory. Services for the SelectionCategory Carrier is available from the List Agent.

GroupIdx
integer<int32>

Original primary user group of associate

IncludePerson
integer<int32>

0 = Include first person, 1 = Include all persons, 2 = Include no persons

MemberCount
integer<int64>

How many selectionmembers (for progress bar calculations) - estimate, -1 (or 4294967295) means we don't know

Name
string

Name of selection, freetext indexed

PostitTextId
integer<int32>

Postit text record id.

CreatedDate
string<date-time>

Registered when in UTC.

SelectionId
integer<int32>

Primary key

SoundEx
string

What the name sounds like, for duplicate detection

Source
integer<int32>

How did we get this selection? For future integration needs

TextId
integer<int32>

Description text record id

UpdatedDate
string<date-time>

Last updated when in UTC.

UpdatedCount
integer<int32>

Number of updates made to this record

Visibility
integer<int32>

Obsolete, but still maintained denormalization of visiblefor

SelectionType
enum<string>

Static/Dynamic/Combined?

Available options:
Static,
Dynamic,
Combined
CompanyUnique
boolean

Filter out duplicate members based on company?

TargetTableNumber
integer<int32>

TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale'

TargetTableName
string

TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale'

Completed
boolean

The Completed state.

LeftSelectionId
integer<int32>

LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.

RightSelectionId
integer<int32>

RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.

SelectionUnionType
enum<string>

How to combine the two selections when SelectionType = Combined.

Available options:
Unknown,
SubtractRightFromLeft,
SubtractLeftFromRight,
Intersect,
XOR,
Union
MainProviderName
string

The name of the Archive Provider that will deliver the content of the archive - the actual entity rows

ShadowProviderName
string

The name, if relevant, of the Archive Provider that will deliver the Shadow rows: contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive

ChartKey
string

ID/key of the last-used chart tile on this selection

LastLoaded
string<date-time>

The date/time this selection was last loaded (selectionentity fetched)

LastLoadedBy
integer<int32>

Who last loaded this selection

LastLoadedByAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

LastMembershipChange
string<date-time>

The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithm

LastMembershipChangeBy
integer<int32>

Who last changed the membership

LastMembershipChangeByAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

MainHeading
string

'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references

MemberTabHeading
string

'Companies', or whatever else is appropriate - the plural form of the entity name; this string will contain resource references

MailingsProviderName
string

The name of the provider for the Mailings tab, if relevant; this string will contain resource references

DashboardTileDefinitionId
integer<int32>

The associated tile definition

VisibleFor
object[]

The set of users or groups the record is visible for

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.