POST ProjectMember
Some tooltip text!
• 6 minutes to read
• 6 minutes to read
POST /api/v1/ProjectMember
Creates a new ProjectMember
Calls the Project agent service SaveProjectMember. 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/ProjectMember?$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: newEntity
The ProjectMember to be saved.
| Property Name | Type | Description |
|---|---|---|
| ProjectmemberId | Integer | Primary key |
| ContactId | Integer | Contact ID of person who is the project member |
| ProjectId | Integer | 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 | Integer | The person's email address id |
| EmailAddress | String | The e-mail address |
| CountryId | Integer | Country |
| Firstname | String | First name |
| MiddleName | String | Middle name or 'van' etc. |
| Lastname | String | Last name |
| PersonId | Integer | 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 | Integer | The phone id |
| ProjectMemberTypeId | Integer | ProjectMember Type Id - from the ProjectMemberType list. |
| 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 | String | The date and time when the project member was registered in UTC. |
| Updated | String | The date and time when the project member was last updated in UTC. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
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
POST /api/v1/ProjectMember
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8
{
"ProjectmemberId": 971,
"ContactId": 96,
"ProjectId": 541,
"ContactName": "Hansen Inc and Sons",
"ContactDepartment": "",
"ProjectName": "Rohan, Homenick and Bashirian",
"EmailId": 732,
"EmailAddress": "zachery@bartoletti.us",
"CountryId": 640,
"Firstname": "Zora",
"MiddleName": "Douglas-Marks",
"Lastname": "Goyette",
"PersonId": 76,
"Mrmrs": "et",
"ProjectMemberTypeName": "West LLC",
"Phone": "375-381-7695 x31341",
"PhoneId": 576,
"ProjectMemberTypeId": 258,
"EmailAddressName": "lowell@batz.com",
"Comment": "saepe",
"FullName": "Chaya Bahringer",
"Registered": "2000-09-18T14:34:02.7837311+02:00",
"Updated": "2015-03-20T14:34:02.7837311+01:00"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ProjectmemberId": 89,
"ContactId": 627,
"ProjectId": 472,
"ContactName": "Grimes-Thiel",
"ContactDepartment": "",
"ProjectName": "Ryan Group",
"EmailId": 250,
"EmailAddress": "ofelia_kessler@reichertbashirian.com",
"CountryId": 194,
"Firstname": "Heather",
"MiddleName": "Hauck Inc and Sons",
"Lastname": "Denesik",
"PersonId": 908,
"Mrmrs": "in",
"ProjectMemberTypeName": "Murazik-Crona",
"Phone": "190.331.8079 x4199",
"PhoneId": 57,
"ProjectMemberTypeId": 518,
"EmailAddressName": "aliya.pollich@eichmannaufderhar.biz",
"Comment": "optio",
"FullName": "Sarah Johnson",
"Registered": "2008-08-23T14:34:02.7837311+02:00",
"Updated": "2001-01-01T14:34:02.7837311+01:00",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 613
}
},
"_Links": {
"Self": "https://www.example.com/api/v1/project/321",
"Archive": "https://www.example.com/api/v1/project"
}
}