POST Agents/Project/GetProjectMembersById

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Project/GetProjectMembersById

Returns an array of project members

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/Project/GetProjectMembersById?$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

ProjectMemberIds

Property Name Type Description
ProjectMemberIds Array

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ProjectmemberId int32 Primary key
ContactId int32 Contact ID of person who is the project member
ProjectId int32 Parent project - the project this project member belongs to.
ContactName string Contact name
ContactDepartment string Contact department
ProjectName string Name of the project this project member belongs to.
EmailId int32 The person's email address id
EmailAddress string The e-mail address
CountryId int32 Country
Firstname string First name
MiddleName string Middle name or 'van' etc.
Lastname string Last name
PersonId int32 The person's id - primary key
Mrmrs string e.g. Mrs, Dr, Ms.
ProjectMemberTypeName string The projectmembers type name: 'secretary', 'member', etc.
Phone string Phone number
PhoneId int32 The phone id
ProjectMemberTypeId int32 ProjectMember Type Id - from the ProjectMemberType list. Use MDO List name "PMembType" to get list items.
EmailAddressName string The e-mail address description
Comment string Comment text on the project membership
FullName string The person's full name localized to the current culture/country. (internal name used in clients for employees)
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/Project/GetProjectMembersById
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ProjectMemberIds": [
    394,
    187
  ]
}

Sample response

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

[
  {
    "ProjectmemberId": 801,
    "ContactId": 786,
    "ProjectId": 698,
    "ContactName": "Bechtelar Inc and Sons",
    "ContactDepartment": "",
    "ProjectName": "Gleichner-Runte",
    "EmailId": 278,
    "EmailAddress": "elmer@nitzschedurgan.name",
    "CountryId": 570,
    "Firstname": "Mozell",
    "MiddleName": "Kub, Weber and Rosenbaum",
    "Lastname": "Bashirian",
    "PersonId": 196,
    "Mrmrs": "et",
    "ProjectMemberTypeName": "Nicolas-Rolfson",
    "Phone": "1-834-090-5725",
    "PhoneId": 224,
    "ProjectMemberTypeId": 543,
    "EmailAddressName": "leone@grant.co.uk",
    "Comment": "dolorum",
    "FullName": "Jamil Abraham Leannon DDS",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 403
      }
    }
  }
]