{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Promotion","type":"basic","slug":"promotion","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"1-0\": \"`background_color`\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`text_color`\",\n    \"2-1\": \"String\",\n    \"3-0\": \"`primary_message`\",\n    \"3-1\": \"String\",\n    \"4-0\": \"`secondary_message`\",\n    \"4-1\": \"String\",\n    \"5-0\": \"`full_message`\",\n    \"5-1\": \"String\",\n    \"6-0\": \"`image_path`\",\n    \"6-1\": \"String\",\n    \"7-0\": \"`image_name`\",\n    \"7-1\": \"String\",\n    \"8-0\": \"`display_code`\",\n    \"8-1\": \"String\",\n    \"9-0\": \"`account_id`\",\n    \"9-1\": \"Integer\",\n    \"10-0\": \"`promotion_type_id`\",\n    \"10-1\": \"Integer\",\n    \"0-2\": \"Referred to as `promotion_id` elsewhere.\",\n    \"1-2\": \"[nullable] The background color (hex string) for the custom colored areas where a Promotion is displayed in the client.\",\n    \"2-2\": \"[nullable] The text color (hex string) on top of the `background_color` for the custom colored areas where a Promotion is displayed in the client.\",\n    \"3-2\": \"A brief (one-line) summary of the Promotion. See the image below and\",\n    \"4-2\": \"A brief (one-line) message to help further explain the `primary_message`.\",\n    \"5-2\": \"A longer message, if necessary, to explain the Promotion.\",\n    \"6-2\": \"The URL path where to find the Promotion's image. This should always be an Amazon Web Services HTTPS path.\\n\\nCombine this with the `image_name` below to get the full image path.\",\n    \"7-2\": \"The name of the image file used for the Promotion.\\n\\nCombine this with the `image_path` above to get the full image path.\",\n    \"8-2\": \"A special code that can help distinguish this Promotion from other promotions the POI might be running at that time.\",\n    \"9-2\": \"The `id` that identifies what Account is running this Promotion. An Account must be created by a POI owner or a Chain owner before a Promotion can be created.\",\n    \"10-2\": \"In the future there will be different types of Promotions that can be run inside of iExit. For right now, there is just a default type of Promotion, and so this value is always 1.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\nBelow shows a Promotion shown in the iExit iOS app.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fkhlSizTR9qB4fFHHVXE_Photo%20Oct%2005,%204%2031%2006%20PM.png\",\n        \"Photo Oct 05, 4 31 06 PM.png\",\n        \"750\",\n        \"1334\",\n        \"\",\n        \"\"\n      ],\n      \"caption\": \"A Promotion as seen in the iExit iOS app. The coupon shown here comes from a Promotion, but the 2 logos above the coupon actually come from a [Logo](doc:logo) child object of the POI.\"\n    }\n  ]\n}\n[/block]\nLook in the table below and you will see Comfort Inn stand out because it has a Promotion. The text in the blue rectangle for Comfort Inn is pulled from the Promotion's `primary_message`.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/otRcQ6dVQDixiGKWFdcj_Photo%20Oct%2005,%204%2036%2035%20PM.png\",\n        \"Photo Oct 05, 4 36 35 PM.png\",\n        \"750\",\n        \"1334\",\n        \"#22b768\",\n        \"\"\n      ],\n      \"caption\": \"Here is a list of all POIs at an Exit in the iExit iOS app. The Comfort Inn POI is running a promotion, and the `promotion`.`primary_message` value is used to quickly summarize the promotion without the user having to click on it.\"\n    }\n  ]\n}\n[/block]","updates":[],"order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"560f055543ea130d00a3622e","__v":4,"githubsync":"","user":"560d5a4faf97231900938125","createdAt":"2015-10-02T22:29:41.536Z","project":"560d5ac71ec45619006069d6","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["560d5ac81ec45619006069da","560dabb698a6ae3700673f9f","560dabe1961d492300d94b4b","560dac2cd10a730d0081ac92","560dacb26660a03700976de4","560ebbffcac9dc0d007af87a"],"_id":"560d5ac71ec45619006069d9","releaseDate":"2015-10-01T16:09:43.711Z","__v":6,"createdAt":"2015-10-01T16:09:43.711Z","project":"560d5ac71ec45619006069d6"},"category":{"sync":{"isSync":false,"url":""},"pages":["560ebc0e54af2b0d005bbf8a","560ebc22c4e4ae0d00b42f97","560ebc3059cb8d0d0015cd61","560efe33de15f60d0018d2ce","560f04a352ef1a0d00c49cb5","560f050552ef1a0d00c49cb7","560f051dde15f60d0018d2dc","560f053752ef1a0d00c49cb9","560f0541de15f60d0018d2de","560f054c9812c10d002729ee","560f055543ea130d00a3622e","560f055ca36c610d00e70154","560f05649812c10d002729f0","56127f8b09bdc51700696fe8","56127f9a436e0b0d00012a19","56a673332ec8310d007bc20f"],"title":"Object Reference","slug":"object-reference","order":9999,"from_sync":false,"reference":false,"_id":"560ebbffcac9dc0d007af87a","project":"560d5ac71ec45619006069d6","createdAt":"2015-10-02T17:16:47.793Z","version":"560d5ac71ec45619006069d9","__v":16},"parentDoc":null}

Documentation

Data Hierarchy

On Highway Functionality

Radius-based Searching

Search Components

Object Reference

Promotion

[block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "1-0": "`background_color`", "1-1": "String", "2-0": "`text_color`", "2-1": "String", "3-0": "`primary_message`", "3-1": "String", "4-0": "`secondary_message`", "4-1": "String", "5-0": "`full_message`", "5-1": "String", "6-0": "`image_path`", "6-1": "String", "7-0": "`image_name`", "7-1": "String", "8-0": "`display_code`", "8-1": "String", "9-0": "`account_id`", "9-1": "Integer", "10-0": "`promotion_type_id`", "10-1": "Integer", "0-2": "Referred to as `promotion_id` elsewhere.", "1-2": "[nullable] The background color (hex string) for the custom colored areas where a Promotion is displayed in the client.", "2-2": "[nullable] The text color (hex string) on top of the `background_color` for the custom colored areas where a Promotion is displayed in the client.", "3-2": "A brief (one-line) summary of the Promotion. See the image below and", "4-2": "A brief (one-line) message to help further explain the `primary_message`.", "5-2": "A longer message, if necessary, to explain the Promotion.", "6-2": "The URL path where to find the Promotion's image. This should always be an Amazon Web Services HTTPS path.\n\nCombine this with the `image_name` below to get the full image path.", "7-2": "The name of the image file used for the Promotion.\n\nCombine this with the `image_path` above to get the full image path.", "8-2": "A special code that can help distinguish this Promotion from other promotions the POI might be running at that time.", "9-2": "The `id` that identifies what Account is running this Promotion. An Account must be created by a POI owner or a Chain owner before a Promotion can be created.", "10-2": "In the future there will be different types of Promotions that can be run inside of iExit. For right now, there is just a default type of Promotion, and so this value is always 1." }, "cols": 3, "rows": 11 } [/block] Below shows a Promotion shown in the iExit iOS app. [block:image] { "images": [ { "image": [ "https://files.readme.io/fkhlSizTR9qB4fFHHVXE_Photo%20Oct%2005,%204%2031%2006%20PM.png", "Photo Oct 05, 4 31 06 PM.png", "750", "1334", "", "" ], "caption": "A Promotion as seen in the iExit iOS app. The coupon shown here comes from a Promotion, but the 2 logos above the coupon actually come from a [Logo](doc:logo) child object of the POI." } ] } [/block] Look in the table below and you will see Comfort Inn stand out because it has a Promotion. The text in the blue rectangle for Comfort Inn is pulled from the Promotion's `primary_message`. [block:image] { "images": [ { "image": [ "https://files.readme.io/otRcQ6dVQDixiGKWFdcj_Photo%20Oct%2005,%204%2036%2035%20PM.png", "Photo Oct 05, 4 36 35 PM.png", "750", "1334", "#22b768", "" ], "caption": "Here is a list of all POIs at an Exit in the iExit iOS app. The Comfort Inn POI is running a promotion, and the `promotion`.`primary_message` value is used to quickly summarize the promotion without the user having to click on it." } ] } [/block]