Skip to main content

Menu Update Manager Setup

Set up Menu Update Manager (MUM) for Digital Menu Board/Menu Engine (DMB/ME) integration.

Add Company to Menu Update Manager 

To add a new company to Menu Update Manager—and also add the company ID to mongo, use the following request:

curl --location --request POST '{{xmum_endpoint_from_ssr}}/preferences/delivery-companies' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'\
--header 'Content-Type: application/json' \
--data-raw '{
    "company_id": "{{company_id}}",
    "dm_update_check_period_minutes": 5
}'

Additional Requests

Check if company is already added to preferences:

curl --location --request GET '{{xmum_endpoint_from_ssr}}/preferences' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'

GET request to view only companies information:

curl --location --request GET '{{xmum_endpoint_from_ssr}}/preferences/delivery-companies' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'

Check if company was successfully added to preferences:

curl --location --request GET '{{xmum_endpoint_from_ssr}}/preferences/delivery-companies/{{company_id}}' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'

PUT request to update company information:

Note

DM_UPDATE_CHECK_PERIOD_MINUTES specifies the time period (in minutes) at which the service performs an update check.

curl --location --request PUT '{{xmum_endpoint_from_ssr}}/preferences/delivery-companies/{{company_id}}' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'\
--header 'Content-Type: application/json' \
--data-raw '{
"dm_update_check_period_minutes": 10
}'

Delete company from preferences:

curl --location --request DELETE '{{xmum_endpoint_from_ssr}}/preferences/delivery-companies/{{company_id}}' \
--header 'Accept: */*' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Authorization: Bearer {{integrator_token}}'\

Menu Update Manager Endpoints

Endpoints for Menu Update Monitor.

Stack

Endpoint

QA

https://qa-xmum.xenial.com/preferences/delivery-companies

UAT

https://uat-xmum.xenial.com/preferences/delivery-companies

PROD

https://xmum.xenial.com/preferences/delivery-companies