PATCH ProjectMember/{id}

• 5 minutes to read
 • 5 minutes to read 
PATCH /api/v1/ProjectMember/{id}

Update a ProjectMember with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396. NsApiSlow threshold: 2000 ms. Update the Department field to "foo" can be done either as a JSON PATCH:


[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:


{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.IProjectAgent} service SaveProjectMember.

Path Part Type Description
id int32 The ProjectMember id to update. 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. 
PATCH /api/v1/ProjectMember/{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
Content-Type Content-type of the request body:
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: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name Type Description
op String "add", "replace", "remove", "test" "move" and "copy" not supported
path String The property names to modify. "/users/0/email", "/users/-",
value Object New/Replaced value - string or object.

Response:

ProjectMember updated.

Response Description
200 ProjectMember updated.
404 ProjectMember with given id does not exist in the db.
409 Update blocked because a 'test' operation has detected a conflict with the entity value.
412 Update aborted because ProjectMember has changed since the requested If-Unmodified-Since timestamp.

Response body: ProjectMemberWithLinks

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)
Registered date-time The date and time when the project member was registered in UTC.
Updated date-time The date and time when the project member was last updated in UTC.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

PATCH /api/v1/ProjectMember/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "adipisci",
    "value": {}
  },
  {
    "op": "add",
    "path": "adipisci",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 ProjectMember  updated.
Content-Type: application/json; charset=utf-8

{
  "ProjectmemberId": 323,
  "ContactId": 211,
  "ProjectId": 510,
  "ContactName": "Cole LLC",
  "ContactDepartment": "",
  "ProjectName": "Schroeder-Batz",
  "EmailId": 112,
  "EmailAddress": "lyda_lueilwitz@wuckerthuel.name",
  "CountryId": 608,
  "Firstname": "Terence",
  "MiddleName": "Pouros, Kovacek and Mraz",
  "Lastname": "Stark",
  "PersonId": 487,
  "Mrmrs": "voluptatum",
  "ProjectMemberTypeName": "Carter-Gutkowski",
  "Phone": "(289)594-6883 x820",
  "PhoneId": 119,
  "ProjectMemberTypeId": 149,
  "EmailAddressName": "loyce@hirtherussel.com",
  "Comment": "dolor",
  "FullName": "Dorothea Pacocha PhD",
  "Registered": "2016-10-12T02:30:53.0692723+02:00",
  "Updated": "2005-05-26T02:30:53.0692723+02:00",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 849
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}