GET Selection/{id}

• 8 minutes to read

GET /api/v1/Selection/{id}

Gets a SelectionEntity object.

Calls the Selection agent service GetSelectionEntity. NsApiSlow threshold: 5000 ms.

Path Part	Type	Description
id	int32	The id of the SelectionEntity to return. Required

Query String Parameters

Parameter Name	Type	Description
$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.

GET /api/v1/Selection/{id}?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept	Content-type(s) you would like the response in: `application/json`, `text/json`, `application/xml`, `text/xml`, `application/json-patch+json`, `application/merge-patch+json`
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

SelectionEntity found.

Response	Description
200	SelectionEntity found.
304	SelectionEntity has not changed since the requested If-Modified-Since date.
404	Not Found.

Response body: SelectionEntityWithLinks

Property Name	Type	Description
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	Associate	Owner of the selection
CreatedBy	Associate	Who created the selection
UpdatedBy	Associate	Who last modified the selection
SelectionCategory	SelectionCategory	Selection category type (list item) Use MDO List name "searchCat" to get list items.
GroupIdx	int32	Original primary user group of associate
IncludePerson	int32	0 = Include first person, 1 = Include all persons, 2 = Include no persons
MemberCount	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	int32	Postit text record id.
CreatedDate	date-time	Registered when in UTC.
SelectionId	int32	Primary key
SoundEx	string	What the name sounds like, for duplicate detection
Source	int32	How did we get this selection? For future integration needs
TextId	int32	Description text record id
UpdatedDate	date-time	Last updated when in UTC.
UpdatedCount	int32	Number of updates made to this record
Visibility	int32	Obsolete, but still maintained denormalization of visiblefor
SelectionType	string	Static/Dynamic/Combined?
CompanyUnique	bool	Filter out duplicate members based on company?
TargetTableNumber	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	bool	The Completed state.
LeftSelectionId	int32	LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
RightSelectionId	int32	RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
SelectionUnionType	string	How to combine the two selections when SelectionType = Combined.
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	date-time	The date/time this selection was last loaded (selectionentity fetched)
LastLoadedBy	int32	Who last loaded this selection
LastLoadedByAssociate	Associate	Associate that last looked at the selection members; only date (not time) is valid
LastMembershipChange	date-time	The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithm
LastMembershipChangeBy	int32	Who last changed the membership
LastMembershipChangeByAssociate	Associate	Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid
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	int32	The associated tile definition
VisibleFor	array	The set of users or groups the record is visible for
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

GET /api/v1/Selection/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 SelectionEntity found.
Content-Type: application/json; charset=utf-8
Last-Modified: Tue, 10 May 2005 14:34:02 G5T

{
  "Description": "Proactive well-modulated alliance",
  "Postit": "eos",
  "Associate": null,
  "CreatedBy": null,
  "UpdatedBy": null,
  "SelectionCategory": null,
  "GroupIdx": 318,
  "IncludePerson": 133,
  "MemberCount": 99.99,
  "Name": "VIP Customers",
  "PostitTextId": 547,
  "CreatedDate": "2017-10-08T14:34:02.3943037+02:00",
  "SelectionId": 127,
  "SoundEx": "aut",
  "Source": 239,
  "TextId": 401,
  "UpdatedDate": "2005-05-10T14:34:02.3943037+02:00",
  "UpdatedCount": 532,
  "Visibility": 510,
  "SelectionType": "Combined",
  "CompanyUnique": false,
  "TargetTableNumber": 522,
  "TargetTableName": "Schaefer LLC",
  "Completed": true,
  "LeftSelectionId": 756,
  "RightSelectionId": 606,
  "SelectionUnionType": "Intersect",
  "MainProviderName": "Watsica-Kub",
  "ShadowProviderName": "Wunsch Group",
  "ChartKey": "perspiciatis",
  "LastLoaded": "2021-11-01T14:34:02.3943037+01:00",
  "LastLoadedBy": 209,
  "LastLoadedByAssociate": null,
  "LastMembershipChange": "1998-11-08T14:34:02.3943037+01:00",
  "LastMembershipChangeBy": 867,
  "LastMembershipChangeByAssociate": null,
  "MainHeading": "sit",
  "MemberTabHeading": "perferendis",
  "MailingsProviderName": "Tremblay Group",
  "DashboardTileDefinitionId": 640,
  "VisibleFor": [
    {
      "VisibleId": 69,
      "Visibility": "All",
      "DisplayValue": "fuga",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 188
        }
      }
    },
    {
      "VisibleId": 69,
      "Visibility": "All",
      "DisplayValue": "fuga",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 188
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 710
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}