POST

api/Settings/v1/Consumer

Updates a given consumer ID

Request Information

Roles

InterfaceSettings

URI Parameters

None.

Body Parameters

A list of consumers that you wish to update

Collection of UpdateConsumer

Name	Type	Additional information
ID	string	None.
Name	string	None.
ApplicationKey	string	None.
SharedSecret	string	None.
Enabled	string	None.
RowVersion	string	None.

Request Formats

[
  {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "ApplicationKey": "sample string 3",
    "SharedSecret": "sample string 4",
    "Enabled": "sample string 5",
    "RowVersion": "sample string 6"
  },
  {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "ApplicationKey": "sample string 3",
    "SharedSecret": "sample string 4",
    "Enabled": "sample string 5",
    "RowVersion": "sample string 6"
  }
]

<ArrayOfUpdateConsumer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings.SIF">
  <UpdateConsumer>
    <ApplicationKey>sample string 3</ApplicationKey>
    <Enabled>sample string 5</Enabled>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <RowVersion>sample string 6</RowVersion>
    <SharedSecret>sample string 4</SharedSecret>
  </UpdateConsumer>
  <UpdateConsumer>
    <ApplicationKey>sample string 3</ApplicationKey>
    <Enabled>sample string 5</Enabled>
    <ID>sample string 1</ID>
    <Name>sample string 2</Name>
    <RowVersion>sample string 6</RowVersion>
    <SharedSecret>sample string 4</SharedSecret>
  </UpdateConsumer>
</ArrayOfUpdateConsumer>

Sample not available.

Response Information

Resource Description

If save successful return empty list, else return any errors

Collection of SettingsSaveError

Name	Type	Additional information
ID	string	None.
Title	string	None.
Error	string	None.

[
  {
    "ID": "sample string 1",
    "Title": "sample string 2",
    "Error": "sample string 3"
  },
  {
    "ID": "sample string 1",
    "Title": "sample string 2",
    "Error": "sample string 3"
  }
]

<ArrayOfSettingsSaveError xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.Settings">
  <SettingsSaveError>
    <Error>sample string 3</Error>
    <ID>sample string 1</ID>
    <Title>sample string 2</Title>
  </SettingsSaveError>
  <SettingsSaveError>
    <Error>sample string 3</Error>
    <ID>sample string 1</ID>
    <Title>sample string 2</Title>
  </SettingsSaveError>
</ArrayOfSettingsSaveError>