Apple override and contest details object definitions and links to validations

Properties

Parent	Name	Type	Input
$.	overrideDetails	object
overrideDetails	code	string
overrideDetails	message	string
overrideDetails	fields[]	array
$.	contestDetails	object

Contest Details

When provided by a partner, contestDetails has the following properties:

Parent	Name	Type	Input
contestDetails	value	object
contestDetails	imageId	string
contestDetails	reason	string

Image ID

imageId references the Apple-generated identifier for the uploaded image or document. imageId is an Apple-generated image ID obtained from the media API.

Reason

reason captures free-text input.

Fields

fields[] has the following properties:

Parent	Name	Type	Input
fields[]	field	string
fields[]	value	object

Field

field defines the JSONPath expression identifying the target value within the resource.

Value

value is a container for data. The value of this field is context-dependent and MUST adhere to the rules that define the property within the relevant resource type.

Resource Type	Property
Location	Display Names
Location	Location Status
Location	Opening Hours
Location	Service Hours
Location	Special Hours

JSON Data Samples

Uncontested Apple Override

{
  "overrideDetails": {
    "code": "APPLE_OVERRIDE__LOCATION_STATUS",
    "message": "Place card will display different location status",
    "fields": [
      {
        "field": "$.locationDetails.locationStatus",
        "value": {
          "locationStatus": [
            {
              "status": "OPEN"
            }
          ]
        }
      }
    ]
  },
  "overrideStatus": "PENDING_USER_ACTION"
}

Contested Apple Override

{
  "overrideDetails": {
    "code": "APPLE_OVERRIDE__LOCATION_NAME",
    "message": "Place card will display different name for your location",
    "fields": [
      {
        "field": "$.locationDetails.displayNames",
        "value": {
          "displayNames": [
            {
              "name": "Ben Hill Griffin Stadium",
              "locale": "en",
              "primary": true
            }
          ]
        }
      }
    ]
  },
  "contestDetails": {
    "value": {
      "displayNames": [
        {
          "name": "Florida Field",
          "locale": "en",
          "primary": true
        },
        {
          "name": "The Swamp",
          "locale": "en",
          "primary": false
        }
      ]
    },
    "reason": "'Florida Field' is our preferred name for the venue. This is what should be shown on Apple Maps"
  },
  "overrideStatus": "SUBMITTED"
}

Related

Name	Reference
API	Link