Documentation for PATCH api/rep/{RepDID}/MiscField

PATCH api/rep/{RepDID}/MiscField

Update misc field values for a given Representative. Only input misc fields to update. All fields are not required.

Request Information

URI Parameters

Name	Description	Type	Additional information
RepDID	Primary identifier for the Rep	string	Required

Body Parameters

Name Value Pairs of misc fields to update

Dictionary of string [key] and Object [value]

Request Formats

application/xml, text/xml

Sample:

<DictionaryOfStringObject>
  <KeyValuePairOfStringObject>
    <Key>sample string 1</Key>
    <Value />
  </KeyValuePairOfStringObject>
  <KeyValuePairOfStringObject>
    <Key>sample string 3</Key>
    <Value />
  </KeyValuePairOfStringObject>
</DictionaryOfStringObject>

application/json, text/json

Sample:

{
  "sample string 1": {},
  "sample string 3": {}
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'IDictionary`2'.

Response Information

Resource Description

ApiResult

Name	Description	Type	Additional information
IsSuccessful	Whether the action was successful	boolean	None.
MessageTranslationKey	A translation key for any message that is returned. It will be the first of the messages if more than one exists.	string	None.
Message	Any message that needs to be conveyed related to the request. It will be the first of the messages if more than one exists.	string	None.
Messages	Any message that needs to be conveyed related to the request.	Collection of ApiResultMessage	None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.