Show full documentation

 Show full documentation

Definition

An interface to migrate route data from a source system or file.

Business Context and Use

The web service interface Manage Route In enables you to connect external applications to your SAP system, and also to create and edit routes within your system. The web service interface Manage Route In is relevant if your company wants to access and manage route data from external applications.

The web service interface Manage Route In offers the operations MaintainBundle and CheckMaintainBundle.

Here is an example of a simple web service request:

 <n0:RouteBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">

 <BasicMessageHeader>
  <ID>00000000000192dcade9bcb0aa000c69</ID>
 </BasicMessageHeader>

 <Route actionCode="01">
  <Name>Bay Area Route</Name>
  <RouteTypeCode>2</RouteTypeCode>
  <RouteCategoryCode>P2D</RouteCategoryCode>
  <LifeCycleStatusCode>1</LifeCycleStatusCode>
  <ProcessingStatusCode>1</ProcessingStatusCode>
  <RouteDayExclusions>
   <MondayIndicator>false</MondayIndicator>
   <TuesdayIndicator>false</TuesdayIndicator>
   <WednesdayIndicator>false</WednesdayIndicator>
   <ThursdayIndicator>false</ThursdayIndicator>
   <FridayIndicator>false</FridayIndicator>
   <SaturdayIndicator>true</SaturdayIndicator>
   <SundayIndicator>true</SundayIndicator>
  </RouteDayExclusions>

  <AutomaticResequencing>true</AutomaticResequencing>  

  <StartDate>2015-12-22</StartDate>
  <DefaultStartTime>15:33:45</DefaultStartTime>
  <DefaultPreparationTime>PT1H</DefaultPreparationTime>
  <DefaultDuration>PT2H</DefaultDuration>
  <TimeZoneCode>PST</TimeZoneCode>
  <Organizer>
   <BusinessPartnerInternalID>MC2471</BusinessPartnerInternalID>
  </Organizer>
  <EmployeeResponsible>
   <BusinessPartnerInternalID>MC2471</BusinessPartnerInternalID>
  </EmployeeResponsible>
  <Attendee actionCode="01">
   <BusinessPartnerInternalID>MC2471</BusinessPartnerInternalID>
  </Attendee>

  <Account actionCode="01">
   <AccountID>MC9785</AccountID>
   <DayNumber>1</DayNumber>
   <VisitDate>2015-12-22</VisitDate>
   <StartTime>15:30:00</StartTime>
   <DriveTime>PT1H</DriveTime>
   <PreparationTime>PT2H</PreparationTime>
   <Duration>PT1H</Duration>
  </Account>

  <Account actionCode="01">
   <AccountID>MC9785</AccountID>
   <DayNumber>2</DayNumber>
   <VisitDate>2015-12-22</VisitDate>
   <StartTime>16:30:00</StartTime>
   <DriveTime>PT1H</DriveTime>
   <PreparationTime>PT2H</PreparationTime>
   <Duration>PT1H</Duration>
  </Account>

 </Route>
</n0:RouteBundleMaintainRequest_sync_V1>

Prerequisites

Existence of referenced business data:

The following business data are only referenced and will not be created by the service operations. They must already exist in the system at the time the web service is called:

Parties:

• Business partners and related projections like customers, employees, and so on

• Organizational centers

Constraints and Integrity Conditions

General Rules for Using this Web Service

Check Maintain Bundle vs. Maintain Bundle

Maintain Bundle operations enable external applications to create and change business document data. Check Maintain Bundle operations enable external applications to simulate maintain bundle requests without changing business document data. In particular, Check Maintain Bundle operations have the following functions:

• Return system messages similar to corresponding maintain bundle operations

• Provide the same message type as the corresponding operation Maintain Bundle

• Do not assign internal numbers from a productive number range interval (number range statuses are not increased)

• Do not change business documents

Action Code

Action codes represent an instruction to the recipient of the web service request to process transmitted message node elements.

Action Code	Description
01	Create; the system returns an error message if the node element already exists.
02	Update; the system returns an error message if the node element does not exist.
03	Delete; the system returns an error message if the node element does not exist.
04	Save; the system creates or changes the node element data.
05	Remove; the system deletes the node element. If the node element does not exist, the system does not send an error message.
06	No Action; the system does not change the node element.

Default action code: 04 (Save).

Note: Action code 04 (Save) creates business documents if the system could not identify a matching target business document. This applies in particular if no business document ID or UUID is provided by the web service consumer. The web service consumer (external application) is responsible for providing correct business document IDs or UUIDs, in order to avoid the accidental creation of duplicate business documents.

List Processing

The processing of node elements with cardinality > 1 (for example a list of parties with a certain party role) can be controlled using List Complete Transmission Indicators (LCTI). The LCTI indicates whether a list of node elements is completely transmitted. The LCTI of a node element with cardinality > 1 is modeled as an attribute of its parent node element (attribute name: <name of child element>ListCompleteTransmissionIndicator).

LCTI	Description
false	The list of node elements is not completely transmitted. Hence, all node elements that are not transmitted remain unchanged. If transmitted node elements in the list can be uniquely identified, the system processes the node elements according to the action code. If transmitted node elements in the list cannot be uniquely identified, the system appends the node element to the corresponding list of node elements in the target business document.
true	The list of elements is completely transmitted. Hence, all node elements that are not transmitted are removed. If no node element is transmitted, the complete list is removed.

Default list complete transmission indicator: false.

Note: The LCTI refers to the completeness of the list of node elements and does not imply completeness of sub-elements.

Empty and Missing Elements

Optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents.

Communication Timeout

Maintain bundle and check maintain bundle operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer is responsible for ensuring reasonable sizes of data for mass operations.

Message Header

Maintain bundle and check maintain bundle operations support exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the BasicMessageHeader node element.

Change State ID

Using change state identifier (element name ChangeStateID), external applications can enforce that a modifying operation is not executed because the state of the business document has changed since the external application last read its data.

The change state ID is an uninterpretable string that is provided by query and read operations. It can be utilized by all modifying operations. If the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. If the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document.

The web service consumer (external application) is responsible for preventing accidental changes to business documents.

Object Node Sender Technical Identifier

Request node elements with cardinality > 1 contain an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message.

The object node sender technical identifiers are provided as ObjectNodeSenderTechnicalID in request message types and are referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types.

If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request is returned as the reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID is returned as initial as well.

Note: The values specified in the ObjectNodeSenderTechnicalID are transient values that establish the correspondence between elements for only a single call. The web service consumer is not required to specify them or to use the same values for different calls. Also, the service provider does not interpret these values at all. Instead, the service provider returns them to the web service consumer in the ReferenceObjectNodeSenderTechnicalID elements.

Note: The ObjectNodeSenderTechnicalID is also used to identify failed business document modifications in a mass operation.

Example

Request:

 
<Child>
    <ObjectNodeSenderTechnicalID>999_A<ObjectNodeSenderTechnicalID>
    <Content>Child A: Some correct content</Content>
</Child>
<Child>
    <ObjectNodeSenderTechnicalID>999_B<ObjectNodeSenderTechnicalID>
    <Content>Child B: Some erroneous content</Content>
</Child>

Response:

 
<Log>
    <Item>
        <ReferenceObjectNodeSenderTechnicalID>999_B </ReferenceObjectNodeSenderTechnicalID>
        <Note>Error message for Child B</Note>
    </Item>
</Log>

Response Message

The structure of the response message consists of two parts:

• A business document-specific part containing information about IDs and UUIDs of the created and changed business documents

• Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation.

Scenarios

Possible scenarios include the following:

• Create Route

The MaintainBundle operation is used to create routes.

• Update Route

The MaintainBundle operation is used to update routes.

Scenario Create

RouteTypeCode = 1 Route Template

RouteTypeCode = 2 Actual Route

Example to create an route:

<n0:RouteBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000192dcade9bcb0aa000c69</ID>
 </BasicMessageHeader>
 <Route actionCode="01">
  <Name>Bay Area Route Create new 2</Name>
  <RouteTypeCode>2</RouteTypeCode>
 </Route>
</n0:RouteBundleMaintainRequest_sync_V1>

Scenario Update

Example to update :

<n0:RouteBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID>00000000000192dcade9bcb0aa000c69</ID>
 </BasicMessageHeader>
 <Route actionCode="02">
  <ID>1212</ID>
  <Name>Bay Area Route Update</Name>
 </Route>
</n0:RouteBundleMaintainRequest_sync_V1>

Example to update a party that has 1:n cardinality

Attention: the party ID and party role are not unique keys for a party instance. Thus, for parties with 1:n cardinality, in case of updates (change + delete), the ListCompleteTransmissionIndicator needs to be set. The whole list of updated parties that should replace the existing list of parties also has to be provided.

 Show full documentation

 Show full documentation

No documentation available.

 Show full documentation

 Show full documentation

No documentation available.