PUT GeneralOptions

Updates a the value of a GeneralOption, by its key and subaccount Id.


Parameters

NameDescriptionAdditional information
request
The GeneralOption

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "SubAccountId": 1,
  "Key": "sample string 2",
  "Value": "sample string 3",
  "PostKey": "sample string 4",
  "IsGlobal": true
}

application/xml, text/xml

Sample:
<GeneralOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types">
  <IsGlobal>true</IsGlobal>
  <Key>sample string 2</Key>
  <PostKey>sample string 4</PostKey>
  <SubAccountId>1</SubAccountId>
  <Value>sample string 3</Value>
</GeneralOption>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response body formats

A GeneralOptionResponse, containing the updated GeneralOption.

application/json, text/json

Sample:
{
  "Item": {
    "SubAccountId": 1,
    "Key": "sample string 2",
    "Value": "sample string 3",
    "PostKey": "sample string 4",
    "IsGlobal": true
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GeneralOptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:IsGlobal>true</d2p1:IsGlobal>
    <d2p1:Key>sample string 2</d2p1:Key>
    <d2p1:PostKey>sample string 4</d2p1:PostKey>
    <d2p1:SubAccountId>1</d2p1:SubAccountId>
    <d2p1:Value>sample string 3</d2p1:Value>
  </Item>
</GeneralOptionResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body