POST api/entity/person/ModifyClientDefinedKey

Request Information

URI Parameters

None.

Body Parameters

ModifyClientDefinedKeyRequestParams
NameDescriptionTypeAdditional information
ClientDefinedKeysByPersonID

Dictionary of integer [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientDefinedKeysByPersonID": {
    "1": "sample string 2",
    "3": "sample string 4"
  }
}

application/javascript

Sample:
{"ClientDefinedKeysByPersonID":{"1":"sample string 2","3":"sample string 4"}}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ModifyClientDefinedKeyRequestParams'.

Response Information

Resource Description

WebMethodResult
NameDescriptionTypeAdditional information
Success

boolean

None.

ErrorText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:
{"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:
<WebMethodResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
</WebMethodResult>