Accept Apple override processes for display names (Sensitive Field)

Accept Apple Override

Description

Accept an Apple Maps override.

Read Notification/Feedback

1. Periodically API user requests notifications or "listens" for events pushed to a push endpoint (webhook).
2. Notification indicates availability of MAPS_DISPLAY feedback.
3. API user requests feedback (Subflows: Filter Feedback).
   

Sequence Diagram

Apple Maps Process

1. Apple Maps determines that a value displayed on a location place card requires an edit.
2. After saving the edit, "override protection" is added to the field.
3. System determines that override protection was added to a field provided by an Apple Business user.
4. MAPS_DISPLAY notification, feedback, and webhook event messages are generated for location resource.

API User Process

1. API user reads notification/feedback
2. API user requests to accept the Apple override value
3. If no exceptions 200 OK is returned.
4. System updates the location resource and a new version (etag) is generated.

Post-conditions

• Removal of the override protection is scheduled.
• Apple override resource status is updated to ACCEPTED.
• Location resource state is updated to PUBLISHED.
• Notification, feedback, and webhook event messages are generated for location resource.
  

Sequence Diagram

Update Location with Apple Override

Description

Update a location and include in the request a value matching location's feedback value.

Note: Location's associated brand metadata does not list OVERRIDE__LOCATION_PRIMARY_DISPLAY_NAME.

Apple Maps Process

Same process

API User Process

1. API user reads notification/feedback.
2. API user requests to update the location resource. Included in the request is a value matching the feedback value.
3. System validates API request.
4. System synchronously validates data.
5. If no exceptions, then 200 OK is returned.
6. System asynchronously validates data.
7. If no exceptions, then feedback is not generated.

Post-conditions

• Removal of the override protection is scheduled.
• Location resource state is updated to PUBLISHED.
• Notifications, feedback, and webhook event messages are generated for location resource.
  .

Sequence Diagram

Subflows

Filter Feedback

1. Check feedback has only one instance of the same code name.
2. If more than one instance is present, then filter to the code name with the most current timestamp.

tip

Once a partner is capable of processing Apple override feedback, perform a fetch for codes up to the date when Apple Business began making them available to you. Check for the existence of feedback code(s) and process the most current one. Thereafter, feedback should be fetched on a regular basis using a createdDate query parameter which leaves no time interval during which you may miss feedback about an override.

Any attempt to accept or contest an Apple override which is not current will return 500 Internal Server Error and code AppleOverrideNotInContestableState

Apple Override Already Accepted

If API user has already accepted the override, then an error code is triggered.