\nThese are managed in the Backoffice Admin ([clientID].directscale.com). The DirectScale office system uses Multi-faceted Configuration (MFC) to filter content to individual customers, so to make this call, you must provide the ID of the individual who will display the list.
\nPlease see the help documentation for further information on managing media resources (help.directscale.com).",
"operationId": "get-media-resources",
"summary": "Get Media Resources",
"tags": [
"Resources"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "Customer ID for whom to receive resources.",
"required": true,
"type": "number"
},
{
"name": "countryCode",
"in": "query",
"description": "Country filter",
"type": "string"
},
{
"name": "languageCode",
"in": "query",
"description": "Language filter",
"type": "string"
},
{
"name": "categoryTitle",
"in": "query",
"description": "Category title filter",
"type": "string"
},
{
"name": "subcategoryTitle",
"in": "query",
"description": "Subcategory title filter",
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A valid response will include media resources filtered to view permissions of the provided customer.",
"examples": {
"application/json": "[{\n \"Name\": \"Legal Docs\",\n \"SubCategories\": [{\n \"Name\": \"Terms and Conditions\",\n \"Resources\": [{\n \"ActionType\": \"Download\",\n \"Category\": \"Image\",\n \"Description\": \"Picture of legal stuff\",\n \"EmbedCode\": null,\n \"FileExtension\": \"JPG\",\n \"Id\": \"61725a49-b4b0-XXYY-a88c-d03bd191eef9\",\n \"Message\": \"This is what a legal document looks like!\",\n \"PreviewUrl\": \"//az706994.vo.msecnd.net/demo/resources/test/fakePicture.jpg\",\n \"Title\": \"Terms and Conditions, photo form\",\n \"Url\": \"//az706994.vo.msecnd.net/demo/resources/RandomFakePictureFull.jpg\"\n }]"
}
}
}
}
},
"/training/{customerId}/viewerUser/{viewerCustomerId}": {
"get": {
"description": "Get the BackOffice Training Progress for a specific customer.
\nTraining content is managed at .directscale.com, and is filtered based on rules set for customer types, countries, etc., using DirectScale's \"Multi-faceted Configuration\".
\nPlease see help.directscale.com for information on setting up and maintaining training content.\n\nYou can get the **Request Parameter** at these calls:\n\n**customerId**\n- Get Customer IDs\n- Get Customer IDs by Filter",
"operationId": "get-training-details-and-progress",
"summary": "Get Training Details and Progress",
"tags": [
"Training",
"backoffice"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The ID of the customer.",
"required": true,
"type": "number"
},
{
"name": "viewerCustomerId",
"in": "path",
"description": "This is the ID of the individual viewing the data for the specified customer.",
"required": true,
"type": "number"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A successful fetch will include training content filtered to a specific user, along with the progress that user has made. Managing training is done in the backoffice admin (see help.directscale.com)",
"examples": {
"application/json": [
{
"CompletionDate": null,
"Description": "Welcome to your new Back Office! As you know, switching systems can always be a bore. Please let us know if you or anyone on your team needs to be moved by filling out the form below - one member at a time.",
"Id": 107294,
"Name": "Sponsor Change Request",
"SortOrder": 1001000,
"Steps": [
{
"CompletedTaskCount": 0,
"CompletionDate": null,
"Name": "Watch Video",
"SortOrder": 1001000,
"Tasks": [
{
"Description": "",
"Id": 57629,
"IsCompleted": false,
"Name": "Welcome message from DirectScale",
"OpenInNewWindow": false
}
]
},
{
"CompletedTaskCount": 0,
"CompletionDate": null,
"Name": "Manage your Autoship",
"SortOrder": 1002000,
"Tasks": [
{
"Description": "Manage your autoship for the first time",
"Id": 57630,
"IsCompleted": false,
"Name": "Manage your autoship",
"OpenInNewWindow": false
}
]
},
{
"CompletedTaskCount": 0,
"CompletionDate": null,
"Name": "Completed Sponsor Change Request",
"SortOrder": 1003000,
"Tasks": [
{
"Description": "
Mark COMPLETE if you have looked at your autoship in the back office.
",
"Id": 57631,
"IsCompleted": false,
"Name": "I've managed my autoship",
"OpenInNewWindow": false
}
]
}
],
"Prerequisites": []
}
]
}
}
}
}
},
"/{customerId}/notificationSettings": {
"get": {
"description": "Fetch notification settings for a particular associate.",
"operationId": "get-notification-settings",
"summary": "Get Notification Settings",
"tags": [
"Customers",
"Events",
"Notifications"
],
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "Disco ID of requested customer",
"required": true,
"type": "number"
}
],
"responses": {
"200": {
"description": "null"
}
}
}
},
"/forgotPassword": {
"post": {
"description": "Triggers the \"Forgot Password\" process for the given email address, username, or web alias. This includes sending an email with a link to the reset page.",
"operationId": "5f63bb78128246b8ee167ab5",
"summary": "Trigger Forgot Password Process",
"tags": [
"Office"
],
"parameters": [
{
"name": "value",
"in": "query",
"description": "Value identifying customer",
"required": true,
"type": "string"
},
{
"name": "valType",
"in": "query",
"description": "Type of value being sent (email, customerid, username)",
"required": true,
"type": "string",
"enum": [
"email",
"customerid",
"username"
]
}
],
"responses": {
"200": {
"description": "There is no additional feedback from the server, except that the message was received."
}
}
}
}
},
"tags": []
}