GetArticleMaterials

This function is used to to fetch the article materials for sustainability reporting which have been defined on one or more articles.

Tags: GetArticleMaterials, GetArticleMaterialsQuery, GetArticleMaterialsPaging, GetArticleMaterialsResponse, GetArticleMaterialsResult, ArticleMaterialResult, GetArticleMaterialsErrorResult, ArticleInfo_GetArticleMaterials, ArticleMaterialsSpecification_GetArticleMaterials, ArticleMaterialsEnergySpecification_GetArticleMaterials, ArticleEnvironmentalCertification_GetArticleMaterials, ArticleDefinitionMaterial_GetArticleMaterials, ArticleEnergySource_GetArticleMaterials, ArticleMaterialInfo_GetArticleMaterials, ArticleMaterialUnit_GetArticleMaterials

Request XML

POST /xxx/Service.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/WSI/GetArticleMaterials"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetArticleMaterials xmlns="http://ongoingsystems.se/WSI">
      <GoodsOwnerCode>string</GoodsOwnerCode>
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <ArticleDefIdsToGet>
          <int>int</int>
          <int>int</int>
        </ArticleDefIdsToGet>
        <ArticleNumbersToGet>
          <string>string</string>
          <string>string</string>
        </ArticleNumbersToGet>
        <Paging>
          <MaxArticlesToGet>int</MaxArticlesToGet>
          <ArticleDefIdFrom>int</ArticleDefIdFrom>
        </Paging>
      </Query>
    </GetArticleMaterials>
  </soap:Body>
</soap:Envelope>

Request specification

GetArticleMaterials
GoodsOwnerCode string(400) Req. The name/code of your client
UserName string(50) Req. Your username
Password string(50) Req. Your password
Query GetArticleMaterialsQuery Req. The query object
GetArticleMaterialsQuery
ArticleDefIdsToGet int[] Only return article materials for these particular articles.
ArticleNumbersToGet string[] Only return article materials for these particular article numbers.
Paging GetArticleMaterialsPaging A Paging object
GetArticleMaterialsPaging
MaxArticlesToGet int Max number of article to return in response
ArticleDefIdFrom int

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetArticleMaterialsResponse xmlns="http://ongoingsystems.se/WSI">
      <GetArticleMaterialsResult>
        <Success>boolean</Success>
        <ArticleMaterialResults>
          <ArticleMaterialResult>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
              <ArticleName>string</ArticleName>
              <ProductCode>string</ProductCode>
            </Article>
            <ArticleMaterialsSpecification>
              <ArticleContainsRecycledMaterials>DontKnow or Yes or No</ArticleContainsRecycledMaterials>
              <ArticlePackagingIsRecycleable>DontKnow or Yes or No</ArticlePackagingIsRecycleable>
              <ArticlePackagingContainsRecycledMaterials>DontKnow or Yes or No</ArticlePackagingContainsRecycledMaterials>
              <EnergySpecification>
                <IsUsingEnergyWhileInUse>boolean</IsUsingEnergyWhileInUse>
                <EnergySource>
                  <EnergySourceId>int</EnergySourceId>
                  <EnergySourceCode>string</EnergySourceCode>
                  <EnergySourceName>string</EnergySourceName>
                </EnergySource>
                <EstimatedNumberOfHoursUsingElectricityDuringLifeTime>decimal</EstimatedNumberOfHoursUsingElectricityDuringLifeTime>
                <EstimatedKiloWattHoursUsedPerHour>decimal</EstimatedKiloWattHoursUsedPerHour>
              </EnergySpecification>
              <EnvironmentalCertification>
                <CertificationId>int</CertificationId>
                <CertificationCode>string</CertificationCode>
                <CertificationName>string</CertificationName>
              </EnvironmentalCertification>
              <Materials>
                <ArticleDefinitionMaterial>
                  <Material>
                    <MaterialCode>string</MaterialCode>
                    <MaterialName>string</MaterialName>
                    <IsBattery>boolean</IsBattery>
                  </Material>
                  <MaterialUnit>
                    <MaterialUnitCode>string</MaterialUnitCode>
                    <MaterialUnitName>string</MaterialUnitName>
                  </MaterialUnit>
                  <IsMainMaterial>boolean</IsMainMaterial>
                  <Weight>decimal</Weight>
                  <IsPackaging>boolean</IsPackaging>
                  <IsMainPackagingMaterial>boolean</IsMainPackagingMaterial>
                  <EstimatedNumberOfBatteriesUsedDuringLifeTime>decimal</EstimatedNumberOfBatteriesUsedDuringLifeTime>
                </ArticleDefinitionMaterial>
                <ArticleDefinitionMaterial>
                  <Material>
                    <MaterialCode>string</MaterialCode>
                    <MaterialName>string</MaterialName>
                    <IsBattery>boolean</IsBattery>
                  </Material>
                  <MaterialUnit>
                    <MaterialUnitCode>string</MaterialUnitCode>
                    <MaterialUnitName>string</MaterialUnitName>
                  </MaterialUnit>
                  <IsMainMaterial>boolean</IsMainMaterial>
                  <Weight>decimal</Weight>
                  <IsPackaging>boolean</IsPackaging>
                  <IsMainPackagingMaterial>boolean</IsMainPackagingMaterial>
                  <EstimatedNumberOfBatteriesUsedDuringLifeTime>decimal</EstimatedNumberOfBatteriesUsedDuringLifeTime>
                </ArticleDefinitionMaterial>
              </Materials>
            </ArticleMaterialsSpecification>
          </ArticleMaterialResult>
          <ArticleMaterialResult>
            <Article>
              <ArticleDefId>int</ArticleDefId>
              <ArticleNumber>string</ArticleNumber>
              <ArticleName>string</ArticleName>
              <ProductCode>string</ProductCode>
            </Article>
            <ArticleMaterialsSpecification>
              <ArticleContainsRecycledMaterials>DontKnow or Yes or No</ArticleContainsRecycledMaterials>
              <ArticlePackagingIsRecycleable>DontKnow or Yes or No</ArticlePackagingIsRecycleable>
              <ArticlePackagingContainsRecycledMaterials>DontKnow or Yes or No</ArticlePackagingContainsRecycledMaterials>
              <EnergySpecification>
                <IsUsingEnergyWhileInUse>boolean</IsUsingEnergyWhileInUse>
                <EnergySource>
                  <EnergySourceId>int</EnergySourceId>
                  <EnergySourceCode>string</EnergySourceCode>
                  <EnergySourceName>string</EnergySourceName>
                </EnergySource>
                <EstimatedNumberOfHoursUsingElectricityDuringLifeTime>decimal</EstimatedNumberOfHoursUsingElectricityDuringLifeTime>
                <EstimatedKiloWattHoursUsedPerHour>decimal</EstimatedKiloWattHoursUsedPerHour>
              </EnergySpecification>
              <EnvironmentalCertification>
                <CertificationId>int</CertificationId>
                <CertificationCode>string</CertificationCode>
                <CertificationName>string</CertificationName>
              </EnvironmentalCertification>
              <Materials>
                <ArticleDefinitionMaterial>
                  <Material>
                    <MaterialCode>string</MaterialCode>
                    <MaterialName>string</MaterialName>
                    <IsBattery>boolean</IsBattery>
                  </Material>
                  <MaterialUnit>
                    <MaterialUnitCode>string</MaterialUnitCode>
                    <MaterialUnitName>string</MaterialUnitName>
                  </MaterialUnit>
                  <IsMainMaterial>boolean</IsMainMaterial>
                  <Weight>decimal</Weight>
                  <IsPackaging>boolean</IsPackaging>
                  <IsMainPackagingMaterial>boolean</IsMainPackagingMaterial>
                  <EstimatedNumberOfBatteriesUsedDuringLifeTime>decimal</EstimatedNumberOfBatteriesUsedDuringLifeTime>
                </ArticleDefinitionMaterial>
                <ArticleDefinitionMaterial>
                  <Material>
                    <MaterialCode>string</MaterialCode>
                    <MaterialName>string</MaterialName>
                    <IsBattery>boolean</IsBattery>
                  </Material>
                  <MaterialUnit>
                    <MaterialUnitCode>string</MaterialUnitCode>
                    <MaterialUnitName>string</MaterialUnitName>
                  </MaterialUnit>
                  <IsMainMaterial>boolean</IsMainMaterial>
                  <Weight>decimal</Weight>
                  <IsPackaging>boolean</IsPackaging>
                  <IsMainPackagingMaterial>boolean</IsMainPackagingMaterial>
                  <EstimatedNumberOfBatteriesUsedDuringLifeTime>decimal</EstimatedNumberOfBatteriesUsedDuringLifeTime>
                </ArticleDefinitionMaterial>
              </Materials>
            </ArticleMaterialsSpecification>
          </ArticleMaterialResult>
        </ArticleMaterialResults>
        <Error>
          <ErrorType>Unknown or LogonError or PagingError</ErrorType>
          <Message>string</Message>
        </Error>
      </GetArticleMaterialsResult>
    </GetArticleMaterialsResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetArticleMaterialsResponse
GetArticleMaterialsResult GetArticleMaterialsResult
GetArticleMaterialsResult
Success boolean
ArticleMaterialResults ArticleMaterialResult[] List of articles and associated article materials.
Error GetArticleMaterialsErrorResult An element of type GetArticleMaterialsErrorResult.
ArticleMaterialResult
Article ArticleInfo_GetArticleMaterials Contains information about the article (article number, article name, etc).
ArticleMaterialsSpecification ArticleMaterialsSpecification_GetArticleMaterials Contains information about the materials.
GetArticleMaterialsErrorResult
ErrorType enum An element of type GetArticleMaterialsErrorType.
Message string
ArticleInfo_GetArticleMaterials
ArticleDefId int The id of the article.
ArticleNumber string(100) The article number.
ArticleName string(200) The article number.
ProductCode string(200) The product code.
ArticleMaterialsSpecification_GetArticleMaterials
ArticleContainsRecycledMaterials enum An element of type ArticleMaterialsYesNoDontKnow.
ArticlePackagingIsRecycleable enum An element of type ArticleMaterialsYesNoDontKnow.
ArticlePackagingContainsRecycledMaterials enum An element of type ArticleMaterialsYesNoDontKnow.
EnergySpecification ArticleMaterialsEnergySpecification_GetArticleMaterials An element of type ArticleMaterialsEnergySpecification_GetArticleMaterials.
EnvironmentalCertification ArticleEnvironmentalCertification_GetArticleMaterials An element of type ArticleEnvironmentalCertification_GetArticleMaterials.
Materials ArticleDefinitionMaterial_GetArticleMaterials[]
ArticleMaterialsEnergySpecification_GetArticleMaterials
IsUsingEnergyWhileInUse boolean
EnergySource ArticleEnergySource_GetArticleMaterials An element of type ArticleEnergySource_GetArticleMaterials.
EstimatedNumberOfHoursUsingElectricityDuringLifeTime decimal
EstimatedKiloWattHoursUsedPerHour decimal
ArticleEnvironmentalCertification_GetArticleMaterials
CertificationId int
CertificationCode string
CertificationName string
ArticleDefinitionMaterial_GetArticleMaterials
Material ArticleMaterialInfo_GetArticleMaterials An element of type ArticleMaterialInfo_GetArticleMaterials.
MaterialUnit ArticleMaterialUnit_GetArticleMaterials An element of type ArticleMaterialUnit_GetArticleMaterials.
IsMainMaterial boolean
Weight decimal
IsPackaging boolean
IsMainPackagingMaterial boolean
EstimatedNumberOfBatteriesUsedDuringLifeTime decimal
ArticleEnergySource_GetArticleMaterials
EnergySourceId int
EnergySourceCode string
EnergySourceName string
ArticleMaterialInfo_GetArticleMaterials
MaterialCode string
MaterialName string
IsBattery boolean
ArticleMaterialUnit_GetArticleMaterials
MaterialUnitCode string
MaterialUnitName string