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 UserUDFValueViewModelName | 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": "68938c24-9328-4656-ba58-de5f751c8feb", "UDFValue": "sample string 2" }, { "UDFId": "68938c24-9328-4656-ba58-de5f751c8feb", "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>68938c24-9328-4656-ba58-de5f751c8feb</UDFId> <UDFValue>sample string 2</UDFValue> </UserUDFValueViewModel> <UserUDFValueViewModel> <UDFId>68938c24-9328-4656-ba58-de5f751c8feb</UDFId> <UDFValue>sample string 2</UDFValue> </UserUDFValueViewModel> </ArrayOfUserUDFValueViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResultWithUDFResponseName | 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": "decc7a25-733d-4c90-b077-3c51a14ff13a", "sUDFFieldTypeId": "6d8a3789-fd8f-42f1-ba20-e1f017b7d618", "MaxValue": "sample string 3", "MinValue": "sample string 4", "IsParsed": true, "ValidationErrors": [ "sample string 1", "sample string 2" ] }, { "UDFId": "decc7a25-733d-4c90-b077-3c51a14ff13a", "sUDFFieldTypeId": "6d8a3789-fd8f-42f1-ba20-e1f017b7d618", "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>decc7a25-733d-4c90-b077-3c51a14ff13a</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>6d8a3789-fd8f-42f1-ba20-e1f017b7d618</sUDFFieldTypeId> </UDFValidationViewModel> <UDFValidationViewModel> <IsParsed>true</IsParsed> <MaxValue>sample string 3</MaxValue> <MinValue>sample string 4</MinValue> <UDFId>decc7a25-733d-4c90-b077-3c51a14ff13a</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>6d8a3789-fd8f-42f1-ba20-e1f017b7d618</sUDFFieldTypeId> </UDFValidationViewModel> </UDFValidationViewModels> </ResultWithUDFResponse>