Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId |
The user identifier. |
integer |
Required |
Body Parameters
The user.
Pico.User| Name | Description | Type | Additional information |
|---|---|---|---|
| birthdate |
Gets or sets the birthdate. |
string |
None. |
| firstName |
Gets or sets the first name. |
string |
None. |
| generation |
Gets or sets the generation. |
string |
None. |
| isActive |
Gets or sets a value indicating whether user is active. |
boolean |
None. |
| isCurrent |
Gets or sets a value indicating whether user is current. |
boolean |
None. |
| lastName |
Gets or sets the last name. |
string |
None. |
| middleName |
Gets or sets the name of the middle. |
string |
None. |
| mobilePhone |
Gets or sets the mobile phone. |
string |
None. |
| nickname |
Gets or sets the nick name. |
string |
None. |
| primaryEmail |
Gets or sets the primary email. |
string |
None. |
| ssn |
Gets or sets the SSN. |
string |
None. |
| workPhone |
Gets or sets the work phone. |
string |
None. |
| id |
Gets or sets the user identifier. |
integer |
None. |
| pricingOrganization |
Gets or sets the pricing organization identifier. |
string |
None. |
| defaultRole |
Gets or sets the user default role identifiers. |
integer |
None. |
| communicationMethods |
Gets or sets the communication method identifiers. |
Collection of integer |
None. |
| userCommissions |
Gets or sets the user commission identifiers. |
Collection of integer |
None. |
| licenses |
Gets or sets the organization identifiers. |
Collection of integer |
None. |
Request Formats
application/json, text/json
{
"birthdate": "sample String 1",
"firstName": "sample String 2",
"generation": "sample String 3",
"isActive": true,
"isCurrent": true,
"lastName": "sample String 6",
"middleName": "sample String 7",
"mobilePhone": "sample String 8",
"nickname": "sample String 9",
"primaryEmail": "sample String 10",
"ssn": "sample String 11",
"workPhone": "sample String 12",
"id": "13",
"pricingOrganization": "sample String 14",
"defaultRole": 1,
"communicationMethods": [
"1",
"2"
],
"userCommissions": [
"1",
"2"
],
"licenses": [
"1",
"2"
]
}
text/html
{"birthdate":"sample String 1","firstName":"sample String 2","generation":"sample String 3","isActive":true,"isCurrent":true,"lastName":"sample String 6","middleName":"sample String 7","mobilePhone":"sample String 8","nickname":"sample String 9","primaryEmail":"sample String 10","ssn":"sample String 11","workPhone":"sample String 12","id":"13","pricingOrganization":"sample String 14","defaultRole":1,"communicationMethods":["1","2"],"userCommissions":["1","2"],"licenses":["1","2"]}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The updated user.
Pico.User| Name | Description | Type | Additional information |
|---|---|---|---|
| birthdate |
Gets or sets the birthdate. |
string |
None. |
| firstName |
Gets or sets the first name. |
string |
None. |
| generation |
Gets or sets the generation. |
string |
None. |
| isActive |
Gets or sets a value indicating whether user is active. |
boolean |
None. |
| isCurrent |
Gets or sets a value indicating whether user is current. |
boolean |
None. |
| lastName |
Gets or sets the last name. |
string |
None. |
| middleName |
Gets or sets the name of the middle. |
string |
None. |
| mobilePhone |
Gets or sets the mobile phone. |
string |
None. |
| nickname |
Gets or sets the nick name. |
string |
None. |
| primaryEmail |
Gets or sets the primary email. |
string |
None. |
| ssn |
Gets or sets the SSN. |
string |
None. |
| workPhone |
Gets or sets the work phone. |
string |
None. |
| id |
Gets or sets the user identifier. |
integer |
None. |
| pricingOrganization |
Gets or sets the pricing organization identifier. |
string |
None. |
| defaultRole |
Gets or sets the user default role identifiers. |
integer |
None. |
| communicationMethods |
Gets or sets the communication method identifiers. |
Collection of integer |
None. |
| userCommissions |
Gets or sets the user commission identifiers. |
Collection of integer |
None. |
| licenses |
Gets or sets the organization identifiers. |
Collection of integer |
None. |
Response Formats
application/json, text/json
{
"birthdate": "sample String 1",
"firstName": "sample String 2",
"generation": "sample String 3",
"isActive": true,
"isCurrent": true,
"lastName": "sample String 6",
"middleName": "sample String 7",
"mobilePhone": "sample String 8",
"nickname": "sample String 9",
"primaryEmail": "sample String 10",
"ssn": "sample String 11",
"workPhone": "sample String 12",
"id": "13",
"pricingOrganization": "sample String 14",
"defaultRole": 1,
"communicationMethods": [
"1",
"2"
],
"userCommissions": [
"1",
"2"
],
"licenses": [
"1",
"2"
]
}
text/html
{"birthdate":"sample String 1","firstName":"sample String 2","generation":"sample String 3","isActive":true,"isCurrent":true,"lastName":"sample String 6","middleName":"sample String 7","mobilePhone":"sample String 8","nickname":"sample String 9","primaryEmail":"sample String 10","ssn":"sample String 11","workPhone":"sample String 12","id":"13","pricingOrganization":"sample String 14","defaultRole":1,"communicationMethods":["1","2"],"userCommissions":["1","2"],"licenses":["1","2"]}