AVB LINQ Public API

<back to all web services

ProductAliasRequest

Product Aliases
The following routes are available for this service:
POST/productaliasesCreates a new Product Alias
PUT/productaliasesUpdates and existing Product Alias
GET/productaliases/{productAliasId}Gets a Product Alias by Id
DELETE/productaliases/{productAliasId}Deletes a Product Alias by Id
ProductAlias Parameters:
NameParameterData TypeRequiredDescription
ProductAliasIdformintNo
ProductIdformintNo
AccountIdformintNo
AliasformstringNo
ProductAliasResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProductAliasesformList<ProductAlias>No

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.

POST /productaliases HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProductAliasRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.DTO">
  <AccountId xmlns="http://schemas.datacontract.org/2004/07/Avb.Linq.Data.Models">0</AccountId>
  <Alias xmlns="http://schemas.datacontract.org/2004/07/Avb.Linq.Data.Models">String</Alias>
  <ProductAliasId xmlns="http://schemas.datacontract.org/2004/07/Avb.Linq.Data.Models">0</ProductAliasId>
  <ProductId xmlns="http://schemas.datacontract.org/2004/07/Avb.Linq.Data.Models">0</ProductId>
</ProductAliasRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductAliasResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.DTO">
  <ProductAliases xmlns:d2p1="http://schemas.datacontract.org/2004/07/Avb.Linq.Data.Models">
    <d2p1:ProductAlias>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:Alias>String</d2p1:Alias>
      <d2p1:ProductAliasId>0</d2p1:ProductAliasId>
      <d2p1:ProductId>0</d2p1:ProductId>
    </d2p1:ProductAlias>
  </ProductAliases>
  <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>
</ProductAliasResponse>