PATCH v1/accounts/{foreignaccountkey}/networks/{foreignkey}/product

Update the Product settings for an AccountNetwork. A typical use is to change one of the properties such as a quota alert

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to create the AccountNetwork on

string

Required

foreignkey

The key of the AccountNetwork

string

Required

Body Parameters

The details (potentially partial) of the updated Product

Product
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

Settings

Collection of Setting

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Settings": [
    {
      "Key": "sample string 1",
      "SettingType": 0,
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "SettingType": 0,
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Description>sample string 2</Description>
  <Name>sample string 1</Name>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/AS.Interfaces.Models">
    <d2p1:Setting>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:SettingType>ipaddress</d2p1:SettingType>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:Setting>
    <d2p1:Setting>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:SettingType>ipaddress</d2p1:SettingType>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:Setting>
  </Settings>
</Product>

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 'Product'.

Response Information

Resource Description

The updated AccountNetwork if found, otherwise a failure result with a 404 error code

PBPRReturnOfProduct
NameDescriptionTypeAdditional information
Data

Product

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "Settings": [
      {
        "Key": "sample string 1",
        "SettingType": 0,
        "Value": "sample string 2"
      },
      {
        "Key": "sample string 1",
        "SettingType": 0,
        "Value": "sample string 2"
      }
    ]
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "Oy18YSk4FWlCcS8nJmx6SA%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfProduct7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>Oy18YSk4FWlCcS8nJmx6SA%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <Description>sample string 2</Description>
    <Name>sample string 1</Name>
    <Settings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AS.Interfaces.Models">
      <d3p1:Setting>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:SettingType>ipaddress</d3p1:SettingType>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:Setting>
      <d3p1:Setting>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:SettingType>ipaddress</d3p1:SettingType>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:Setting>
    </Settings>
  </Data>
</PBPRReturnOfProduct7NMnQmOk>