Returns reference master data required to build member management UIs

Licenses Required

Vista.Ocapi

Request

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

get/ocapi/v1/loyalty-master-data

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"clubs": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"customPreferences": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"optionQuantityLimit": {"isUnlimited": true,
"maximum": 0,
"minimum": 0
},
"options": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
}
}
]
}
],
"educationLevels": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"genres": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"interests": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"displayPriority": 0
}
],
"interestContactMethods": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"occupations": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"photoRequirements": {"dimensions": {"width": 0,
"height": 0
},
"maximumFileSizeInKilobytes": 0,
"minimumDaysBetweenUpdates": 0
},
"sites": [{"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
],
"friendConfiguration": {"isSubscriptionSharingRestrictedToActiveSubscribers": true,
"friendLimit": {"isUnlimited": true,
"value": 0
}
},
"externalAuthenticationIssuers": [{"id": "string"
}
]
}