POST Agents/Sale/GetSaleStakeholderById

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Sale/GetSaleStakeholderById

NsApiSlow threshold: 2000 ms.

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. 
POST /api/v1/Agents/Sale/GetSaleStakeholderById?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

SaleStakeholderIds

Property Name Type Description
SaleStakeholderIds Array

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
StakeholderRoleName string Stakeholder role name
Comment string Optional comment text
StakeholderRoleId int32 Stakeholde role list id - Primary key
CountryId int32 Country id - primary key
PersonId int32 Person id - Primary key
EmailDescription string E-mail description
EmailId int32 E-mail address id - Primary key
EmailAddress string E-mail address
PhoneId int32 Primary key
ContactName string Contact name
ContactId int32 Contact ID of person or contact who is the sale stakeholder
SaleId int32 Parent sale
Mrmrs string e.g. Mrs, Mr, Ms, Dr.
Firstname string First name
MiddleName string Middle name or 'van' etc.
Lastname string Last name
SaleStakeholderId int32 Primary key
Rank int32 Rank in list of stakeholders
Phone string Phone number
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Sale/GetSaleStakeholderById
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "SaleStakeholderIds": [
    268,
    220
  ]
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "StakeholderRoleName": "Upton-Klein",
    "Comment": "sunt",
    "StakeholderRoleId": 137,
    "CountryId": 326,
    "PersonId": 856,
    "EmailDescription": "zelma.monahan@champlin.uk",
    "EmailId": 718,
    "EmailAddress": "nayeli@kshlerinvandervort.co.uk",
    "PhoneId": 853,
    "ContactName": "Ondricka, McGlynn and Schroeder",
    "ContactId": 835,
    "SaleId": 40,
    "Mrmrs": "officiis",
    "Firstname": "Josephine",
    "MiddleName": "Waelchi, Ernser and Farrell",
    "Lastname": "Sipes",
    "SaleStakeholderId": 943,
    "Rank": 284,
    "Phone": "815.079.5147 x8501",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 226
      }
    }
  }
]