| Description | Query Registered Products |
| Name | QueryRegisteredProductIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Product Data Maintenance |
| Process Component Name | ProductDataMaintenance |
| Process Component Namespace | http://sap.com/xi/AP/FO/Product/Global |
| Deploymnent Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to query registered products.
The web service interface Query Registered Product In enables you to connect external applications to your SAP system and to query and read registered products within your system. The web service interface Query Registered Product In is relevant if your company wants to access and manage registered products from external applications.
The web service interface Query Registered Product In offers the operation Find By Serial Number Identification.
Below is an example of a web service request to query for active registered products of a reference product. The result is limited to 100 records and shall contain address information. Description, detailed description and attachment information shall not be returned:
Example
<n0:RegisteredProductBySerialNumberIdentificationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <RegisteredProductSelectionBySerialNumberIdentification> <SelectionByLifeCycleStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryCode>2</LowerBoundaryCode> </SelectionByLifeCycleStatusCode> <SelectionByReferenceProductID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>XCF-0001</LowerBoundaryIdentifier> <UpperBoundaryIdentifier></UpperBoundaryIdentifier> </SelectionByReferenceProductID> </RegisteredProductSelectionBySerialNumberIdentification> <ProcessingConditions> <QueryHitsMaximumNumberValue>100</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements registeredProductTransmissionRequestCode="2"> <RegisteredProduct addressInformationTransmissionRequestCode="1" descriptionTransmissionRequestCode="4" detailedDescriptionTransmissionRequestCode="4" attachmentFolderTransmissionRequestCode="4"> </RegisteredProduct> </RequestedElements> </n0:RegisteredProductBySerialNumberIdentificationQuery_sync>
Technical Prerequisites:
This web service must be activated within a communication arrangement maintained for the scenario Query registered products.
Other Prerequisites:
Registered products should exist in the system in order to get a positive result.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
All data (complete response):
Expected result:
Show full documentation
Show full documentation
<RegisteredProduct>
<full response... />
</RegisteredProduct>
Request:
<RequestedElements registeredProductTransmissionRequestCode="1">
or (default is '1')
<RequestedElements />
or just omit it (default is all)
... empty ...
Return everything except address information:
Expected result:
<RegisteredProduct> <all... except address information node /> </RegisteredProduct>
Request:
<RequestedElements registeredProductTransmissionRequestCode="2">
<RegisteredProduct addressInformationTransmissionRequestCode="4" />
</RequestedElements>
Return registered product general data, descriptions and detailed descriptions:
Expected result:
<RegisteredProduct> <ChangeStateID>...</ChangeStateID> <SerialID>TEST_1</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <etc./> <Description> <Description languageCode="EN">...</Description> </Description> <Description> <Description languageCode="DE">...</Description> </Description> <etc./> <DetailedDescription> <Text languageCode="DE">...</Text> </DetailedDescription> <Text languageCode="EN">...</Text> <etc./> </DetailedDescription> </RegisteredProduct>
Request:
<RequestedElements registeredProductTransmissionRequestCode="2"> <RegisteredProduct addressInformationTransmissionRequestCode="4" descriptionTransmissionRequestCode="1" detailedDescriptionTransmissionRequestCode="1" attachmentFolderTransmissionRequestCode="4"/> </RequestedElements>
In the following example, the consumer wants to unblock all registered products of a specific reference product, which are registered at a customer.
First, all blocked registered products for the reference product need to be queried, using the Query Registered Product In service interface. From the result, the registered products of the certain customer have to be extracted. Afterwards, the Manage Registered Product In service interface is used to set the status to Active.
Step 1: Query registered products by status and reference product
Request:
<n0:RegisteredProductBySerialNumberIdentificationQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <RegisteredProductSelectionBySerialNumberIdentification> <SelectionByLifeCycleStatusCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryCode>3</LowerBoundaryCode> <!-- blocked for service processes --> </SelectionByLifeCycleStatusCode> <SelectionByReferenceProductID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>XCF-0001</LowerBoundaryIdentifier> </SelectionByReferenceProductID> </RegisteredProductSelectionBySerialNumberIdentification> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements registeredProductTransmissionRequestCode="2"> </RequestedElements> </n0:RegisteredProductBySerialNumberIdentificationQuery_sync>
Note: The Customer ID appears as CustodianBusinessPartnerInternalID in the service interface.
Response:
<nm:RegisteredProductBySerialNumberIdentificationResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global"> <RegisteredProduct> <ChangeStateID> 20121008134359.0589200</ChangeStateID> <SerialID>XY124</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <SystemAdministrativeData> <CreationDateTime>2011-10-05T07:44:24.669107Z</CreationDateTime> <CreationIdentityUUID>00163e02-8b2e-1ee1-bb8b-f8dbb5e350b5</CreationIdentityUUID> <LastChangeDateTime>2011-20-05T07:46:10.123107Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-8b32-1ed2-90db-9872adc40056</LastChangeIdentityUUID> </SystemAdministrativeData> <LifeCycleStatusCode>3</LifeCycleStatusCode> <PurchaseDateTime timeZoneCode="UTC" daylightSavingTimeIndicator="false">2011-10-05T00:00:00</PurchaseDateTime> <CustodianBusinessPartnerInternalID>XC6049</CustodianBusinessPartnerInternalID> <CustodianMainContactBusinessPartnerInternalID>XCP6049</CustodianMainContactBusinessPartnerInternalID> </RegisteredProduct> <RegisteredProduct> <ChangeStateID> 20121122105734.9117910</ChangeStateID> <SerialID>XY2011_01</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <SystemAdministrativeData> <CreationDateTime>2012-11-20T09:52:06.186986Z</CreationDateTime> <CreationIdentityUUID>00163e02-8b32-1ed2-90db-9872adc40057</CreationIdentityUUID> <LastChangeDateTime>2012-11-22T10:57:34.911791Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-8b32-1ed2-90db-9872adc40058</LastChangeIdentityUUID> </SystemAdministrativeData> <LifeCycleStatusCode>3</LifeCycleStatusCode> <PurchaseDateTime timeZoneCode="CET" daylightSavingTimeIndicator="false">2012-11-02T12:10:50</PurchaseDateTime> <CustodianBusinessPartnerInternalID>XC9785</CustodianBusinessPartnerInternalID> <CustodianMainContactBusinessPartnerInternalID>XCP6049</CustodianMainContactBusinessPartnerInternalID> <OwnerBusinessPartnerInternalID>XC9786</OwnerBusinessPartnerInternalID> </RegisteredProduct> <RegisteredProduct> <ChangeStateID> 20121126122617.8315320</ChangeStateID> <SerialID>XY_2611</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <SystemAdministrativeData> <CreationDateTime>2012-11-26T10:03:36.024918Z</CreationDateTime> <CreationIdentityUUID>00163e02-33f4-1ee1-81aa-311337acd275</CreationIdentityUUID> <LastChangeDateTime>2012-11-26T12:24:03.936078Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-33f4-1ee1-81aa-311337acd275</LastChangeIdentityUUID> </SystemAdministrativeData> <LifeCycleStatusCode>3</LifeCycleStatusCode> <PurchaseDateTime timeZoneCode="CET" daylightSavingTimeIndicator="false">2012-11-02T12:10:50</PurchaseDateTime> <CustodianBusinessPartnerInternalID>XC6049</CustodianBusinessPartnerInternalID> <CustodianMainContactBusinessPartnerInternalID>XCP6049</CustodianMainContactBusinessPartnerInternalID> <OwnerBusinessPartnerInternalID>XC6049</OwnerBusinessPartnerInternalID> </RegisteredProduct> <RegisteredProduct> <ChangeStateID> 20121210153401.5477000</ChangeStateID> <SerialID>XY_1</SerialID> <ReferenceProductMaterialID>MCF-0001</ReferenceProductMaterialID> <SystemAdministrativeData> <CreationDateTime>2012-12-10T15:34:01.5477Z</CreationDateTime> <CreationIdentityUUID>00163e02-33f4-1ee1-81aa-311337acd275</CreationIdentityUUID> <LastChangeDateTime>2012-12-10T15:34:01.5477Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e02-33f4-1ee1-81aa-311337acd275</LastChangeIdentityUUID> </SystemAdministrativeData> <LifeCycleStatusCode>3</LifeCycleStatusCode> <PurchaseDateTime timeZoneCode="CET" daylightSavingTimeIndicator="false">2012-01-02T11:10:50</PurchaseDateTime> <CustodianBusinessPartnerInternalID>XC9785</CustodianBusinessPartnerInternalID> <CustodianMainContactBusinessPartnerInternalID>XCP9785</CustodianMainContactBusinessPartnerInternalID> <OwnerBusinessPartnerInternalID>XC9785</OwnerBusinessPartnerInternalID> </RegisteredProduct> <ProcessingConditions> <ReturnedQueryHitsNumberValue>4</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E028B341EE28DF61140978AA293</LastReturnedObjectID> </ProcessingConditions> </nm:RegisteredProductBySerialNumberIdentificationResponse_sync>
In the example, four registered products have been found, two of which are installed at customer XC6049, and two at XC9785.
Step 2: Unblock the registered products installed at customer XC9785
Request:
<n0:RegisteredProductBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <RegisteredProduct actionCode="02"> <ObjectNodeSenderTechnicalID>one</ObjectNodeSenderTechnicalID> <ChangeStateID> 20121122105734.9117910</ChangeStateID> <SerialID>XY2011_01</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <LifeCycleStatusCode>2</LifeCycleStatusCode> </RegisteredProduct> <RegisteredProduct actionCode="02"> <ObjectNodeSenderTechnicalID>two</ObjectNodeSenderTechnicalID> <ChangeStateID> 20121210153401.5477000</ChangeStateID> <SerialID>XY_1</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> <LifeCycleStatusCode>2</LifeCycleStatusCode> </RegisteredProduct> </n0:RegisteredProductBundleMaintainRequest_sync>
Response:
<nm:RegisteredProductBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global"> <RegisteredProduct> <ReferenceObjectNodeSenderTechnicalID>two</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID> 20121210153401.5477000</ChangeStateID> <SerialID>XY_1</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> </RegisteredProduct> <RegisteredProduct> <ReferenceObjectNodeSenderTechnicalID>one</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID> 20121122105734.9117910</ChangeStateID> <SerialID>XY2011_01</SerialID> <ReferenceProductMaterialID>XCF-0001</ReferenceProductMaterialID> </RegisteredProduct> <Log/> </nm:RegisteredProductBundleMaintainConfirmation_sync>
Note: Changing the status has not changed the change state ID.
| Description | Find registered products by serial number identification |
| Name | FindBySerialNumberIdentification |
| Synchronous | yes |
| Release Status | Deprecated |
To find registered products by serial number identification.
This operation is used to query registered product data by serial number identification. The request message of the FindBySerialNumberIdentification operation contains the RegisteredProductSelectionBySerialNumberIdentification node with the possible selection parameters.
This node groups all selection parameters. The selection parameters are as follows:
| Selection Parameter | Remark |
|---|---|
| SelectionByLifeCycleStatusCode | Selection by status |
| SelectionBySerialID | Selection by serial ID ( also called Serial number or Registered product ID) |
| SelectionByReferenceProductID | Selection by the product ID, to which the registered product belongs |
| SelectionByCustodianPartyID | Selection by customer ID |
| SelectionBySearchText | Selection by search text (Basic Search) |
The response contains the list of registered products found, and the processing conditions (like ReturnedQueryHitsNumberValue, MoreHitsAvailableIndicator and LastReturnedObjectID).
The service consumer can specify which node elements are delivered (see interface documentation, section “Requested Elements”).
In this node, all found registered products are contained, including their basic data according to the RequestedElements provided in the query request. This includes the ChangeStateID that may be needed for subsequent change requests using web services as well.
| For this web service the change state ID only applies to the OwnerBusinessPartnerInternalID element and the AddressInformation node element. |
The date time elements in the system administrative data are provided as UTC timestamps in the format CCYY-MM-DDThh:mm:ss.ffffffZ .
The part ffffff stands for fractions of seconds.
Example
<CreationDateTime>2012-11-12T16:23:23.495989Z</CreationDateTime> <LastChangeDateTime>2012-11-13T17:10:10.123654Z</LastChangeDateTime>
The lifecycle status code can occur with the following values:
| Status Code | Description |
|---|---|
| 1 | In Preparation |
| 2 | Active |
| 3 | Blocked |
The Purchase Date Time element is returned as local date time with time zone and daylight saving indicator in the format CCYY-MM-DDThh:mm:ss .
Note: On the UI, the Date part of the Purchase Date Time element is displayed as Reference Date.
Example
<PurchaseDateTime timeZoneCode="CET" daylightSavingTimeIndicator="false">2012-11-02T12:10:50</PurchaseDateTime>
Custodian and Owner party information is returned as business partner internal IDs of length 10, as displayed in the UI.
Note: The Custodian is displayed as Customer, the Custodian Main Contact is displayed as Contact in the UI.
Example
<CustodianBusinessPartnerInternalID>XC6049</CustodianBusinessPartnerInternalID> <CustodianMainContactBusinessPartnerInternalID>XCP6049</CustodianMainContactBusinessPartnerInternalID> <OwnerBusinessPartnerInternalID>XC9785</OwnerBusinessPartnerInternalID>
The Address Information node element specifies the location of the installation point of the registered product.
It contains a variety of address attributes, however only the attributes of the Postal Address element are available on the UI and returned in the response.
Example
<AddressInformation>
<TypeCode>1</TypeCode>
<ID>ADGEN100163E028B121ED28BFF9AC970B2560B</ID>
<PostalAddress>
<CountryCode>DE</CountryCode>
<RegionCode listID="DE">08</RegionCode>
<CityName>Walldorf</CityName>
<StreetPostalCode>69190</StreetPostalCode>
<POBoxPostalCode>69185</POBoxPostalCode>
<StreetName>Dietmar-Hopp-Allee</StreetName>
<HouseID>16</HouseID>
<BuildingID>987</BuildingID>
<RoomID>X5.01</RoomID>
<FloorID>5</FloorID>
<CareOfName>Whoever</CareOfName>
<POBoxID>12345</POBoxID>
<POBoxIndicator>true</POBoxIndicator>
<TimeZoneCode>CET</TimeZoneCode>
</PostalAddress>
<FormattedAddress>
<FormattedAddressDescription>Dietmar-Hopp-Allee 16 / 69190 Walldorf / DE</FormattedAddressDescription>
<FormattedPostalAddressDescription>Dietmar-Hopp-Allee 16 / 69190 Walldorf / DE</FormattedPostalAddressDescription>
<FormattedNameAndCityAddressDescription>69190 Walldorf / DE</FormattedNameAndCityAddressDescription>
<FormattedAddress>
<FirstLineDescription>Whoever</FirstLineDescription>
<SecondLineDescription>Dietmar-Hopp-Allee 16</SecondLineDescription>
<ThirdLineDescription>69190 Walldorf</ThirdLineDescription>
<FourthLineDescription>Germany</FourthLineDescription>
</FormattedAddress>
<FormattedPostalAddress>
<FirstLineDescription>Dietmar-Hopp-Allee 16</FirstLineDescription>
<SecondLineDescription>69190 Walldorf</SecondLineDescription>
<ThirdLineDescription>Germany</ThirdLineDescription>
</FormattedPostalAddress>
</FormattedAddress>
</AddressInformation>
In the Description node element, the description of the registered product is returned in all languages available.
Example
<Description> <Description languageCode="EN">English Description</Description> </Description> <Description> <Description languageCode="DE">Deutsche Beschreibung</Description> </Description>
The Detailed Description node element contains the detailed descriptions in the available languages.
Note: In the UI, the detailed description in the logon language is displayed in the Notes section.
Example
<DetailedDescription> <Text languageCode="DE">deutsche Detailbeschreibung</Text> </DetailedDescription> <DetailedDescription> <Text languageCode="EN">english detailed description</Text> </DetailedDescription>
The Attachment Folder node element returns information on links and documents attached to the registered product.
Note: The binary document content is not returned using this web service. Either the file content URI can be used to access the document, or another web service has to be used.
The CategoryCode element indicates whether a document is a folder, link, or file:
| Category Code | Description |
|---|---|
| 1 | File |
| 2 | Document |
| 3 | Link |
In this context, values 2 (Document) and 3 (Link) are used.
Example
<CategoryCode>3</CategoryCode>
The TypeCode element can contain the following values:
| Type Code | Description |
|---|---|
| 10001 | Standard Attachment |
| 10011 | Product Image |
| 10015 | Technical Drawing |
| 10018 | Product Specification |
Example: Document information of a standard attachment
<AttachmentFolder>
<UUID>00163e02-8b12-1ed2-8bff-9ac970add60b</UUID>
<Document>
<UUID>00163e02-8b12-1ed2-8bff-9ac970aeb60b</UUID>
<VersionID>0</VersionID>
<SystemAdministrativeData>
<CreationDateTime>2012-11-16T14:49:35.232901Z</CreationDateTime>
<CreationIdentityUUID>00163e02-33f4-1ee1-81aa-311337aab123</CreationIdentityUUID>
<LastChangeDateTime>2012-11-16T14:49:35.232901Z</LastChangeDateTime>
<LastChangeIdentityUUID>00163e02-33f4-1ee1-81aa-311337aab123</LastChangeIdentityUUID>
</SystemAdministrativeData>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<TypeCode>10001</TypeCode>
<MIMECode>text/plain</MIMECode>
<PathName>/BOAttachments/00163E028B121ED28BFF9AC970ADD60B/attachment_test.txt</PathName>
<Name>attachment_test.txt</Name>
<AlternativeName>attachment_test.txt</AlternativeName>
<Description>my attachment</Description>
<FileContentURI>http://servername.domain:12345/sap/ap/ds/wd/doc/00163E028B121ED28BFF9AC970AEB60B/attachment_test.txt?sap-client=004</FileContentURI>
<FilesizeMeasure unitCode="AD">23.0</FilesizeMeasure>
</Document>
</AttachmentFolder>
Example: Link information of a standard attachment
<AttachmentFolder>
<UUID>00163e02-8b32-1ed2-90dd-8662926d6477</UUID>
<Document>
<UUID>00163e02-8b32-1ed2-90dd-8662926e4477</UUID>
<VersionID>0</VersionID>
<SystemAdministrativeData>
<CreationDateTime>2012-12-10T17:08:21.575777Z</CreationDateTime>
<CreationIdentityUUID>00163e02-33f4-1ee1-81aa-311337aac123</CreationIdentityUUID>
<LastChangeDateTime>2012-12-10T17:08:21.575777Z</LastChangeDateTime>
<LastChangeIdentityUUID>00163e02-33f4-1ee1-81aa-311337aac123</LastChangeIdentityUUID>
</SystemAdministrativeData>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<PathName>/BOAttachments/00163E028B321ED290DD8662926D6477/link_test.txt</PathName>
<Name>link_test.txt</Name>
<AlternativeName>link_test.txt</AlternativeName>
<Description>Home page</Description>
<ExternalLinkWebURI>http://sap.com/anyURI</ExternalLinkWebURI>
<FileContentURI>http://sap.com/anyURI</FileContentURI>
</Document>
</AttachmentFolder>