PUT api/v2/Users/{id}/UDF
Updates a set of UDF's to a person, where each UDF is identified by UserUDFValueViewModel
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
Collection of UserUDFValueViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UDFId |
Represents the UDF Id received from the GetAvailableUDFs |
globally unique identifier |
None. |
| UDFValue |
Represents the Value of the User Defined Field |
string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"UDFId": "2b6f86af-481d-4322-9465-29b573ed5bf3",
"UDFValue": "sample string 2"
},
{
"UDFId": "2b6f86af-481d-4322-9465-29b573ed5bf3",
"UDFValue": "sample string 2"
}
]
application/xml, text/xml
Sample:
<ArrayOfUserUDFValueViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<UserUDFValueViewModel>
<UDFId>2b6f86af-481d-4322-9465-29b573ed5bf3</UDFId>
<UDFValue>sample string 2</UDFValue>
</UserUDFValueViewModel>
<UserUDFValueViewModel>
<UDFId>2b6f86af-481d-4322-9465-29b573ed5bf3</UDFId>
<UDFValue>sample string 2</UDFValue>
</UserUDFValueViewModel>
</ArrayOfUserUDFValueViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultWithUDFResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| UDFValidationViewModels |
The Errors and responses from the UDF Validation |
Collection of UDFValidationViewModel |
None. |
| ResultCode |
Represents the result code |
integer |
None. |
| Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"UDFValidationViewModels": [
{
"UDFId": "7782388e-2f49-429c-bec5-5bdb7bce3774",
"sUDFFieldTypeId": "b4d586bf-bb3d-4987-980d-1fa3c9400163",
"MaxValue": "sample string 3",
"MinValue": "sample string 4",
"IsParsed": true,
"ValidationErrors": [
"sample string 1",
"sample string 2"
]
},
{
"UDFId": "7782388e-2f49-429c-bec5-5bdb7bce3774",
"sUDFFieldTypeId": "b4d586bf-bb3d-4987-980d-1fa3c9400163",
"MaxValue": "sample string 3",
"MinValue": "sample string 4",
"IsParsed": true,
"ValidationErrors": [
"sample string 1",
"sample string 2"
]
}
],
"ResultCode": 1,
"Description": "sample string 2"
}
application/xml, text/xml
Sample:
<ResultWithUDFResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<Description>sample string 2</Description>
<HttpStatusCode>Continue</HttpStatusCode>
<ResultCode>1</ResultCode>
<UDFValidationViewModels>
<UDFValidationViewModel>
<IsParsed>true</IsParsed>
<MaxValue>sample string 3</MaxValue>
<MinValue>sample string 4</MinValue>
<UDFId>7782388e-2f49-429c-bec5-5bdb7bce3774</UDFId>
<ValidationErrors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</ValidationErrors>
<sUDFFieldTypeId>b4d586bf-bb3d-4987-980d-1fa3c9400163</sUDFFieldTypeId>
</UDFValidationViewModel>
<UDFValidationViewModel>
<IsParsed>true</IsParsed>
<MaxValue>sample string 3</MaxValue>
<MinValue>sample string 4</MinValue>
<UDFId>7782388e-2f49-429c-bec5-5bdb7bce3774</UDFId>
<ValidationErrors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</ValidationErrors>
<sUDFFieldTypeId>b4d586bf-bb3d-4987-980d-1fa3c9400163</sUDFFieldTypeId>
</UDFValidationViewModel>
</UDFValidationViewModels>
</ResultWithUDFResponse>