{"swaggerDoc":{"swagger":"2.0","info":{"description":"This is the documentation of the Content Service.","version":"1.0.0","title":"Content Service","license":{"name":"Copyright © 2012-24 by Hildebrand Technology Limited"}},"host":"api.glowmarkt.com","basePath":"/api/v0-1/","tags":[{"name":"Content","description":"The API that serves content to an application"},{"name":"FAQ","description":"The API that serves FAQ lists to an application"},{"name":"Language Content","description":"The API that serves language related content"},{"name":"Prompt","description":"The API that serves prompts"},{"name":"Prompt Type","description":"The API that serves prompt types"},{"name":"Prompt User","description":"The API that monitors the user responses to prompts"},{"name":"Support Details","description":"The API that serves the static support details information"},{"name":"Terms & Conditions","description":"The API that serves and updates T&Cs"},{"name":"Terms & Conditions User","description":"Monitors a user's responses to T&Cs"},{"name":"User Action","description":"The API that serves user actions and monitors a user's response"},{"name":"User Action Type","description":"The API that serves user action types which are used to classify user actions"}],"schemes":["https"],"paths":{"/content":{"get":{"tags":["Content"],"summary":"Find all the content objects of an application","description":"Returns a list of the content objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getContent","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the content objects. A reference is unique for an application, a version, an enviroment"},{"name":"environment","in":"query","required":false,"type":"string","description":"The environment the object is served to (prod, dev, uat)"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the language content obj, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Content"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Content"],"summary":"Add a content object","description":"Add a content object.","operationId":"addContent","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Content Body","description":"The body required to create a language content obj.","schema":{"$ref":"#/definitions/AddContentReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddContentRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/content/{contentId}":{"get":{"tags":["Content"],"summary":"get a content object","description":"Returns a single object.","operationId":"getContentById","produces":["application/json"],"parameters":[{"name":"contentId","in":"path","description":"ID of content that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Content"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"put":{"tags":["Content"],"summary":"Update an existing content object","description":"Update an existing content object. The fields that can be updated are minimum version and data. We will merge the existing data filed with the latest one. This means that the data field does not get overwritten.","operationId":"updateContent","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"contentId","in":"path","description":"ID of content that is being queried","required":true,"type":"string"},{"in":"body","name":"UpdateContentReq","description":"The fields to be updated in the content object.","schema":{"$ref":"#/definitions/UpdateContentReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateContentRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/languagecontent":{"get":{"tags":["Language Content"],"summary":"Find all the language content objects of an application","description":"Returns a list of the language content objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getLanguageContent","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the language content objects. A reference is unique for an application, a version, an enviroment and languageCode "},{"name":"languageCode","in":"query","required":false,"type":"string","description":"The culture code iderthat has been assigned, i.e. en-GB"},{"name":"environment","in":"query","required":false,"type":"string","description":"The environment the object is served to (prod, dev, uat)"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the language content obj, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/LanguageContent"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Language Content"],"summary":"Add a language content object","description":"Add a language content object.","operationId":"addLanuguageContent","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Language Content Body","description":"The body required to create a language content obj.","schema":{"$ref":"#/definitions/AddLanguageContentReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddLanguageContentRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/languagecontent/{languageContentId}":{"get":{"tags":["Language Content"],"summary":"get a language content object by ID","description":"Returns a single language object.","operationId":"getLanguageContentById","produces":["application/json"],"parameters":[{"name":"languageContentId","in":"path","description":"ID of language content that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LanguageContent"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"put":{"tags":["Language Content"],"summary":"Update an existing language content object","description":"Update an existing language content object. The fields that can be updated are minimum version and data. We will merge the existing data filed with the latest one. This means that the data field does not get overwritten.","operationId":"updateLanuguageContent","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"languageContentId","in":"path","description":"ID of language content that is being queried","required":true,"type":"string"},{"in":"body","name":"UpdateLanguageContentReq","description":"The fields to be updated in the language content object.","schema":{"$ref":"#/definitions/UpdateLanguageContentReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateLanguageContentRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/termsconditions":{"get":{"tags":["Terms & Conditions"],"summary":"Find all the terms and conditions of an application","description":"Returns a list of the terms and conditions objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getTermsConditions","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the various terms and conditions objects. A reference is unique for an application."},{"name":"country","in":"query","required":false,"type":"string","description":"T&Cs that apply to a particular country."},{"name":"version","in":"query","required":false,"type":"string","description":"The version, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TermsAndConditions"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Terms & Conditions"],"summary":"Add terms and conditions","description":"Add terms and conditions, or create a clone of a preexisting one.","operationId":"addTermsConditions","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Terms & Conditions Body","description":"The body required to create a terms and conditions obj.","schema":{"$ref":"#/definitions/AddTermsAndConditionsBody"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddTermsAndConditionsRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/termsconditions/{tcId}":{"get":{"tags":["Terms & Conditions"],"summary":"get a terms and conditions object by ID","description":"Returns a single language object.","operationId":"getTermsConditionsById","produces":["application/json"],"parameters":[{"name":"tcId","in":"path","description":"ID of T&Cs obj that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TermsAndConditions"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/termsconditions/current":{"get":{"tags":["Terms & Conditions"],"summary":"Find the terms and conditions that are in force.","description":"Returns a list of the terms and conditions that are in force of an application. There are some query parameters that can be used to narrow down the list. It is noted that there can only be one current terms and conditions for each reference.","operationId":"getCurrentTermsConditions","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the various terms and conditions objects. A reference is unique for an application."},{"name":"country","in":"query","required":false,"type":"string","description":"T&Cs that apply to a particular country."},{"name":"version","in":"query","required":false,"type":"string","description":"The version, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/CurrentTermsAndConditions"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/termsconditionsuser":{"get":{"tags":["Terms & Conditions User"],"summary":"Find all the responses to terms and conditions documents.","description":"Find all the responses to terms and conditions documents. This API will return all the t&cs the user has responded to. With administrative credentials and depending the query parameters this API will return a list of documents of the responses to terms and conditions documents from various users.","operationId":"getTermsConditionsUser","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the various terms and conditions objects. A reference is unique for an application."},{"name":"tcId","in":"query","required":false,"type":"string","description":"T&Cs object identifier"},{"name":"userId","in":"header","required":false,"type":"string","description":"For administrative credentials, enter a userId in the header to filter out the responses of a particular user to an application's terms and conditions."}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TermsAndConditionsUser"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Terms & Conditions User"],"summary":"Add a user's response to Terms & Conditions document","operationId":"addTermsConditionsUser","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"TermsConditionsUserBody","description":"The body required to create a user's response to a specific version of T&Cs.","schema":{"$ref":"#/definitions/AddTermsAndConditionsUserBody"}}],"security":[{"userToken":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TermsAndConditionsUser"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/termsconditionsuser/{tcUserId}":{"get":{"tags":["Terms & Conditions User"],"summary":"get a specified terms and conditions user obj","description":"Returns a single terms and conditions user obj.","operationId":"getTermsConditionsUserById","produces":["application/json"],"parameters":[{"name":"tcUserId","in":"path","description":"The identifier of the T&Cs user document","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TermsAndConditionsUser"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/supportdetails":{"get":{"tags":["Support Details"],"summary":"Find all the support detail objects of an application","description":"Returns a list of the support detail objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getSupportDetails","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the support detail objects."},{"name":"country","in":"query","required":false,"type":"string","description":"The culture code iderthat has been assigned, i.e. UK"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the language content obj, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SupportDetails"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Support Details"],"summary":"Add a support details object","description":"Add a support details object.","operationId":"addSupportDetails","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Support Details Body","description":"The body required to create a support details obj.","schema":{"$ref":"#/definitions/AddSupportDetailsReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddSupportDetailsRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/supportdetails/{supportDetailsId}":{"get":{"tags":["Support Details"],"summary":"get a support details object","description":"Returns a single support details object.","operationId":"getSupportDetailsById","produces":["application/json"],"parameters":[{"name":"supportDetailsId","in":"path","description":"ID of support details that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SupportDetails"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/faq":{"get":{"tags":["FAQ"],"summary":"Find all the FAQ objects of an application","description":"Returns a list of the support detail objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getFAQs","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the support detail objects."},{"name":"country","in":"query","required":false,"type":"string","description":"The culture code iderthat has been assigned, i.e. UK"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the language content obj, i.e 1.0.0"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/FAQ"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["FAQ"],"summary":"Add a faq object","description":"Add a faq object.","operationId":"addFAQ","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"FAQ Body","description":"The body required to create an faq obj.","schema":{"$ref":"#/definitions/AddFaqReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddFaqRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/faq/{faqId}":{"get":{"tags":["FAQ"],"summary":"get a FAQ object","description":"Returns a single FAQs object.","operationId":"getFAQById","produces":["application/json"],"parameters":[{"name":"faqId","in":"path","description":"ID of FAQ object that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FAQ"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/prompttype":{"get":{"tags":["Prompt Type"],"summary":"Find all the prompt type objects of an application","description":"Returns a list of the prompt type objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getPromptType","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the prompt type objects. A reference is unique for an application"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the prompt type"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PromptType"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Prompt Type"],"summary":"Add a Prompt Type object","description":"Add a Prompt Type object.","operationId":"addPromptType","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Prompt Type Body","description":"The body required to create a prompt type obj.","schema":{"$ref":"#/definitions/AddPromptTypeReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddPromptTypeRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/prompttype/{promptTypeId}":{"get":{"tags":["Prompt Type"],"summary":"get a Prompt Type object","description":"Returns a single object.","operationId":"getPromptTypeById","produces":["application/json"],"parameters":[{"name":"promptTypeId","in":"path","description":"ID of Prompt Type that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PromptType"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/prompt":{"get":{"tags":["Prompt"],"summary":"Find all the prompt objects of an application","description":"Returns a list of the prompt objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getPrompt","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the prompt objects. A reference is unique for an application"},{"name":"version","in":"query","required":false,"type":"string","description":"The version of the prompt"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Prompt"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Prompt"],"summary":"Add a Prompt object","description":"Add a Prompt object.","operationId":"addPrompt","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Prompt Body","description":"The body required to create a prompt obj.","schema":{"$ref":"#/definitions/AddPromptReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddPromptRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/prompt/{promptId}":{"get":{"tags":["Prompt"],"summary":"get a Prompt object","description":"Returns a single object.","operationId":"getPromptById","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"ID of Prompt that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Prompt"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/promptuser":{"get":{"tags":["Prompt User"],"summary":"Find all the prompt user objects of an application","description":"Returns a list of the prompt objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getPromptUser","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the prompt objects. A reference is unique for an application"},{"name":"promptTypeId","in":"query","required":false,"type":"string","description":"A particular type of prompt type"},{"name":"userId","in":"query","required":false,"type":"string","description":"The user whose prompt responses are bring queried"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PromptUser"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["Prompt User"],"summary":"Add a Prompt User object","description":"Add a Prompt User object.","operationId":"addPromptUser","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"Prompt Body","description":"The body required to create a prompt User obj.","schema":{"$ref":"#/definitions/AddPromptUserReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddPromptUserRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/promptuser/{promptUserId}":{"get":{"tags":["Prompt User"],"summary":"get a Prompt User object","description":"Returns a single object.","operationId":"getPromptUserById","produces":["application/json"],"parameters":[{"name":"promptUserId","in":"path","description":"ID of Prompt User that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PromptUser"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/useraction":{"get":{"tags":["User Action"],"summary":"Find all the user action objects of an application","description":"Returns a list of the user action objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getUserAction","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the user action type objects. A reference is unique for an application"},{"name":"userGroupId","in":"query","required":false,"type":"string","description":"A userGroupId"},{"name":"userId","in":"header","required":false,"type":"string","description":"A userId. Use for application level calls when the user actions of a user are required"},{"name":"userActionTypeId","in":"query","required":false,"type":"string","description":"A userActionTypeId"},{"name":"userOrganizationId","in":"query","required":false,"type":"string","description":"A userOrganizationId"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserAction"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["User Action"],"summary":"Add a User Action object","description":"Add a User Action object.","operationId":"addUserAction","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"User Action Body","description":"The body required to create a user action obj.","schema":{"$ref":"#/definitions/AddUserActionReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddUserActionRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/useraction/{userActionId}":{"get":{"tags":["User Action"],"summary":"get a User Action object","description":"Returns a single object.","operationId":"getUserActionById","produces":["application/json"],"parameters":[{"name":"userActionId","in":"path","description":"ID of User Action that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserAction"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/useractiontype":{"get":{"tags":["User Action Type"],"summary":"Find all the user action type objects of an application","description":"Returns a list of the user action typ objects of an application. There are some query parameters that can be used to narrow down the list.","operationId":"getUserActionType","produces":["application/json"],"parameters":[{"name":"reference","in":"query","required":false,"type":"string","description":"A clear text identifier that facilitates the distinction of the user action type objects. A reference is unique for an application"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserActionType"}}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}},"post":{"tags":["User Action Type"],"summary":"Add a User Action Type object","description":"Add a User Action Type object.","operationId":"addUserActionType","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"User Action Type Body","description":"The body required to create a user action type obj.","schema":{"$ref":"#/definitions/AddUserActionTypeReq"}}],"security":[{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddUserActionTypeRes"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/MissingElementsError"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}},"/useractiontype/{userActionTypeId}":{"get":{"tags":["User Action Type"],"summary":"get a User Action Type object","description":"Returns a single object.","operationId":"getUserActionTypeById","produces":["application/json"],"parameters":[{"name":"userActionTypeId","in":"path","description":"ID of User Action Type that is being queried","required":true,"type":"string"}],"security":[{"userToken":[],"applicationId":[]},{"appKeys":[]},{"devUserToken":[],"applicationId":[]},{"internalUserToken":[],"applicationId":[]},{"orgAppKeys":[],"applicationId":[]}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserActionType"}},"401":{"description":"Unauthorised","schema":{"$ref":"#/definitions/AccessDeniedError"}},"404":{"description":"Not Found","schema":{"$ref":""}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/InternalServerError"}}}}}},"securityDefinitions":{"orgAppKeys":{"type":"basic"},"appKeys":{"type":"basic"},"devUserToken":{"type":"apiKey","name":"token","in":"header"},"internalUserToken":{"type":"apiKey","name":"token","in":"header"},"userToken":{"type":"apiKey","name":"token","in":"header"},"applicationId":{"type":"apiKey","name":"applicationId","in":"header"},"organizationId":{"type":"apiKey","name":"organizationId","in":"header"}},"definitions":{"AddTermsAndConditionsUserBody":{"type":"object","properties":{"tcId":{"type":"string","example":"cc284ff4-44d5-5d2e-b20c-274595ab8986"},"data":{"type":"object","properties":{"dataAccess":{"type":"object","properties":{"valid":{"type":"boolean","example":true}}}}},"reference":{"type":"string","example":"ApplicationTermsAndConditions"}}},"TermsAndConditionsUser":{"allOf":[{"$ref":"#/definitions/AddTermsAndConditionsUserBody"}],"type":"object","properties":{"tcUserId":{"type":"string","example":"cc284ff4-44d5-5d2e-b20c-274595ab8986"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"userId":{"type":"string","example":"69f464fa-bca2-4f2a-83b1-0c69819c5cd0"}}},"TemrsConditionsElement":{"type":"object","properties":{"title":{"type":"string","example":"Introduction"},"description":{"type":"string","example":"By registering with the service, you agree that you have read and accepted these terms."}}},"AddTermsAndConditionsBody":{"type":"object","properties":{"data":{"type":"object","properties":{"title":{"type":"string","example":"Glowmarkt Terms & Condition"},"lastUpdated":{"type":"string","example":"2018-10-19"},"details":{"type":"array","items":{"$ref":"#/definitions/TemrsConditionsElement"}}}},"reference":{"type":"string","example":"ApplicationTermsAndConditions"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"country":{"type":"string","example":"UK"}},"required":["reference","data"]},"TermsAndConditions":{"allOf":[{"$ref":"#/definitions/AddTermsAndConditionsBody"},{"properties":{"tcId":{"type":"string","example":"cc284ff4-44d5-5d2e-b20c-274595ab8986"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"status":{"type":"string","example":"OK"}}}]},"CurrentTermsAndConditions":{"allOf":[{"$ref":"#/definitions/TermsAndConditions"},{"properties":{"current":{"type":"boolean","example":true}}}]},"AddTermsAndConditionsRes":{"type":"object","properties":{"tcId":{"type":"string","example":"cc284ff4-44d5-5d2e-b20c-274595ab8986"},"valid":{"type":"boolean","example":true}},"xml":{"name":"AddSupportDetailsRes"}},"FAQ":{"type":"object","properties":{"faqId":{"type":"string","example":"f1284ff4-44d5-5d2e-b20c-274595ab8986"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"FaqGeneral"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"country":{"type":"string","example":"UK"},"status":{"type":"string","example":"OK"},"data":{"type":"array","items":{"$ref":"#/definitions/FaqElement"}}},"xml":{"name":"FAQ"}},"FaqElement":{"type":"object","properties":{"question":{"type":"string","example":"I have a new phone - what should I do?"},"reply":{"type":"string","example":"Simply download the app, login again and nothing will have changed!"}}},"AddFaqReq":{"type":"object","properties":{"reference":{"type":"string","example":"FaqGeneral"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"country":{"type":"string","example":"UK"},"data":{"type":"array","items":{"$ref":"#/definitions/FaqElement"}}},"required":["version","reference","data"],"xml":{"name":"AddFaqReq"}},"AddFaqRes":{"type":"object","properties":{"faqId":{"type":"string","example":"f1284ff4-44d5-5d2e-b20c-274595ab8986"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"FaqGeneral"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddFaqRes"}},"SupportDetails":{"type":"object","properties":{"supportDetailsId":{"type":"string","example":"s8284ff4-4435-4d2f-a20c-274595ab8000"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"SupportDetails"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"country":{"type":"string","example":"UK"},"status":{"type":"string","example":"OK"},"data":{"type":"array","items":{"$ref":"#/definitions/SupportDetailsPhone"}}},"xml":{"name":"SupportDetails"}},"AddSupportDetailsReq":{"type":"object","properties":{"reference":{"type":"string","example":"SupportDetails"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"country":{"type":"string","example":"UK"},"data":{"type":"array","items":{"$ref":"#/definitions/SupportDetailsPhone"}}},"required":["version","reference","data"],"xml":{"name":"AddSupportDetailsReq"}},"AddSupportDetailsRes":{"type":"object","properties":{"supportDetailsId":{"type":"string","example":"s8284ff4-4435-4d2f-a20c-274595ab8000"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"SupportDetails"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddSupportDetailsRes"}},"SupportDetailsPhone":{"type":"object","properties":{"availability":{"type":"string","example":"Mon-Fri 8:00-20:00"},"contactDetails":{"type":"string","example":"+44 1234567890"},"type":{"type":"string","example":"phone"}}},"LanguageContent":{"type":"object","properties":{"languageContentId":{"type":"string","example":"efe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"LanguageContent"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"environment":{"type":"string","enum":["prod","dev","uat"],"example":"prod"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"languageCode":{"type":"string","example":"en-GB"},"status":{"type":"string","example":"OK"},"data":{"type":"object","properties":{"ACCOUNT_SETTINGS":{"type":"string","example":"Account Settings"},"DEVICE_HARDWAREID":{"type":"string","example":"The hardwareId of the device is {{hardwareId}}."},"WEEKDAYS":{"type":"object","properties":{"MONDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Mon"},"LONG":{"type":"string","example":"Monday"}}},"TUESDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Tue"},"LONG":{"type":"string","example":"Tuesday"}}},"WEDNESDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Wed"},"LONG":{"type":"string","example":"Wednesday"}}},"THURSDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Thu"},"LONG":{"type":"string","example":"Thursday"}}},"FRIDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Fri"},"LONG":{"type":"string","example":"Friday"}}},"SATURDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Sat"},"LONG":{"type":"string","example":"Saturday"}}},"SUNDAY":{"type":"object","properties":{"SHORT":{"type":"string","example":"Sun"},"LONG":{"type":"string","example":"Sunday"}}}}}}}},"xml":{"name":"LanguageContent"}},"AddLanguageContentReq":{"type":"object","properties":{"environment":{"type":"string","enum":["prod","dev","uat"],"example":"prod"},"version":{"type":"string","example":"1.0.1"},"reference":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"languageCode":{"type":"string","example":"en-GB"},"data":{"type":"object","properties":{"ACCOUNT_SETTINGS":{"type":"string","example":"Account Settings"},"DEVICE_HARDWAREID":{"type":"string","example":"The hardwareId of the device is {{hardwareId}}."}}}},"required":["environment","version","reference","languageCode","data"],"xml":{"name":"AddLanguageContentReq"}},"UpdateLanguageContentReq":{"type":"object","properties":{"minimumVersion":{"type":"string","example":"1.0.0"},"data":{"type":"object","properties":{"ACCOUNT_SETTINGS":{"type":"string","example":"Account Settings"},"DEVICE_HARDWAREID":{"type":"string","example":"The hardwareId of the device is {{hardwareId}}."}}}},"xml":{"name":"UpdateLanguageContentReq"}},"AddLanguageContentRes":{"type":"object","properties":{"languageContentId":{"type":"string","example":"efe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"LanguageContent"}},"xml":{"name":"AddLanguageContentRes"}},"UpdateLanguageContentRes":{"type":"object","properties":{"languageContentId":{"type":"string","example":"efe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"LanguageContent"}},"xml":{"name":"UpdateLanguageContentReq"}},"Content":{"type":"object","properties":{"contentId":{"type":"string","example":"coe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"CoachingScreenWelcome"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"environment":{"type":"string","enum":["prod","dev","uat"],"example":"prod"},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"status":{"type":"string","example":"OK"},"data":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"},"example":["title","description"]},"values":{"type":"object","properties":{"title":{"type":"object","properties":{"type":{"type":"string","example":"header"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_TITLE"}}},"desription":{"type":"object","properties":{"type":{"type":"string","example":"icon"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_DESCRIPTION"}}}}}}}},"xml":{"name":"Content"}},"AddContentReq":{"type":"object","properties":{"environment":{"type":"string","enum":["prod","dev","uat"],"example":"prod"},"version":{"type":"string","example":"1.0.1"},"reference":{"type":"string","example":"CoachingScreenWelcome"},"minimumVersion":{"type":"string","example":"1.0.0"},"data":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"string"},"example":["title","description"]},"values":{"type":"object","properties":{"title":{"type":"object","properties":{"type":{"type":"string","example":"header"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_TITLE"}}},"desription":{"type":"object","properties":{"type":{"type":"string","example":"icon"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_DESCRIPTION"}}}}}}}},"required":["environment","version","reference","data"],"xml":{"name":"AddContentReq"}},"UpdateContentReq":{"type":"object","properties":{"minimumVersion":{"type":"string","example":"1.0.0"},"data":{"type":"object","properties":{"title":{"type":"object","properties":{"type":{"type":"string","example":"header"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_TITLE_1"}}},"desription":{"type":"object","properties":{"type":{"type":"string","example":"icon"},"value":{"type":"string","example":"COACHING_SCREEN_WELCOME_DESCRIPTION_1"}}}}}},"xml":{"name":"UpdateContentReq"}},"AddContentRes":{"type":"object","properties":{"contentId":{"type":"string","example":"coe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"CoachingScreenWelcome"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddContentRes"}},"UpdateContentRes":{"type":"object","properties":{"contentId":{"type":"string","example":"coe84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"CoachingScreenWelcome"}},"xml":{"name":"UpdateContentReq"}},"UserAction":{"type":"object","properties":{"userActionTypeId":{"type":"string","example":"uat84ff4-4435-4d2f-a20c-274595ab8cd4"},"userActionId":{"type":"string","example":"ua234fi9-4435-ed23-e2fc-ff44595b8c3r"},"userId":{"type":"string","example":"69f464fa-bca2-4f2a-83b1-0c69819c5cd0"},"userGroupId":{"type":"string","example":"g9f464fu-bca2-4f2a-83b1-0c69819c5cd0"},"userOrganizationId":{"type":"string","example":"o934r4fu-bca2-4f2a-83b1-0c69819c5cd0"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"reference":{"type":"string","example":"LoginEvent"},"description":{"type":"string","example":"User Action Type that captures the user logins"},"data":{"type":"string","example":"Anything that may be useful for an user action."}},"xml":{"name":"UserAction"}},"AddUserActionReq":{"type":"object","properties":{"reference":{"type":"string","example":"LoginEvent"},"userActionTypeId":{"type":"string","example":"uat84ff4-4435-4d2f-a20c-274595ab8cd4"}},"required":["reference","userActionTypeId"],"xml":{"name":"AddUserActionTypeReq"}},"AddUserActionRes":{"type":"object","properties":{"userActionId":{"type":"string","example":"ua234fi9-4435-ed23-e2fc-ff44595b8c3r"},"userActionTypeId":{"type":"string","example":"uat84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"userId":{"type":"string","example":"69f464fa-bca2-4f2a-83b1-0c69819c5cd0"},"userGroupId":{"type":"string","example":"g9f464fu-bca2-4f2a-83b1-0c69819c5cd0"},"reference":{"type":"string","example":"LoginEvent"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddUserActionRes"}},"UserActionType":{"type":"object","properties":{"userActionTypeId":{"type":"string","example":"uat84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"functionalGroupId":{"type":"string","example":"003pb10w-rbe2-2e1c-i925-3a62b6206000"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"reference":{"type":"string","example":"LoginEvent"},"description":{"type":"string","example":"User Action Type that captures the user logins"},"data":{"type":"string","example":"Anything that may be useful for a specific type of user actions."}},"xml":{"name":"UserActionType"}},"AddUserActionTypeReq":{"type":"object","properties":{"reference":{"type":"string","example":"LoginEvent"},"description":{"type":"string","example":"User Action Type that captures the user logins"}},"required":["reference"],"xml":{"name":"AddUserActionTypeReq"}},"AddUserActionTypeRes":{"type":"object","properties":{"userActionTypeId":{"type":"string","example":"uat84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"LoginEvent"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddUserActionTypeRes"}},"PromptType":{"type":"object","properties":{"promptTypeId":{"type":"string","example":"prt84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"dataSourcePromptTypeInfo":{"type":"object","example":{"savedAs":{"key":"numberOfOccupants"},"obj":"prompt","system":"contentsvc","type":"microservice"}},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"status":{"type":"string","example":"OK"}},"xml":{"name":"PromptType"}},"AddPromptTypeReq":{"type":"object","properties":{"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"}},"required":["reference"],"xml":{"name":"AddPromptTypeReq"}},"AddPromptTypeRes":{"type":"object","properties":{"promptTypeId":{"type":"string","example":"prt84ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddPromptTypeRes"}},"Prompt":{"type":"object","properties":{"promptTypeId":{"type":"string","example":"prt84ff4-4435-4d2f-a20c-274595ab8cd4"},"promptId":{"type":"string","example":"pra24ff3-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"dataSourcePromptTypeInfo":{"type":"object","example":{"savedAs":{"key":"numberOfOccupants"},"obj":"prompt","system":"contentsvc","type":"microservice"}},"data":{"type":"object","example":{"keys":["title","button"],"values":{"title":{"type":"title","value":"NUMBER_OF_OCCUPANTS_TITLE"},"button":{"type":"title","value":"NUMBER_OF_OCCUPANTS_BUTTON","operation":"SUBMIT_NUMBER_OF_OCCUPANTS"}}}},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"},"status":{"type":"string","example":"OK"}},"xml":{"name":"PromptType"}},"AddPromptReq":{"type":"object","properties":{"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"promptTypeId":{"type":"string","example":"prt84ff4-4435-4d2f-a20c-274595ab8cd4"},"data":{"type":"object","example":{"keys":["title","button"],"values":{"title":{"type":"title","value":"NUMBER_OF_OCCUPANTS_TITLE"},"button":{"type":"title","value":"NUMBER_OF_OCCUPANTS_BUTTON","operation":"SUBMIT_NUMBER_OF_OCCUPANTS"}}}},"version":{"type":"string","example":"1.0.1"},"minimumVersion":{"type":"string","example":"1.0.0"}},"required":["reference","data","version","promptTypeId"],"xml":{"name":"AddPromptReq"}},"AddPromptRes":{"type":"object","properties":{"promptId":{"type":"string","example":"pra24ff3-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddPromptRes"}},"PromptUser":{"type":"object","properties":{"promptUserId":{"type":"string","example":"pru84ff4-4435-4d2f-a20c-274595ab8cd4"},"promptTypeId":{"type":"string","example":"prt84ff4-4435-4d2f-a20c-274595ab8cd4"},"promptId":{"type":"string","example":"pra24ff3-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"userId":{"type":"string","example":"69f464fa-bca2-4f2a-83b1-0c69819c5cd0"},"data":{"type":"string","example":"Anything that may be useful for an interaction of a user with a prompt."},"createdAt":{"type":"string","example":"2018-07-05T16:00:25.075Z"},"updatedAt":{"type":"string","example":"2018-10-19T09:00:45.000Z"}},"xml":{"name":"PromptUser"}},"AddPromptUserReq":{"type":"object","properties":{"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"promptId":{"type":"string","example":"12384ff4-4435-4d2f-a20c-274595ab8cd4"},"data":{"type":"object","example":{"key1":"keyvalue"}}},"required":["reference","promptId"],"xml":{"name":"AddUserActionTypeReq"}},"AddPromptUserRes":{"type":"object","properties":{"promptUserId":{"type":"string","example":"31234fi9-4435-ed23-e2fc-ff44595b8c3r"},"promptId":{"type":"string","example":"12384ff4-4435-4d2f-a20c-274595ab8cd4"},"applicationId":{"type":"string","example":"0537b17c-ab62-491c-8085-9ac2b6206346"},"userId":{"type":"string","example":"69f464fa-bca2-4f2a-83b1-0c69819c5cd0"},"userGroupId":{"type":"string","example":"g9f464fu-bca2-4f2a-83b1-0c69819c5cd0"},"reference":{"type":"string","example":"HouseholdAtrributesNumberOfOccupants"},"isNew":{"type":"boolean","example":true}},"xml":{"name":"AddUserActionRes"}},"Error":{"type":"object","properties":{"error":{"type":"string"}},"xml":{"name":"Error"}},"AccessDeniedError":{"type":"object","properties":{"error":{"type":"string","example":"Access denied"}}},"InternalServerError":{"type":"object","properties":{"error":{"type":"string","example":"An error has occurred"}}},"IncorrectElementsError":{"type":"object","properties":{"error":{"type":"string","example":"incorrect elements"}}},"MissingElementsError":{"type":"object","properties":{"error":{"type":"string","example":"missing elements"}}},"ApiResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"type":{"type":"string"},"message":{"type":"string"}}}},"externalDocs":{"description":"Find out more about Glowmarkt","url":"https://glowmarkt.com/"}},"customOptions":{}}