PUT api/v1/Agents/{AgentID}/Preferences

Request Information

Parameters

NameDescriptionAdditional information
agentPreferencesPutDTO

Define this parameter in the request body.

AgentID

Define this parameter in the request URI.

Request body formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "Language": "sample string 1",
  "Currency": "sample string 2",
  "UnitSystem": "sample string 3",
  "ContactEmail": "sample string 4",
  "TimeZone": {
    "TheID": 1
  },
  "DateFormat": "sample string 5",
  "TimeFormat": "sample string 6",
  "Controls": {
    "MaxRFQ": 1
  },
  "Networks": [
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    },
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    },
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    }
  ],
  "AboutUs": "sample string 7",
  "MOTDSubject": "sample string 8",
  "MOTDMessage": "sample string 9"
}

application/xml, text/xml

Sample:
<AgentPreferencesPutDTO>
  <Language>sample string 1</Language>
  <Currency>sample string 2</Currency>
  <UnitSystem>sample string 3</UnitSystem>
  <ContactEmail>sample string 4</ContactEmail>
  <TimeZone>
    <TheID>1</TheID>
  </TimeZone>
  <DateFormat>sample string 5</DateFormat>
  <TimeFormat>sample string 6</TimeFormat>
  <Controls>
    <MaxRFQ>1</MaxRFQ>
  </Controls>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <AboutUs>sample string 7</AboutUs>
  <MOTDSubject>sample string 8</MOTDSubject>
  <MOTDMessage>sample string 9</MOTDMessage>
</AgentPreferencesPutDTO>

Response Information

Response body formats

application/json, text/json

Sample:
{
  "AboutUs": "sample string 1",
  "MOTDSubject": "sample string 2",
  "MOTDMessage": "sample string 3",
  "Language": "sample string 1",
  "Currency": "sample string 2",
  "UnitSystem": "sample string 3",
  "TimeZone": {
    "TheID": 1,
    "KeyIdentifier": "sample string 2",
    "KeyValue": "sample string 3",
    "KeyDescription": "sample string 4",
    "IsDefault": true
  },
  "DateFormat": "sample string 4",
  "TimeFormat": "sample string 5",
  "Controls": {
    "MaxRFQ": 1
  },
  "Networks": [
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    },
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    },
    {
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Preferred": true
    }
  ],
  "ContactEmail": "sample string 6"
}

application/xml, text/xml

Sample:
<AgentPreferencesDTO>
  <AboutUs>sample string 1</AboutUs>
  <MOTDSubject>sample string 2</MOTDSubject>
  <MOTDMessage>sample string 3</MOTDMessage>
  <Language>sample string 1</Language>
  <Currency>sample string 2</Currency>
  <UnitSystem>sample string 3</UnitSystem>
  <TimeZone>
    <TheID>1</TheID>
    <KeyIdentifier>sample string 2</KeyIdentifier>
    <KeyValue>sample string 3</KeyValue>
    <KeyDescription>sample string 4</KeyDescription>
    <IsDefault>true</IsDefault>
  </TimeZone>
  <DateFormat>sample string 4</DateFormat>
  <TimeFormat>sample string 5</TimeFormat>
  <Controls>
    <MaxRFQ>1</MaxRFQ>
  </Controls>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <Networks>
    <Code>sample string 2</Code>
    <Name>sample string 3</Name>
    <Preferred>true</Preferred>
  </Networks>
  <ContactEmail>sample string 6</ContactEmail>
</AgentPreferencesDTO>