Net3 API Interface for Customer Portal

<back to all web services

UpdateBackupCustomerOfferingItem

Update Backup Customer Offering Item

Requires Authentication
The following routes are available for this service:
PUT/backup/backupcustomer/OfferingItem
UpdateBackupCustomerOfferingItem Parameters:
NameParameterData TypeRequiredDescription
locationbodystringNoURL for underlying backup system
uuidbodystringNoUUID of Backup Customer
updateOfferingItemsbodyUpdateOfferingItemsNoOffering Item to Update
environmentbodyN3TEnvironmentNoEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
UpdateOfferingItems Parameters:
NameParameterData TypeRequiredDescription
offering_itemsformList<UpdateOfferingItem>No
check_usageformboolNo
UpdateOfferingItem Parameters:
NameParameterData TypeRequiredDescription
usage_nameformstringNo
typeformstringNo
lockedformbool?No
measurement_unitformstringNo
infra_idformstringNo
deleted_atformObjectNo
editionformstringNo
application_idformstringNo
updated_atformDateTime?No
statusformintNo
nameformstringNo
tenant_idformstringNo
quotaformQuotaNo
Quota Parameters:
NameParameterData TypeRequiredDescription
versionformlongNo
overageformlong?No
valueformlong?No
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
UpdateBackupCustomerOfferingItemResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<OfferingItemSuccess>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo
OfferingItemSuccess Parameters:
NameParameterData TypeRequiredDescription
itemsformList<SuccessItem>No
timestampformDateTimeNo
SuccessItem Parameters:
NameParameterData TypeRequiredDescription
measurement_unitformstringNo
usage_nameformstringNo
application_idformstringNo
tenant_idformstringNo
updated_atformDateTimeNo
deleted_atformObjectNo
typeformstringNo
editionformstringNo
nameformstringNo
lockedformbool?No
statusformintNo
quotaformQuotaNo
infra_idformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /backup/backupcustomer/OfferingItem HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBackupCustomerOfferingItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <environment>DEV</environment>
  <location>String</location>
  <updateOfferingItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.BackupCustomer.Backup">
    <d2p1:check_usage>false</d2p1:check_usage>
    <d2p1:offering_items>
      <d2p1:UpdateOfferingItem>
        <d2p1:application_id>String</d2p1:application_id>
        <d2p1:deleted_at />
        <d2p1:edition>String</d2p1:edition>
        <d2p1:infra_id>String</d2p1:infra_id>
        <d2p1:locked>false</d2p1:locked>
        <d2p1:measurement_unit>String</d2p1:measurement_unit>
        <d2p1:name>String</d2p1:name>
        <d2p1:quota>
          <d2p1:overage>0</d2p1:overage>
          <d2p1:value>0</d2p1:value>
          <d2p1:version>0</d2p1:version>
        </d2p1:quota>
        <d2p1:status>0</d2p1:status>
        <d2p1:tenant_id>String</d2p1:tenant_id>
        <d2p1:type>String</d2p1:type>
        <d2p1:updated_at>0001-01-01T00:00:00</d2p1:updated_at>
        <d2p1:usage_name>String</d2p1:usage_name>
      </d2p1:UpdateOfferingItem>
    </d2p1:offering_items>
  </updateOfferingItems>
  <uuid>String</uuid>
</UpdateBackupCustomerOfferingItem>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateBackupCustomerOfferingItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Common">
    <d2p1:Exception xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL i:nil="true" xmlns="" />
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">-2146233088</HResult>
      <Source i:nil="true" xmlns="" />
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:HasError>false</d2p1:HasError>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:Result xmlns:d3p1="http://schemas.datacontract.org/2004/07/N3TEntities.BackupCustomer.Backup">
      <d3p1:items>
        <d3p1:SuccessItem>
          <d3p1:application_id>String</d3p1:application_id>
          <d3p1:deleted_at />
          <d3p1:edition>String</d3p1:edition>
          <d3p1:infra_id>String</d3p1:infra_id>
          <d3p1:locked>false</d3p1:locked>
          <d3p1:measurement_unit>String</d3p1:measurement_unit>
          <d3p1:name>String</d3p1:name>
          <d3p1:quota>
            <d3p1:overage>0</d3p1:overage>
            <d3p1:value>0</d3p1:value>
            <d3p1:version>0</d3p1:version>
          </d3p1:quota>
          <d3p1:status>0</d3p1:status>
          <d3p1:tenant_id>String</d3p1:tenant_id>
          <d3p1:type>String</d3p1:type>
          <d3p1:updated_at>0001-01-01T00:00:00</d3p1:updated_at>
          <d3p1:usage_name>String</d3p1:usage_name>
        </d3p1:SuccessItem>
      </d3p1:items>
      <d3p1:timestamp>0001-01-01T00:00:00</d3p1:timestamp>
    </d2p1:Result>
  </Result>
</UpdateBackupCustomerOfferingItemResponse>