{ "swagger": "2.0", "info": { "title": "Sample API", "version": "1.0" }, "host": "api.dynata.com", "schemes": [ "http" ], "consumes": [ "application/json", "application/xml", "application/gob", "application/x-gob" ], "produces": [ "application/json", "application/xml", "application/gob", "application/x-gob" ], "paths": { "/auth/v1/logout": { "post": { "tags": [ "auth" ], "summary": "logout auth", "operationId": "auth#logout", "produces": [ "application/vnd.auth.error+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LogoutPayload" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AuthError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AuthError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AuthError" } } }, "schemes": [ "http" ] } }, "/auth/v1/switchCompany": { "post": { "tags": [ "auth" ], "summary": "switchCompany auth", "operationId": "auth#switchCompany", "produces": [ "application/vnd.auth.error+json", "application/vnd.token+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SwitchCompanyPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenMedia" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AuthError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AuthError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AuthError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AuthError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/auth/v1/token/code": { "post": { "tags": [ "auth" ], "summary": "code auth", "operationId": "auth#code", "produces": [ "application/vnd.auth.error+json", "application/vnd.token+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CodePayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenMedia" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AuthError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AuthError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AuthError" } } }, "schemes": [ "http" ] } }, "/auth/v1/token/password": { "post": { "tags": [ "auth" ], "summary": "password auth", "operationId": "auth#password", "produces": [ "application/vnd.auth.error+json", "application/vnd.token+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/TokenPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenMedia" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AuthError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AuthError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AuthError" } } }, "schemes": [ "http" ] } }, "/auth/v1/token/refresh": { "post": { "tags": [ "auth" ], "summary": "refresh auth", "operationId": "auth#refresh", "produces": [ "application/vnd.auth.error+json", "application/vnd.token+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RefreshTokenPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TokenMedia" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AuthError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AuthError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AuthError" } } }, "schemes": [ "http" ] } }, "/internal/v1/orderdetails/check/{orderNumber}": { "get": { "tags": [ "orderDetails" ], "summary": "checkOrderNumber orderDetails", "operationId": "orderDetails#checkOrderNumber", "produces": [ "application/vnd.checkordernumber+json" ], "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckOrderNumber" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CheckOrderNumber" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CheckOrderNumber" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/CheckOrderNumber" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CheckOrderNumber" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/internal/v1/orderdetails/{orderNumber}/": { "get": { "tags": [ "orderDetails" ], "summary": "getOrderNumberDetails orderDetails", "operationId": "orderDetails#getOrderNumberDetails", "produces": [ "application/vnd.orderdetail+json" ], "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderDetail" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/OrderDetail" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/OrderDetail" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/OrderDetail" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/OrderDetail" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/respondent/dedupe": { "get": { "tags": [ "respondent" ], "summary": "dedupe respondent", "operationId": "respondent#dedupe", "produces": [ "text/html", "text/plain" ], "responses": { "200": { "description": "OK" }, "302": { "description": "Found", "headers": { "Location": { "type": "string" } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "schemes": [ "http" ] } }, "/respondent/entry": { "get": { "tags": [ "respondent" ], "summary": "entry respondent", "operationId": "respondent#entry", "produces": [ "text/html", "text/plain" ], "responses": { "200": { "description": "OK" }, "302": { "description": "Found", "headers": { "Location": { "type": "string" } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "schemes": [ "http" ] } }, "/respondent/exit": { "get": { "tags": [ "respondent" ], "summary": "exit respondent", "operationId": "respondent#exit", "produces": [ "text/html", "text/plain" ], "responses": { "200": { "description": "OK" }, "302": { "description": "Found", "headers": { "Location": { "type": "string" } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "schemes": [ "http" ] } }, "/respondent/midway/entry": { "get": { "tags": [ "respondent" ], "summary": "midway-entry respondent", "operationId": "respondent#midway-entry", "produces": [ "text/html", "text/plain" ], "responses": { "302": { "description": "Found", "headers": { "Location": { "type": "string" } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "schemes": [ "http" ] } }, "/respondent/midway/exit": { "get": { "tags": [ "respondent" ], "summary": "midway-exit respondent", "operationId": "respondent#midway-exit", "produces": [ "text/html", "text/plain" ], "responses": { "302": { "description": "Found", "headers": { "Location": { "type": "string" } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } }, "schemes": [ "http" ] } }, "/sample/v1/attributes/{countryIsoCode}/{languageIsoCode}": { "get": { "tags": [ "attributes" ], "summary": "list attributes", "operationId": "attributes#list", "produces": [ "application/vnd.attributes+json" ], "parameters": [ { "name": "category", "in": "query", "description": "Only return attributes with the given category", "required": false, "type": "string" }, { "name": "countryIsoCode", "in": "path", "description": "Country ISO code", "required": true, "type": "string" }, { "name": "id", "in": "query", "description": "Only return attributes with the given id", "required": false, "type": "string" }, { "name": "isAllowedInSurveyAppends", "in": "query", "description": "Only return attributes with the given isAllowedInSurveyAppends value", "required": false, "type": "boolean" }, { "name": "languageIsoCode", "in": "path", "description": "Language ISO code", "required": true, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of attributes to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "name", "in": "query", "description": "Only return attributes with the given name", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The first zero-based offset attribute to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the attributes by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "state", "in": "query", "description": "Only return attributes with the given state", "required": false, "type": "string" }, { "name": "subcategory", "in": "query", "description": "Only return attributes with the given subcategory", "required": false, "type": "string" }, { "name": "text", "in": "query", "description": "Only return attributes with the given text", "required": false, "type": "string" }, { "name": "tier", "in": "query", "description": "Only return attributes with the given tier", "required": false, "type": "string" }, { "name": "type", "in": "query", "description": "Only return attributes with the given type", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Attributes" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Attributes" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Attributes" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/categories/surveyTopics": { "get": { "tags": [ "categories" ], "summary": "list categories", "operationId": "categories#list", "produces": [ "application/vnd.categories+json" ], "parameters": [ { "name": "description", "in": "query", "description": "Only return categories with the given description", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "Only return categories with the given id", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of categories to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "name", "in": "query", "description": "Only return categories with the given name", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The first zero-based offset category to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the categories by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Categories" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Categories" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Categories" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/countries": { "get": { "tags": [ "countries" ], "summary": "list countries", "operationId": "countries#list", "produces": [ "application/vnd.countries+json" ], "parameters": [ { "name": "countryName", "in": "query", "description": "Only return countries with the given name", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "Only return countries with the given id", "required": false, "type": "string" }, { "name": "isoCode", "in": "query", "description": "Only return countries with the given ISO code", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of countries to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "offset", "in": "query", "description": "The first zero-based offset country to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the countries by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Countries" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Countries" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Countries" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/events": { "get": { "tags": [ "events" ], "summary": "list events", "description": "List events.", "operationId": "events#list", "produces": [ "application/vnd.events+json" ], "parameters": [ { "name": "eventType", "in": "query", "description": "Only return events with the given eventType", "required": false, "type": "string" }, { "name": "extLineItemId", "in": "query", "description": "Only return events with the given external line item id", "required": false, "type": "string" }, { "name": "extProjectId", "in": "query", "description": "Only return events with the given external project id", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of events to return", "required": false, "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, { "name": "offset", "in": "query", "description": "The first zero-based offset event to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the events by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Events" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Events" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Events" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/events/lineItems/createproject": { "post": { "tags": [ "events" ], "summary": "createproject events", "description": "createproject event.", "operationId": "events#createproject", "produces": [ "application/vnd.createproject+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateProjectPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateProject" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateProject" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/CreateProject" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateProject" } } }, "schemes": [ "http" ] } }, "/sample/v1/events/lineItems/reprice": { "post": { "tags": [ "events" ], "summary": "reprice events", "description": "Line item repricing event.", "operationId": "events#reprice", "produces": [ "application/vnd.reprice+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RepricePayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Reprice" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Reprice" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Reprice" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Reprice" } } }, "schemes": [ "http" ] } }, "/sample/v1/events/lineItems/stateChange": { "post": { "tags": [ "events" ], "summary": "stateChange events", "description": "Line item state change event.", "operationId": "events#stateChange", "produces": [ "application/vnd.statechange+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/StateChangePayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StateChange" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/StateChange" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/StateChange" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/StateChange" } } }, "schemes": [ "http" ] } }, "/sample/v1/events/projects/invoice": { "post": { "tags": [ "events" ], "summary": "invoiceproject events", "description": "invoiceproject event.", "operationId": "events#invoiceproject", "produces": [ "application/vnd.invoiceproject+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InvoiceProjectPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InvoiceProject" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/InvoiceProject" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/InvoiceProject" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/InvoiceProject" } } }, "schemes": [ "http" ] } }, "/sample/v1/events/{eventId}": { "get": { "tags": [ "events" ], "summary": "get events", "description": "Get event", "operationId": "events#get", "produces": [ "application/vnd.event+json" ], "parameters": [ { "name": "eventId", "in": "path", "description": "Event ID", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Event" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Event" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Event" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Event" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/events/{eventId}/accept": { "post": { "tags": [ "events" ], "summary": "accept events", "description": "Accept event", "operationId": "events#accept", "produces": [ "application/vnd.event+json" ], "parameters": [ { "name": "eventId", "in": "path", "description": "Event ID", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Event" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Event" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Event" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Event" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Event" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Event" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/events/{eventId}/reject": { "post": { "tags": [ "events" ], "summary": "reject events", "description": "Reject event", "operationId": "events#reject", "produces": [ "application/vnd.event+json" ], "parameters": [ { "name": "eventId", "in": "path", "description": "Event ID", "required": true, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Event" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Event" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Event" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Event" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Event" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Event" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects": { "get": { "tags": [ "projects" ], "summary": "list projects", "operationId": "projects#list", "produces": [ "application/vnd.projects+json" ], "parameters": [ { "name": "billingDate", "in": "query", "description": "return projects with billing date matching the given date range", "required": false, "type": "string" }, { "name": "billingID", "in": "query", "description": "return projects with billing ID matching the given billing ID", "required": false, "type": "string" }, { "name": "billingType", "in": "query", "description": "return projects with billing type matching the given billing type", "required": false, "type": "string" }, { "name": "createdAt", "in": "query", "description": "return projects with createdAt start date", "required": false, "type": "string" }, { "name": "extProjectId", "in": "query", "description": "Only return project with the given external project id", "required": false, "type": "string" }, { "name": "jobNumber", "in": "query", "description": "Only return projects with the given job number", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of projects to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "offset", "in": "query", "description": "The first zero-based offset project to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "scope", "in": "query", "description": "Only return projects within the given scope", "required": false, "type": "string", "enum": [ "application", "user" ] }, { "name": "sort", "in": "query", "description": "Sort the projects by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "state", "in": "query", "description": "Only return projects with the given state", "required": false, "type": "string" }, { "name": "title", "in": "query", "description": "Only return projects with the given title", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Projects" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Projects" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Projects" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Projects" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "post": { "tags": [ "projects" ], "summary": "create projects", "operationId": "projects#create", "produces": [ "application/vnd.create+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Project" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectResponse" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/invoices/summary": { "get": { "tags": [ "projects" ], "summary": "getInvoiceSummary projects", "operationId": "projects#getInvoiceSummary", "produces": [ "application/vnd.app.error+json", "text/plain" ], "parameters": [ { "name": "endDate", "in": "query", "description": "Only return invoice summary of projects closed before this date", "required": false, "type": "string" }, { "name": "extProjectId", "in": "query", "description": "Only return invoice summary of projects with the given external project ids. Multiple projectIds can be given as comma separated values", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of summaries to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "offset", "in": "query", "description": "The first zero-based offset summary to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the summaries by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "startDate", "in": "query", "description": "Only return invoice summary of projects closed after this date", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AppError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/report": { "get": { "tags": [ "projects" ], "summary": "getReports projects", "operationId": "projects#getReports", "produces": [ "application/vnd.projects.reports+json" ], "parameters": [ { "name": "extProjectId", "in": "query", "description": "Only return project with the given external project ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectReports" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectReports" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ProjectReports" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ProjectReports" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectReports" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}": { "get": { "tags": [ "projects" ], "summary": "get projects", "operationId": "projects#get", "produces": [ "application/vnd.app.error+json", "application/vnd.create+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AppError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "post": { "tags": [ "projects" ], "summary": "update projects", "operationId": "projects#update", "produces": [ "application/vnd.create+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateProjectData" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ProjectResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectResponse" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/buy": { "post": { "tags": [ "projects" ], "summary": "buy projects", "operationId": "projects#buy", "produces": [ "application/vnd.buyproject+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BuyProjectsPayload" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BuyProject" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BuyProject" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/BuyProject" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/BuyProject" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/BuyProject" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/close": { "post": { "tags": [ "projects" ], "summary": "close projects", "operationId": "projects#close", "produces": [ "application/vnd.project.action+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectAction" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProjectAction" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectAction" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ProjectAction" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectAction" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/detailedReport": { "get": { "tags": [ "projects" ], "summary": "getDetailedReport projects", "operationId": "projects#getDetailedReport", "produces": [ "application/vnd.projects.detailedreport+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DetailedProjectReport" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/DetailedProjectReport" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/DetailedProjectReport" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/DetailedProjectReport" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/DetailedProjectReport" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/feasibility": { "get": { "tags": [ "feasibility" ], "summary": "show feasibility", "operationId": "feasibility#show", "produces": [ "application/vnd.feasibility+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Feasibility" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Feasibility" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Feasibility" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Feasibility" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/invoices": { "get": { "tags": [ "projects" ], "summary": "invoices projects", "operationId": "projects#invoices", "produces": [ "application/vnd.app.error+json", "text/plain" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AppError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems": { "get": { "tags": [ "lineItems" ], "summary": "listLineItems lineItems", "operationId": "lineItems#listLineItems", "produces": [ "application/vnd.lineitems+json" ], "parameters": [ { "name": "countryISOCode", "in": "query", "description": "Only return line items with the given country ISO Code", "required": false, "type": "string" }, { "name": "extLineItemId", "in": "query", "description": "Only return line items with the given extLineItemId", "required": false, "type": "string" }, { "name": "extProjectId", "in": "path", "description": "External Project ID", "required": true, "type": "string" }, { "name": "languageISOCode", "in": "query", "description": "Only return line items with the given language ISO Code", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of line items to return", "required": false, "type": "integer", "default": 10, "maximum": 100, "minimum": 1 }, { "name": "offset", "in": "query", "description": "The first zero-based offset line item to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "qaState", "in": "query", "description": "Only return lineitems with the given QA state", "required": false, "type": "string" }, { "name": "sort", "in": "query", "description": "Sort the line items by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "state", "in": "query", "description": "Only return lineitems with the given state", "required": false, "type": "string" }, { "name": "stateReason", "in": "query", "description": "Only return line items with the given state reason", "required": false, "type": "string" }, { "name": "title", "in": "query", "description": "Only return line items with the given title", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LineItems" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/LineItems" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/LineItems" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/LineItems" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "post": { "tags": [ "lineItems" ], "summary": "create lineItems", "operationId": "lineItems#create", "produces": [ "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LineItemData" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateLineItem" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}": { "get": { "tags": [ "lineItems" ], "summary": "get lineItems", "operationId": "lineItems#get", "produces": [ "application/vnd.app.error+json", "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AppError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "post": { "tags": [ "lineItems" ], "summary": "update lineItems", "operationId": "lineItems#update", "produces": [ "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateLineItem" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateLineItem" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/close": { "post": { "tags": [ "lineItems" ], "summary": "close lineItems", "operationId": "lineItems#close", "produces": [ "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateLineItem" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/detailedReport": { "get": { "tags": [ "lineItems" ], "summary": "getDetailedLineItemReport lineItems", "operationId": "lineItems#getDetailedLineItemReport", "produces": [ "application/vnd.getdetailedlineitemreport+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DetailedLineItemReport" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/DetailedLineItemReport" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/DetailedLineItemReport" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/DetailedLineItemReport" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/DetailedLineItemReport" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/launch": { "post": { "tags": [ "lineItems" ], "summary": "launch lineItems", "operationId": "lineItems#launch", "produces": [ "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateLineItem" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/pause": { "post": { "tags": [ "lineItems" ], "summary": "pause lineItems", "operationId": "lineItems#pause", "produces": [ "application/vnd.createlineitem+json" ], "parameters": [ { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/CreateLineItem" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CreateLineItem" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/lineItems/{extLineItemId}/quotaCells/{quotaCellId}/{action}": { "post": { "tags": [ "lineItems" ], "summary": "setQuotaCellStatus lineItems", "operationId": "lineItems#setQuotaCellStatus", "produces": [ "application/vnd.quotacellstatus+json" ], "parameters": [ { "name": "action", "in": "path", "required": true, "type": "string" }, { "name": "extLineItemId", "in": "path", "required": true, "type": "string" }, { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "quotaCellId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QuotaCellStatus" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/QuotaCellStatus" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/QuotaCellStatus" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/QuotaCellStatus" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/permissions": { "get": { "tags": [ "projects" ], "summary": "getPermissions projects", "operationId": "projects#getPermissions", "produces": [ "application/vnd.userpermissions+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Permissions" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Permissions" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Permissions" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Permissions" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Permissions" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Permissions" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "post": { "tags": [ "projects" ], "summary": "updatePermissions projects", "operationId": "projects#updatePermissions", "produces": [ "application/vnd.userpermissions+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdatePermissions" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Permissions" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Permissions" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Permissions" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Permissions" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Permissions" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Permissions" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/reconcile": { "post": { "tags": [ "projects" ], "summary": "reconcile projects", "operationId": "projects#reconcile", "consumes": [ "multipart/form-data" ], "produces": [ "application/vnd.app.error+json", "application/vnd.projects.reconcile+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "file", "in": "formData", "description": "File", "required": true, "type": "file" }, { "name": "message", "in": "formData", "description": "Message", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Reconcile" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/AppError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/report": { "get": { "tags": [ "projects" ], "summary": "getReport projects", "operationId": "projects#getReport", "produces": [ "application/vnd.projects.report+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectReport" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectReport" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ProjectReport" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ProjectReport" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectReport" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/projects/{extProjectId}/surveys/{surveyId}/links": { "get": { "tags": [ "projects" ], "summary": "getSurveyEndLinks projects", "operationId": "projects#getSurveyEndLinks", "produces": [ "application/vnd.projects.survey.endlinks+json" ], "parameters": [ { "name": "extProjectId", "in": "path", "required": true, "type": "string" }, { "name": "surveyId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProjectSurveyEndLinks" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ProjectSurveyEndLinks" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ProjectSurveyEndLinks" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ProjectSurveyEndLinks" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/roles": { "get": { "tags": [ "roles" ], "summary": "getRoles roles", "operationId": "roles#getRoles", "produces": [ "application/vnd.rolesinfo+json" ], "parameters": [ { "name": "id", "in": "query", "description": "Only return roles with the given id or ids", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "Only return roles with the given name", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Roles" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Roles" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Roles" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/sources": { "get": { "tags": [ "sampleSources" ], "summary": "list sampleSources", "operationId": "sampleSources#list", "produces": [ "application/vnd.samplesources+json" ], "parameters": [ { "name": "countryISOCode", "in": "query", "description": "Only return sources applicable for the given country code", "required": false, "type": "string" }, { "name": "deliverySystem", "in": "query", "description": "Only return source with the given source", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "Only return sources with the given id", "required": false, "type": "string" }, { "name": "languageISOCode", "in": "query", "description": "Only return sources applicable for the given language code", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of sources to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "name", "in": "query", "description": "Only return sources with the given name", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The first zero-based offset source to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the sources by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "surveyTopic", "in": "query", "description": "Only return sources with the given surveyTopic", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SampleSources" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/SampleSources" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/SampleSources" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/studyMetadata": { "get": { "tags": [ "studyMetadata" ], "summary": "list studyMetadata", "operationId": "studyMetadata#list", "produces": [ "application/vnd.studymetadata+json" ], "parameters": [ { "name": "description", "in": "query", "description": "Only return categories with the given description", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "Only return categories with the given id", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of studyMetadata to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "name", "in": "query", "description": "Only return categories with the given name", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The first zero-based offset studyMetadata to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the studyMetadata by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StudyMetadata" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/StudyMetadata" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/StudyMetadata" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/teams": { "get": { "tags": [ "teams" ], "summary": "getTeamsInfo teams", "operationId": "teams#getTeamsInfo", "produces": [ "application/vnd.teams+json" ], "parameters": [ { "name": "id", "in": "query", "description": "Only return teams with the given company id", "required": false, "type": "integer" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Teams" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Teams" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Teams" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/templates/quotaPlan": { "post": { "tags": [ "audienceTemplates" ], "summary": "create audienceTemplates", "operationId": "audienceTemplates#create", "produces": [ "application/vnd.app.error+json", "application/vnd.template+json" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateTemplate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Template" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/templates/quotaPlan/{countryIsoCode}/{languageIsoCode}": { "get": { "tags": [ "audienceTemplates" ], "summary": "list audienceTemplates", "operationId": "audienceTemplates#list", "produces": [ "application/vnd.app.error+json", "application/vnd.templates+json" ], "parameters": [ { "name": "countryIsoCode", "in": "path", "required": true, "type": "string" }, { "name": "createdAt", "in": "query", "description": "return templates with createdAt date range", "required": false, "type": "string" }, { "name": "editable", "in": "query", "description": "return templates with the given value for editable flag", "required": false, "type": "boolean" }, { "name": "id", "in": "query", "description": "Only return template with the given id", "required": false, "type": "string" }, { "name": "languageIsoCode", "in": "path", "required": true, "type": "string" }, { "name": "limit", "in": "query", "description": "Maximum number of templates to return", "required": false, "type": "integer", "default": 10, "maximum": 1000, "minimum": 1 }, { "name": "name", "in": "query", "description": "Only return templates matching the given name", "required": false, "type": "string" }, { "name": "offset", "in": "query", "description": "The first zero-based offset template to return", "required": false, "type": "integer", "default": 0, "minimum": 0 }, { "name": "sort", "in": "query", "description": "Sort the templates by the given key(s)", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "state", "in": "query", "description": "Only return templates with the given state", "required": false, "type": "string" }, { "name": "tags", "in": "query", "description": "return templates with the given tags", "required": false, "type": "string" }, { "name": "updatedAt", "in": "query", "description": "return templates with updatedAt date range", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Templates" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/templates/quotaPlan/{templateId}": { "post": { "tags": [ "audienceTemplates" ], "summary": "update audienceTemplates", "operationId": "audienceTemplates#update", "produces": [ "application/vnd.app.error+json", "application/vnd.template+json" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "type": "string" }, { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateTemplate" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Template" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] }, "delete": { "tags": [ "audienceTemplates" ], "summary": "delete audienceTemplates", "operationId": "audienceTemplates#delete", "produces": [ "application/vnd.app.error+json" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AppError" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AppError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/AppError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/AppError" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/user": { "get": { "tags": [ "user" ], "summary": "getUser user", "operationId": "user#getUser", "produces": [ "application/vnd.user+json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/User" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/User" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/User" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/users": { "get": { "tags": [ "users" ], "summary": "CompanyUsers users", "operationId": "users#CompanyUsers", "produces": [ "application/vnd.companyusers+json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CompanyUsers" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/CompanyUsers" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/CompanyUsers" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/sample/v1/users/info": { "get": { "tags": [ "users" ], "summary": "getUserInfo users", "operationId": "users#getUserInfo", "produces": [ "application/vnd.userinfo+json" ], "parameters": [ { "name": "appId", "in": "query", "description": "Only return apps with the given id", "required": false, "type": "integer" }, { "name": "current", "in": "query", "description": "Only return current app for the user id", "required": false, "type": "boolean" }, { "name": "default", "in": "query", "description": "Only return default app for the user id", "required": false, "type": "boolean" }, { "name": "name", "in": "query", "description": "Only return apps with the given name", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserInfo" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/UserInfo" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/UserInfo" } } }, "schemes": [ "http" ], "security": [ { "jwt": [] } ] } }, "/swagger.json": { "get": { "summary": "Download public/swagger/swagger.json", "operationId": "swagger#/swagger.json", "responses": { "200": { "description": "File downloaded", "schema": { "type": "file" } } }, "schemes": [ "http" ] } }, "/swagger.yaml": { "get": { "summary": "Download public/swagger/swagger.yaml", "operationId": "swagger#/swagger.yaml", "responses": { "200": { "description": "File downloaded", "schema": { "type": "file" } } }, "schemes": [ "http" ] } } }, "definitions": { "AllowedActionsData": { "title": "AllowedActionsData", "type": "object", "properties": { "action": { "type": "string", "description": "Action name", "example": "UPDATE PROJECT" }, "description": { "type": "string", "description": "Role description", "example": "Updating a Project" }, "id": { "type": "string", "description": "Unique Action ID", "example": "CREATE_PROJECT" } }, "example": { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, "required": [ "id", "action", "description" ] }, "AppError": { "title": "Mediatype identifier: application/vnd.app.error+json; view=default", "type": "object", "properties": { "data": { "description": "Data", "example": "-" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "AppError media type (default view)", "example": { "data": "-", "meta": "-", "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ApplicationItemData": { "title": "ApplicationItemData", "type": "object", "properties": { "appId": { "type": "integer", "description": "A unique identifier for your application", "example": 1, "format": "int64" }, "current": { "type": "boolean", "description": "Is this the current application for the user", "example": true }, "default": { "type": "boolean", "description": "Is this the default application for the user", "example": false }, "name": { "type": "string", "description": "Application name", "example": "AppCity" } }, "example": { "appId": 1, "current": true, "default": false, "name": "AppCity" }, "required": [ "appId", "name", "current", "default" ] }, "AttrCategory": { "title": "AttrCategory", "type": "object", "properties": { "id": { "type": "string", "description": "Category Id", "example": "REGION" }, "localizedText": { "type": "string", "description": "Localized Category text", "example": "Region" }, "text": { "type": "string", "description": "Category text", "example": "Region" } }, "example": { "id": "REGION", "localizedText": "Region", "text": "Region" }, "required": [ "id", "text", "localizedText" ] }, "AttributeCategory": { "title": "AttributeCategory", "type": "object", "properties": { "mainCategory": { "$ref": "#/definitions/AttrCategory" }, "subCategory": { "$ref": "#/definitions/AttrCategory" } }, "example": { "mainCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" }, "subCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" } } }, "AttributeData": { "title": "AttributeData", "type": "object", "properties": { "category": { "$ref": "#/definitions/AttributeCategory" }, "exclusions": { "type": "array", "items": { "type": "string", "example": "Saepe officiis." }, "description": "List of mutually exclusive attribute Ids", "example": [ "Saepe officiis." ] }, "extras": { "type": "object", "description": "Attribute extra metadata", "example": { "Sint dolorem et.": "Similique nihil deserunt." }, "additionalProperties": true }, "format": { "type": "string", "description": "Regex for validation", "example": "^d{4}$" }, "id": { "type": "string", "description": "Unique attribute ID", "example": "11" }, "isAllowedInFilters": { "type": "boolean", "description": "Is allowed in filters", "example": true }, "isAllowedInQuotas": { "type": "boolean", "description": "Is allowed in quotas", "example": false }, "isAllowedInSurveyAppends": { "type": "boolean", "description": "Is allowed in survey appends", "example": true }, "localizedText": { "type": "string", "description": "Localized attribute text", "example": "What is your gender?" }, "name": { "type": "string", "description": "Attribute name", "example": "Gender" }, "options": { "type": "array", "items": { "$ref": "#/definitions/AttributeOption" }, "example": [ { "id": "11", "localizedText": "Male", "text": "Male" } ] }, "state": { "type": "string", "description": "Attribute state", "example": "ACTIVE", "enum": [ "ACTIVE", "DEPRECATED", "INACTIVE" ] }, "text": { "type": "string", "description": "Attribute text", "example": "What is your gender?" }, "tier": { "type": "string", "description": "Attribute pricing tier", "example": "Standard" }, "type": { "type": "string", "description": "Attribute type", "example": "LIST", "enum": [ "LIST", "INTEGER", "STRING", "INTEGER_RANGE" ] } }, "example": { "category": { "mainCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" }, "subCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" } }, "exclusions": [ "Saepe officiis." ], "extras": { "Sint dolorem et.": "Similique nihil deserunt." }, "format": "^d{4}$", "id": "11", "isAllowedInFilters": true, "isAllowedInQuotas": false, "isAllowedInSurveyAppends": true, "localizedText": "What is your gender?", "name": "Gender", "options": [ { "id": "11", "localizedText": "Male", "text": "Male" } ], "state": "ACTIVE", "text": "What is your gender?", "tier": "Standard", "type": "LIST" }, "required": [ "id", "name", "text", "localizedText", "type", "isAllowedInFilters", "isAllowedInQuotas", "state", "isAllowedInSurveyAppends" ] }, "AttributeOption": { "title": "AttributeOption", "type": "object", "properties": { "id": { "type": "string", "description": "Unique Option ID (within an attribute)", "example": "11" }, "localizedText": { "type": "string", "description": "Localized option text", "example": "Male" }, "text": { "type": "string", "description": "Option text", "example": "Male" } }, "example": { "id": "11", "localizedText": "Male", "text": "Male" }, "required": [ "id", "text", "localizedText" ] }, "Attributes": { "title": "Mediatype identifier: application/vnd.attributes+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/AttributeData" }, "example": [ { "category": { "mainCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" }, "subCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" } }, "exclusions": [ "Saepe officiis." ], "extras": { "Sint dolorem et.": "Similique nihil deserunt." }, "format": "^d{4}$", "id": "11", "isAllowedInFilters": true, "isAllowedInQuotas": false, "isAllowedInSurveyAppends": true, "localizedText": "What is your gender?", "name": "Gender", "options": [ { "id": "11", "localizedText": "Male", "text": "Male" } ], "state": "ACTIVE", "text": "What is your gender?", "tier": "Standard", "type": "LIST" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Attributes media type (default view)", "example": { "data": [ { "category": { "mainCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" }, "subCategory": { "id": "REGION", "localizedText": "Region", "text": "Region" } }, "exclusions": [ "Saepe officiis." ], "extras": { "Sint dolorem et.": "Similique nihil deserunt." }, "format": "^d{4}$", "id": "11", "isAllowedInFilters": true, "isAllowedInQuotas": false, "isAllowedInSurveyAppends": true, "localizedText": "What is your gender?", "name": "Gender", "options": [ { "id": "11", "localizedText": "Male", "text": "Male" } ], "state": "ACTIVE", "text": "What is your gender?", "tier": "Standard", "type": "LIST" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "AuthError": { "title": "Mediatype identifier: application/vnd.auth.error+json; view=default", "type": "object", "properties": { "error": { "type": "string", "description": "Error code", "example": "Quis est atque et alias dolorem." }, "errorDescription": { "type": "string", "description": "Error description", "example": "Ullam alias quia quos eum quae." } }, "description": "AuthError media type (default view)", "example": { "error": "Quis est atque et alias dolorem.", "errorDescription": "Ullam alias quia quos eum quae." }, "required": [ "error", "errorDescription" ] }, "Author": { "title": "Author", "type": "object", "properties": { "name": { "type": "string", "description": "Name of author", "example": "Repellat ad saepe minima tempora nam." }, "type": { "type": "string", "description": "User type descriptor", "example": "api", "enum": [ "regular", "api" ] }, "username": { "type": "string", "description": "Username of author", "example": "Vel ut omnis est sed sit." } }, "example": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "required": [ "username", "name", "type" ] }, "Billing": { "title": "Billing", "type": "object", "properties": { "billingDate": { "type": "string", "description": "Date of billing", "example": "Dolorem in ad tenetur veritatis." }, "billingID": { "type": "string", "description": "Unique ID for the bill", "example": "Sed cum voluptas." }, "type": { "type": "string", "description": "Billing type descriptor", "example": "AGGREGATED_MONTHLY", "enum": [ "AGGREGATED_MONTHLY", "PER_PROJECT" ] } }, "example": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "required": [ "billingID", "type", "billingDate" ] }, "BuyProject": { "title": "Mediatype identifier: application/vnd.buyproject+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/BuyProjectResponse" }, "example": [ { "extLineItemId": "Vitae harum quia omnis.", "state": "Ipsam saepe dolore et numquam dolorem." } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "BuyProject media type (default view)", "example": { "data": [ { "extLineItemId": "Vitae harum quia omnis.", "state": "Ipsam saepe dolore et numquam dolorem." } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "BuyProjectItem": { "title": "BuyProjectItem", "type": "object", "properties": { "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "Odit laudantium non sunt consequatur et." }, "surveyTestURL": { "type": "string", "description": "Survey Test URL. Required for survey verification", "example": "Et perferendis." }, "surveyTestURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyTestURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "surveyTestingNotes": { "type": "string", "description": "Survey testing notes", "example": "Omnis debitis voluptatem eos earum harum in." }, "surveyURL": { "type": "string", "description": "Survey URL to send panelist into", "example": "Iste nostrum vel ab adipisci commodi reprehenderit." }, "surveyURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] } }, "example": { "extLineItemId": "Odit laudantium non sunt consequatur et.", "surveyTestURL": "Et perferendis.", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Omnis debitis voluptatem eos earum harum in.", "surveyURL": "Iste nostrum vel ab adipisci commodi reprehenderit.", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "required": [ "extLineItemId", "surveyURL", "surveyTestURL" ] }, "BuyProjectResponse": { "title": "BuyProjectResponse", "type": "object", "properties": { "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "Vitae harum quia omnis." }, "state": { "type": "string", "description": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "example": "Ipsam saepe dolore et numquam dolorem." } }, "example": { "extLineItemId": "Vitae harum quia omnis.", "state": "Ipsam saepe dolore et numquam dolorem." } }, "BuyProjectsPayload": { "title": "BuyProjectsPayload", "type": "array", "items": { "$ref": "#/definitions/BuyProjectItem" }, "example": [ { "extLineItemId": "Odit laudantium non sunt consequatur et.", "surveyTestURL": "Et perferendis.", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Omnis debitis voluptatem eos earum harum in.", "surveyURL": "Iste nostrum vel ab adipisci commodi reprehenderit.", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, { "extLineItemId": "Odit laudantium non sunt consequatur et.", "surveyTestURL": "Et perferendis.", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Omnis debitis voluptatem eos earum harum in.", "surveyURL": "Iste nostrum vel ab adipisci commodi reprehenderit.", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] } ] }, "Categories": { "title": "Mediatype identifier: application/vnd.categories+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/CategoryData" }, "example": [ { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" }, { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" }, { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Categories media type (default view)", "example": { "data": [ { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" }, { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" }, { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "CategoryData": { "title": "CategoryData", "type": "object", "properties": { "description": { "type": "string", "description": "Category Description", "example": "Carbonated beverages" }, "topic": { "type": "string", "description": "Category Enum", "example": "BEVERAGES_NON_ALCOHOLIC" } }, "example": { "description": "Carbonated beverages", "topic": "BEVERAGES_NON_ALCOHOLIC" }, "required": [ "topic", "description" ] }, "CategoryMetadata": { "title": "CategoryMetadata", "type": "object", "properties": { "studyRequirements": { "type": "array", "items": { "$ref": "#/definitions/StudyMetadataItem" }, "description": "Study requirements", "example": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "studyTypes": { "type": "array", "items": { "$ref": "#/definitions/StudyMetadataItem" }, "description": "Study types", "example": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "surveyTopics": { "type": "array", "items": { "$ref": "#/definitions/StudyMetadataItem" }, "description": "Survey topics", "example": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] } }, "example": { "studyRequirements": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "studyTypes": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "surveyTopics": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "required": [ "surveyTopics", "studyTypes", "studyRequirements" ] }, "ChannelDistribution": { "title": "ChannelDistribution", "type": "object", "properties": { "integratedChannelPercent": { "type": "integer", "description": "percent of integrated channel distribution (sum of open, loyalty and integrated should be 100)", "example": 44, "format": "int64" }, "loyaltyChannelPercent": { "type": "integer", "description": "percent of loyalty channel distribution (sum of open, loyalty and integrated should be 100)", "example": 10, "format": "int64" }, "openChannelPercent": { "type": "integer", "description": "percent of open channel distribution (sum of open, loyalty and integrated should be 100)", "example": 46, "format": "int64" } }, "example": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 } }, "CheckOrderNumber": { "title": "Mediatype identifier: application/vnd.checkordernumber+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/CheckOrderNumberResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "CheckOrderNumber media type (default view)", "example": { "data": { "availability": true, "errors": [ { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" } ] }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "CheckOrderNumberResponseData": { "title": "CheckOrderNumberResponseData", "type": "object", "properties": { "availability": { "type": "boolean", "description": "availability", "example": true }, "errors": { "type": "array", "items": { "$ref": "#/definitions/Errors" }, "description": "errors", "example": [ { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" } ] } }, "example": { "availability": true, "errors": [ { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" }, { "message": "msg", "path": "path", "status": "100" } ] }, "required": [ "availability" ] }, "CodePayload": { "title": "CodePayload", "type": "object", "properties": { "clientId": { "type": "string", "description": "Client ID", "example": "app1" }, "clientSecret": { "type": "string", "description": "Client Secret", "example": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578" }, "code": { "type": "string", "description": "Authorization Code", "example": "eyJhbGciOiJkaXIiLCJlbmMi...CGkT8cqn9TZ.zjwOC-3m_seUOq6agdZyJA" }, "redirectURI": { "type": "string", "description": "Redirect URI", "example": "http://localhost/callback" } }, "example": { "clientId": "app1", "clientSecret": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578", "code": "eyJhbGciOiJkaXIiLCJlbmMi...CGkT8cqn9TZ.zjwOC-3m_seUOq6agdZyJA", "redirectURI": "http://localhost/callback" }, "required": [ "clientId", "redirectURI", "code" ] }, "CompanyData": { "title": "CompanyData", "type": "object", "properties": { "default": { "type": "boolean", "description": "set to true if the company is default for the user", "example": false }, "defaultRole": { "type": "string", "description": "Default role of the user for the company", "example": "PROJECT_MANAGER" }, "id": { "type": "integer", "description": "Unique company ID", "example": 1, "format": "int64" }, "name": { "type": "string", "description": "Company name", "example": "Test Company" }, "teams": { "type": "array", "items": { "$ref": "#/definitions/TeamData" }, "description": "List of teams for the a company.", "example": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] } }, "example": { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] }, "required": [ "id", "name", "default", "defaultRole", "teams" ] }, "CompanyUsers": { "title": "Mediatype identifier: application/vnd.companyusers+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/UsersItemData" }, "example": [ { "email": "sample.user@dynata.com", "id": 1, "name": "Sample User", "userName": "sample_user" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "CompanyUsers media type (default view)", "example": { "data": [ { "email": "sample.user@dynata.com", "id": 1, "name": "Sample User", "userName": "sample_user" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "Cost": { "title": "Cost", "type": "object", "properties": { "costPerUnit": { "type": "number", "description": "Amount Research Now SSI will be paid for each delivered complete", "example": 2.5, "format": "double" }, "currency": { "type": "string", "description": "Currency ISO code", "example": "Maxime accusamus ut enim praesentium sunt ut." }, "detailedCost": { "type": "array", "items": { "$ref": "#/definitions/DetailedCost" }, "description": "Detailed cost with price breakdown", "example": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ] }, "estimatedCost": { "type": "number", "description": "Total estimated cost for the lineitem", "example": 2.5, "format": "double" }, "incurredCost": { "type": "number", "description": "Total incurred cost for the lineitem", "example": 2.5, "format": "double" } }, "example": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "required": [ "costPerUnit", "currency", "estimatedCost", "incurredCost" ] }, "Countries": { "title": "Mediatype identifier: application/vnd.countries+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/CountryData" }, "example": [ { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] }, { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] }, { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Countries media type (default view)", "example": { "data": [ { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] }, { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] }, { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "CountryData": { "title": "CountryData", "type": "object", "properties": { "countryName": { "type": "string", "description": "Unique country ID", "example": "United States" }, "id": { "type": "string", "description": "Unique country ID", "example": "US" }, "isoCode": { "type": "string", "description": "ISO country code", "example": "US" }, "supportedLanguages": { "type": "array", "items": { "$ref": "#/definitions/SupportedLanguage" }, "example": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] } }, "example": { "countryName": "United States", "id": "US", "isoCode": "US", "supportedLanguages": [ { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" }, { "id": "en", "isoCode": "en", "languageName": "English" } ] }, "required": [ "id", "countryName", "isoCode" ] }, "CreateLineItem": { "title": "Mediatype identifier: application/vnd.createlineitem+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/LineItemResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "CreateLineItem media type (default view)", "example": { "data": { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "CreateProject": { "title": "Mediatype identifier: application/vnd.createproject+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/CreateProjectData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "CreateProject media type (default view)", "example": { "data": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "CreateProjectData": { "title": "CreateProjectData", "type": "object", "properties": { "webhookId": { "type": "string", "description": "Webhook message ID", "example": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" } }, "example": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "required": [ "webhookId" ] }, "CreateProjectPayload": { "title": "CreateProjectPayload", "type": "object", "properties": { "errorMsg": { "type": "string", "description": "Error Msg", "example": "error" }, "orderNumber": { "type": "string", "description": "order number", "example": "ORD001" }, "projectId": { "type": "integer", "description": "Project ID", "example": 1041433017720642000, "format": "int64" }, "quotaGroups": { "type": "array", "items": { "$ref": "#/definitions/QuotaGroupDat" }, "description": "Quota groups within this line item", "example": [ { "lineItemId": "Hic aut voluptatum.", "pickerEventId": 2196069144215630800, "quotaGroupId": 3337713534643430400, "salesOrderDetailId": "Labore suscipit fugiat.", "surveyId": 6497709257602905000 } ] }, "quoteId": { "type": "string", "description": "quote id", "example": "Q001" }, "requestId": { "type": "string", "description": "Request ID", "example": "request001" }, "salesOrderId": { "type": "string", "description": "Sales order ID", "example": "Sales001" }, "status": { "type": "string", "description": "Status", "example": "FINISHED" } }, "example": { "errorMsg": "error", "orderNumber": "ORD001", "projectId": 1041433017720642000, "quotaGroups": [ { "lineItemId": "Hic aut voluptatum.", "pickerEventId": 2196069144215630800, "quotaGroupId": 3337713534643430400, "salesOrderDetailId": "Labore suscipit fugiat.", "surveyId": 6497709257602905000 } ], "quoteId": "Q001", "requestId": "request001", "salesOrderId": "Sales001", "status": "FINISHED" }, "required": [ "requestId", "projectId", "status" ] }, "CreateTemplate": { "title": "CreateTemplate", "type": "object", "properties": { "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "description": { "type": "string", "description": "Template description", "example": "Targeting template for US census" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "name": { "type": "string", "description": "Template name", "example": "US Census" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanTemplate" }, "tags": { "type": "array", "items": { "type": "string", "example": "Iure consequatur ut qui." }, "description": "Tags to identify the template", "example": [ "Iure consequatur ut qui.", "Iure consequatur ut qui." ] } }, "example": { "countryISOCode": "US", "description": "Targeting template for US census", "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "tags": [ "Iure consequatur ut qui.", "Iure consequatur ut qui." ] }, "required": [ "name", "countryISOCode", "languageISOCode", "quotaPlan" ] }, "CurrentUser": { "title": "CurrentUser", "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string", "example": "Cum sequi voluptatem." }, "description": "List of roles of current user", "example": [ "Cum sequi voluptatem.", "Cum sequi voluptatem.", "Cum sequi voluptatem." ] } }, "example": { "roles": [ "Cum sequi voluptatem.", "Cum sequi voluptatem.", "Cum sequi voluptatem." ] }, "required": [ "roles" ] }, "DetailedCost": { "title": "DetailedCost", "type": "object", "properties": { "costPerUnit": { "type": "number", "description": "Amount Research Now SSI will be paid for each delivered complete", "example": 2.5, "format": "double" }, "deliveredUnits": { "type": "integer", "description": "Total requested completes for the lineitem", "example": 7183024892128393000, "format": "int64" }, "estimatedCost": { "type": "number", "description": "Estimated cost for the quote detail", "example": 2.5, "format": "double" }, "incurredCost": { "type": "number", "description": "Total incurred cost for the lineitem", "example": 2.5, "format": "double" }, "requestedUnits": { "type": "integer", "description": "Total requested completes for the lineitem", "example": 7192736386140151000, "format": "int64" }, "title": { "type": "string", "description": "Title of the quote detail", "example": "Fugit quaerat vero omnis eligendi qui suscipit." }, "type": { "type": "string", "description": "Type of the quote detail: BASIC, PREMIUM", "example": "BASE", "enum": [ "BASE", "PREMIUM" ] } }, "example": { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, "required": [ "costPerUnit", "estimatedCost", "incurredCost", "title", "type", "requestedUnits", "deliveredUnits" ] }, "DetailedLineItemReport": { "title": "Mediatype identifier: application/vnd.getdetailedlineitemreport+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/DetailedLineItemReportData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "DetailedLineItemReport media type (default view)", "example": { "data": { "cost": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "countryISOCode": "US", "extLineItemId": "lineItem001", "languageISOCode": "en", "quotaGroups": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "LAUNCHED", "stateReason": "Project completed", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Social Research study" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "DetailedLineItemReportData": { "title": "DetailedLineItemReportData", "type": "object", "properties": { "cost": { "$ref": "#/definitions/Cost" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "lineItem001" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "quotaGroups": { "type": "array", "items": { "$ref": "#/definitions/DetailedQuotaGroupReportData" }, "description": "quota group report details for the lineitem", "example": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ] }, "sources": { "type": "array", "items": { "$ref": "#/definitions/LineItemSource" }, "description": "id of the source where is the sample coming from", "example": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ] }, "state": { "type": "string", "description": "The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED", "example": "LAUNCHED", "enum": [ "PROVISIONED", "AWAITING_APPROVAL", "AWAITING_CLIENT_APPROVAL", "QA_APPROVED", "LAUNCHED", "PAUSED", "CLOSED", "INVOICED", "CANCELLED", "REJECTED" ] }, "stateReason": { "type": "string", "description": "The current state reason of the project", "example": "Project completed" }, "stats": { "$ref": "#/definitions/DetailedStats" }, "title": { "type": "string", "description": "LineItem title", "example": "US Social Research study" } }, "example": { "cost": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "countryISOCode": "US", "extLineItemId": "lineItem001", "languageISOCode": "en", "quotaGroups": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "LAUNCHED", "stateReason": "Project completed", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Social Research study" }, "required": [ "extLineItemId", "countryISOCode", "languageISOCode", "state", "stateReason", "title", "sources", "stats", "cost" ] }, "DetailedProjectReport": { "title": "Mediatype identifier: application/vnd.projects.detailedreport+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/DetailedProjectReportData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "DetailedProjectReport media type (default view)", "example": { "data": { "cost": { "currency": "Voluptas aliquam harum amet voluptatibus est.", "estimatedCost": 2.5, "incurredCost": 2.5 }, "extProjectId": "project001", "jobNumber": "dynata123", "lineItems": [ { "cost": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "countryISOCode": "US", "extLineItemId": "lineItem001", "languageISOCode": "en", "quotaGroups": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "LAUNCHED", "stateReason": "Project completed", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Social Research study" } ], "state": "LAUNCHED", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Test Survey" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "DetailedProjectReportData": { "title": "DetailedProjectReportData", "type": "object", "properties": { "cost": { "$ref": "#/definitions/ProjectCost" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "jobNumber": { "type": "string", "description": "Project job number", "example": "dynata123" }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/DetailedLineItemReportData" }, "example": [ { "cost": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "countryISOCode": "US", "extLineItemId": "lineItem001", "languageISOCode": "en", "quotaGroups": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "LAUNCHED", "stateReason": "Project completed", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Social Research study" } ] }, "state": { "type": "string", "description": "The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED", "example": "LAUNCHED", "enum": [ "PROVISIONED", "LAUNCHED", "CLOSED", "INVOICED", "COMPLETED", "CANCELLED" ] }, "stats": { "$ref": "#/definitions/DetailedStats" }, "title": { "type": "string", "description": "Project Title", "example": "US Test Survey" } }, "example": { "cost": { "currency": "Voluptas aliquam harum amet voluptatibus est.", "estimatedCost": 2.5, "incurredCost": 2.5 }, "extProjectId": "project001", "jobNumber": "dynata123", "lineItems": [ { "cost": { "costPerUnit": 2.5, "currency": "Maxime accusamus ut enim praesentium sunt ut.", "detailedCost": [ { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" }, { "costPerUnit": 2.5, "deliveredUnits": 7183024892128393000, "estimatedCost": 2.5, "incurredCost": 2.5, "requestedUnits": 7192736386140151000, "title": "Fugit quaerat vero omnis eligendi qui suscipit.", "type": "BASE" } ], "estimatedCost": 2.5, "incurredCost": 2.5 }, "countryISOCode": "US", "extLineItemId": "lineItem001", "languageISOCode": "en", "quotaGroups": [ { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "LAUNCHED", "stateReason": "Project completed", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Social Research study" } ], "state": "LAUNCHED", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "title": "US Test Survey" }, "required": [ "extProjectId", "state", "title", "cost", "stats", "lineItems" ] }, "DetailedQuotaCellReportData": { "title": "DetailedQuotaCellReportData", "type": "object", "properties": { "quotaCellId": { "type": "string", "description": "ID of the quota cell", "example": "Eos exercitationem." }, "quotaNodes": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "description": "nodes in the cell.", "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, "stats": { "$ref": "#/definitions/DetailedStats" } }, "example": { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, "required": [ "quotaCellId", "quotaNodes", "stats" ] }, "DetailedQuotaGroupReportData": { "title": "DetailedQuotaGroupReportData", "type": "object", "properties": { "quotaCells": { "type": "array", "items": { "$ref": "#/definitions/DetailedQuotaCellReportData" }, "description": "quota group report details for the lineitem", "example": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ] }, "quotaGroupId": { "type": "string", "description": "ID of the quota group", "example": "Similique culpa." }, "stats": { "$ref": "#/definitions/DetailedStats" } }, "example": { "quotaCells": [ { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, { "quotaCellId": "Eos exercitationem.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } } ], "quotaGroupId": "Similique culpa.", "stats": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 } }, "required": [ "quotaGroupId", "stats", "quotaCells" ] }, "DetailedQuote": { "title": "DetailedQuote", "type": "object", "properties": { "costPerUnit": { "type": "number", "description": "Amount Research Now SSI will be paid for each delivered complete", "example": 2.5, "format": "double" }, "estimatedCost": { "type": "number", "description": "Estimated cost for the quote detail", "example": 2.5, "format": "double" }, "title": { "type": "string", "description": "Title of the quote detail", "example": "Fuga omnis sunt et veritatis sunt." }, "type": { "type": "string", "description": "Type of the quote detail: BASE, PREMIUM", "example": "PREMIUM", "enum": [ "BASE", "PREMIUM" ] }, "units": { "type": "integer", "description": "Total requested completes for the lineitem", "example": 7491021699759007000, "format": "int64" } }, "example": { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } }, "DetailedStats": { "title": "DetailedStats", "type": "object", "properties": { "actualMedianLOI": { "type": "integer", "description": "Calculated median length of interview from actual panelists", "example": 20, "format": "int64" }, "attempts": { "type": "integer", "description": "Total number of panelists that entered the project", "example": 300, "format": "int64" }, "completes": { "type": "integer", "description": "Total number of panelists that completed the project", "example": 100, "format": "int64" }, "completesRefused": { "type": "integer", "description": "Total number of panelists that refused to complete the project", "example": 100, "format": "int64" }, "completesRefusedPercentage": { "type": "number", "description": "Percentage of completes refused over attempts.", "example": 30, "format": "double" }, "conversion": { "type": "number", "description": "Ratio of completes over attempts. (ranges from 0-1)", "example": 30, "format": "double" }, "incidenceRate": { "type": "number", "description": "Incidence rate", "example": 30, "format": "double" }, "incompletes": { "type": "integer", "description": "Total number of panelists that dropped the project", "example": 100, "format": "int64" }, "incompletesPercentage": { "type": "number", "description": "Percentage of incompletes over attempts.", "example": 30, "format": "double" }, "lastAcceptedIncidenceRate": { "type": "number", "description": "Last accepted incidence rate", "example": 12.34, "format": "double" }, "lastAcceptedLOI": { "type": "integer", "description": "Last accepted length of interview", "example": 10, "format": "int64" }, "overquotas": { "type": "integer", "description": "Total number of panelists that triggered an overquota for the project", "example": 100, "format": "int64" }, "overquotasPercentage": { "type": "number", "description": "Percentage of overquotas over attempts.", "example": 30, "format": "double" }, "remainingCompletes": { "type": "integer", "description": "Total remaining completes for the project", "example": 200, "format": "int64" }, "screenouts": { "type": "integer", "description": "Total number of panelists that got screened out of the project", "example": 100, "format": "int64" }, "screenoutsPercentage": { "type": "number", "description": "Percentage of screenouts over attempts.", "example": 30, "format": "double" } }, "example": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "completesRefusedPercentage": 30, "conversion": 30, "incidenceRate": 30, "incompletes": 100, "incompletesPercentage": 30, "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "overquotasPercentage": 30, "remainingCompletes": 200, "screenouts": 100, "screenoutsPercentage": 30 }, "required": [ "attempts", "completes", "screenouts", "screenoutsPercentage", "overquotas", "overquotasPercentage", "incompletes", "incompletesPercentage", "completesRefused", "completesRefusedPercentage", "conversion", "incidenceRate", "remainingCompletes" ] }, "EndLinks": { "title": "EndLinks", "type": "object", "properties": { "complete": { "type": "string", "description": "Complete link URL", "example": "Delectus omnis placeat repudiandae sunt pariatur." }, "overquota": { "type": "string", "description": "Over quota link URL", "example": "Non sed." }, "screenout": { "type": "string", "description": "Screen out link URL", "example": "Consequuntur architecto saepe." }, "securityKey1": { "type": "string", "description": "Security Key 1", "example": "Nulla et totam." }, "securityKey2": { "type": "string", "description": "Security Key 2", "example": "Vel ratione qui facilis." }, "securityLevel": { "type": "string", "description": "Security Level: NONE, BASIC, MEDIUM, HIGH, or SIGNED_URL", "example": "NONE", "enum": [ "NONE", "BASIC", "MEDIUM", "HIGH", "SIGNED_URL" ] }, "signedURLSecurityKeyID": { "type": "string", "description": "Signed URL Security Key ID", "example": "Veniam deserunt tempore est rerum nisi." }, "signedURLSecuritySecretKey": { "type": "string", "description": "Signed URL Security Secret Key", "example": "Voluptas aut autem sed nulla." } }, "example": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "required": [ "complete", "screenout", "overquota", "securityLevel" ] }, "ErrorType": { "title": "ErrorType", "type": "object", "properties": { "code": { "type": "string", "description": "Application-specific error code", "example": "Cupiditate nesciunt atque." }, "message": { "type": "string", "description": "Human readable explanation specific to this problem", "example": "Quod doloribus." }, "resource": { "$ref": "#/definitions/Resource" } }, "example": { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, "required": [ "code", "message", "resource" ] }, "Errors": { "title": "Errors", "type": "object", "properties": { "message": { "type": "string", "description": "message", "example": "msg" }, "path": { "type": "string", "description": "path", "example": "path" }, "status": { "type": "string", "description": "status", "example": "100" } }, "example": { "message": "msg", "path": "path", "status": "100" }, "required": [ "message", "path", "status" ] }, "Event": { "title": "Mediatype identifier: application/vnd.event+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/EventData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Event media type (default view)", "example": { "data": { "actions": "2b0d545b-761e-434a-9f68-09b41e3b033e", "createdAt": "2020/12/12 15:14:12", "details": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "eventId": 11, "eventType": "lineItem:reprice", "extLineItemId": "lineItem001", "extProjectId": "project001", "parentEventId": 882398949573796400, "resource": "2008-09-11T03:07:37Z" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "EventData": { "title": "EventData", "type": "object", "properties": { "actions": { "description": "Event actions", "example": "2b0d545b-761e-434a-9f68-09b41e3b033e" }, "createdAt": { "type": "string", "description": "Time event created at", "example": "2020/12/12 15:14:12" }, "details": { "$ref": "#/definitions/EventDetails" }, "eventId": { "type": "integer", "description": "Unique event ID", "example": 11, "format": "int64" }, "eventType": { "type": "string", "description": "Event Type", "example": "lineItem:reprice" }, "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "lineItem001" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "parentEventId": { "type": "integer", "description": "Parent Event ID", "example": 882398949573796400, "format": "int64" }, "resource": { "description": "Event resource", "example": "2008-09-11T03:07:37Z" } }, "example": { "actions": "2b0d545b-761e-434a-9f68-09b41e3b033e", "createdAt": "2020/12/12 15:14:12", "details": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "eventId": 11, "eventType": "lineItem:reprice", "extLineItemId": "lineItem001", "extProjectId": "project001", "parentEventId": 882398949573796400, "resource": "2008-09-11T03:07:37Z" }, "required": [ "eventId", "eventType", "extProjectId", "extLineItemId", "createdAt", "resource" ] }, "EventDetails": { "title": "EventDetails", "type": "object", "properties": { "comments": { "type": "string", "description": "comments ", "example": "Accusamus explicabo nemo eos modi numquam quibusdam." }, "reasons": { "type": "array", "items": { "$ref": "#/definitions/Reason" }, "description": "reasons", "example": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] } }, "example": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "required": [ "comments", "reasons" ] }, "EventListData": { "title": "EventListData", "type": "object", "properties": { "actions": { "description": "Event actions", "example": false }, "createdAt": { "type": "string", "description": "Time event created at", "example": "2020/12/12 15:14:12" }, "details": { "$ref": "#/definitions/EventDetails" }, "eventId": { "type": "integer", "description": "Unique event ID", "example": 11, "format": "int64" }, "eventType": { "type": "string", "description": "Event Type", "example": "lineItem:reprice" }, "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "lineItem001" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "parentEventId": { "type": "integer", "description": "Parent Event ID", "example": 8258631410109288000, "format": "int64" }, "resource": { "description": "Event resource", "example": 2798202564372720000 } }, "example": { "actions": false, "createdAt": "2020/12/12 15:14:12", "details": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "eventId": 11, "eventType": "lineItem:reprice", "extLineItemId": "lineItem001", "extProjectId": "project001", "parentEventId": 8258631410109288000, "resource": 2798202564372720000 }, "required": [ "eventId", "eventType", "extProjectId", "extLineItemId", "createdAt", "resource" ] }, "Events": { "title": "Mediatype identifier: application/vnd.events+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/EventListData" }, "example": [ { "actions": false, "createdAt": "2020/12/12 15:14:12", "details": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "eventId": 11, "eventType": "lineItem:reprice", "extLineItemId": "lineItem001", "extProjectId": "project001", "parentEventId": 8258631410109288000, "resource": 2798202564372720000 } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Events media type (default view)", "example": { "data": [ { "actions": false, "createdAt": "2020/12/12 15:14:12", "details": { "comments": "Accusamus explicabo nemo eos modi numquam quibusdam.", "reasons": [ { "code": "Eos soluta tempore.", "description": "Quia ut." } ] }, "eventId": 11, "eventType": "lineItem:reprice", "extLineItemId": "lineItem001", "extProjectId": "project001", "parentEventId": 8258631410109288000, "resource": 2798202564372720000 } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ExclusionData": { "title": "ExclusionData", "type": "object", "properties": { "list": { "type": "array", "items": { "type": "string", "example": "Et mollitia velit nihil aliquid." }, "description": "List of all the type values", "example": [ "Et mollitia velit nihil aliquid." ] }, "type": { "type": "string", "description": "Type of exclusion inclusion", "example": "CATEGORY", "enum": [ "PROJECT", "CATEGORY" ] } }, "example": { "list": [ "Et mollitia velit nihil aliquid." ], "type": "CATEGORY" }, "required": [ "type", "list" ] }, "Feasibility": { "title": "Mediatype identifier: application/vnd.feasibility+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/FeasibilityResponseData" }, "example": [ { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } }, { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } }, { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Feasibility media type (default view)", "example": { "data": [ { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } }, { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } }, { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "FeasibilityData": { "title": "FeasibilityData", "type": "object", "properties": { "autoRepricingThreshold": { "type": "number", "example": 0.44982243353379503, "format": "double" }, "costPerInterview": { "type": "number", "description": "Amount Research Now SSI will be paid for each delivered complete", "example": 0.6925497183593459, "format": "double" }, "currency": { "type": "string", "description": "Currency associated with the costPerInterview", "example": "Aut ex non." }, "expiry": { "type": "string", "description": "Time stamp of the expiry of the feasibility of the lineitem.", "example": "Voluptatem nam." }, "feasible": { "type": "boolean", "description": "Can the system deliver the requiredCompletes", "example": false }, "status": { "type": "string", "description": "Current state of feasibility for line item", "example": "Totam perspiciatis dolorem iusto facilis consequatur." }, "totalCount": { "type": "integer", "example": 2981214649117641000, "format": "int64" }, "valueCounts": { "type": "array", "items": { "$ref": "#/definitions/QuotaGroupFeasibility" }, "description": "Number of possible completes for each panelist attribute broken down for male and female", "example": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] } }, "example": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "required": [ "totalCount", "valueCounts" ] }, "FeasibilityResponseData": { "title": "FeasibilityResponseData", "type": "object", "properties": { "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "proejct001" }, "feasibility": { "$ref": "#/definitions/FeasibilityData" }, "quote": { "$ref": "#/definitions/Quote" } }, "example": { "extLineItemId": "proejct001", "feasibility": { "autoRepricingThreshold": 0.44982243353379503, "costPerInterview": 0.6925497183593459, "currency": "Aut ex non.", "expiry": "Voluptatem nam.", "feasible": false, "status": "Totam perspiciatis dolorem iusto facilis consequatur.", "totalCount": 2981214649117641000, "valueCounts": [ { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "quote": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } } }, "InvoiceProject": { "title": "Mediatype identifier: application/vnd.invoiceproject+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/InvoiceProjectData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "InvoiceProject media type (default view)", "example": { "data": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "InvoiceProjectData": { "title": "InvoiceProjectData", "type": "object", "properties": { "webhookId": { "type": "string", "description": "Webhook message ID", "example": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" } }, "example": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "required": [ "webhookId" ] }, "InvoiceProjectPayload": { "title": "InvoiceProjectPayload", "type": "object", "properties": { "createdAt": { "type": "string", "description": "Time event created at", "example": "2020/12/12 15:14:12" }, "dkProjectId": { "type": "integer", "description": "Project ID", "example": 1704388130758437000, "format": "int64" }, "salesOrderId": { "type": "string", "description": "Sales order ID", "example": "Sales001" } }, "example": { "createdAt": "2020/12/12 15:14:12", "dkProjectId": 1704388130758437000, "salesOrderId": "Sales001" }, "required": [ "dkProjectId", "salesOrderId", "createdAt" ] }, "LineItemActionResponse": { "title": "LineItemActionResponse", "type": "object", "properties": { "createdAt": { "type": "string", "description": "Timestamp of when the line item was created", "example": "04/01/2018 00:00:00" }, "extLineItemId": { "type": "string", "description": "Unique line item ID", "example": "lineItem001" }, "launchedAt": { "type": "string", "description": "Timestamp of when the line item launched on RN SSI panelists", "example": "04/01/2018 00:00:00" }, "state": { "type": "string", "description": "Unique line item Id", "example": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED" }, "stateLastUpdatedAt": { "type": "string", "description": "Timestamp of when the line item last changed its state", "example": "04/01/2018 00:00:00" }, "stateReason": { "type": "string", "description": "Reason for the current state of the line item", "example": "Paused by client" }, "updatedAt": { "type": "string", "description": "Timestamp of when the line item was updated", "example": "04/01/2018 00:00:00" } }, "example": { "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "launchedAt": "04/01/2018 00:00:00", "state": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Paused by client", "updatedAt": "04/01/2018 00:00:00" } }, "LineItemData": { "title": "LineItemData", "type": "object", "properties": { "channelDistribution": { "$ref": "#/definitions/ChannelDistribution" }, "costPerInterview": { "type": "number", "description": "Client specified CPI for the line item", "default": 0, "example": 0.6829663611700619, "format": "double" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "daysInField": { "type": "integer", "description": "Duration of the project in days.", "example": 5, "format": "int64" }, "deliveryType": { "type": "string", "description": "Delivery type: SLOW, BALANCED,FAST or BURST.", "example": "Nihil possimus illo id." }, "dynataLineItemReferenceId": { "type": "string", "description": "Sales Order Detail Reference ID", "example": "45D02B56-6172-E911-945B-005056A14BD8" }, "extLineItemId": { "type": "string", "description": "Unique line item Id", "example": "lineItem001" }, "fieldSchedule": { "$ref": "#/definitions/fieldSchedule" }, "indicativeIncidence": { "type": "number", "description": "Expected incidence of the survey", "example": 20.5, "format": "double" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "lengthOfInterview": { "type": "integer", "description": "expected duration of the survey in minutes", "example": 10, "format": "int64" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanData" }, "requiredCompletes": { "type": "integer", "description": "Number of complete required for the line item", "example": 200, "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/LineItemSource" }, "description": "id of the source where is the sample coming from", "example": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ] }, "surveyTestURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/test/start?tid=1234567abcdef" }, "surveyTestURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyTestURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "surveyTestingNotes": { "type": "string", "description": "Survey testing notes", "example": "Qui dolorum voluptas quos." }, "surveyURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/start?tid=1234567abcdef" }, "surveyURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "targets": { "type": "array", "items": { "$ref": "#/definitions/Target" }, "description": "Data of completes/starts required for the line item", "example": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ] }, "title": { "type": "string", "description": "A title for the line item", "example": "US College Grads" } }, "example": { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.6829663611700619, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Nihil possimus illo id.", "dynataLineItemReferenceId": "45D02B56-6172-E911-945B-005056A14BD8", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Qui dolorum voluptas quos.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" }, "required": [ "extLineItemId", "title", "countryISOCode", "languageISOCode", "indicativeIncidence", "lengthOfInterview" ] }, "LineItemItemData": { "title": "LineItemItemData", "type": "object", "properties": { "countryISOCode": { "type": "string", "description": "2 letter ISO Country Code", "example": "US" }, "createdAt": { "type": "string", "description": "Timestamp of when the line item was created", "example": "04/01/2018 00:00:00" }, "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "lineItem001" }, "languageISOCode": { "type": "string", "description": "2 letter ISO Language Code", "example": "en" }, "launchedAt": { "type": "string", "description": "Timestamp of when the line item launched on RN SSI panelists", "example": "04/01/2018 00:00:00" }, "state": { "type": "string", "description": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "example": "PROVISIONED", "enum": [ "PROVISIONED", "AWAITING_APPROVAL", "AWAITING_CLIENT_APPROVAL", "QA_APPROVED", "LAUNCHED", "PAUSED", "CLOSED", "INVOICED", "CANCELLED", "REJECTED" ] }, "stateLastUpdatedAt": { "type": "string", "description": "Timestamp of when the line item last changed its state", "example": "04/01/2018 00:00:00" }, "stateReason": { "type": "string", "description": "Reason for the current state of the line item", "example": "Created by Client" }, "surveyTestingNotes": { "type": "string", "description": "Survey testing notes", "example": "Atque laudantium debitis ad eveniet." }, "title": { "type": "string", "description": "A Line Item title", "example": "US College" }, "updatedAt": { "type": "string", "description": "Timestamp of when the line item was updated", "example": "04/01/2018 00:00:00" } }, "example": { "countryISOCode": "US", "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "languageISOCode": "en", "launchedAt": "04/01/2018 00:00:00", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Created by Client", "surveyTestingNotes": "Atque laudantium debitis ad eveniet.", "title": "US College", "updatedAt": "04/01/2018 00:00:00" }, "required": [ "extLineItemId", "title", "countryISOCode", "languageISOCode", "state", "stateReason", "stateLastUpdatedAt", "createdAt", "updatedAt" ] }, "LineItemReportData": { "title": "LineItemReportData", "type": "object", "properties": { "actualMedianLOI": { "type": "integer", "description": "Calculated median length of interview from actual panelists", "example": 20, "format": "int64" }, "attempts": { "type": "integer", "description": "Total number of panelists that entered the project", "example": 300, "format": "int64" }, "completes": { "type": "integer", "description": "Total number of panelists that completed the project", "example": 100, "format": "int64" }, "completesRefused": { "type": "integer", "description": "Total number of panelists that refused to complete the project", "example": 100, "format": "int64" }, "conversion": { "type": "number", "description": "Ratio of completes over attempts. (ranges from 0-1)", "example": 30, "format": "double" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "currency": { "type": "string", "description": "Currency ISO code", "example": "USD" }, "estimatedCost": { "type": "number", "description": "Total estimated cost", "example": 12.34, "format": "double" }, "extLineItemId": { "type": "string", "description": "A unique identifier for your Line Item", "example": "lineItem001" }, "incompletes": { "type": "integer", "description": "Total number of panelists that dropped the project", "example": 100, "format": "int64" }, "incurredCost": { "type": "number", "description": "Total incurred cost", "example": 12.34, "format": "double" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "lastAcceptedIncidenceRate": { "type": "number", "description": "Last accepted incidence rate", "example": 12.34, "format": "double" }, "lastAcceptedLOI": { "type": "integer", "description": "Last accepted length of interview", "example": 10, "format": "int64" }, "overquotas": { "type": "integer", "description": "Total number of panelists that triggered an overquota for the project", "example": 100, "format": "int64" }, "remainingCompletes": { "type": "integer", "description": "Total remaining completes for the project", "example": 200, "format": "int64" }, "screenouts": { "type": "integer", "description": "Total number of panelists that got screened out of the project", "example": 100, "format": "int64" }, "state": { "type": "string", "description": "The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED", "example": "LAUNCHED", "enum": [ "PROVISIONED", "AWAITING_APPROVAL", "AWAITING_CLIENT_APPROVAL", "QA_APPROVED", "LAUNCHED", "PAUSED", "CLOSED", "INVOICED", "CANCELLED", "REJECTED" ] }, "stateReason": { "type": "string", "description": "The current state reason of the project", "example": "Project completed" }, "title": { "type": "string", "description": "LineItem title", "example": "US Social Research study" } }, "example": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, "required": [ "extLineItemId", "state", "stateReason", "attempts", "completes", "screenouts", "overquotas", "conversion", "remainingCompletes", "actualMedianLOI", "incurredCost", "estimatedCost", "currency", "countryISOCode", "languageISOCode", "title", "lastAcceptedIncidenceRate", "lastAcceptedLOI", "incompletes", "completesRefused" ] }, "LineItemResponseData": { "title": "LineItemResponseData", "type": "object", "properties": { "channelDistribution": { "$ref": "#/definitions/ChannelDistribution" }, "costPerInterview": { "type": "number", "description": "Client specified CPI for the line item", "default": 0, "example": 0.8133399851735352, "format": "double" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "createdAt": { "type": "string", "description": "created time.", "example": "At et sapiente optio at." }, "daysInField": { "type": "integer", "description": "Duration of the project in days.", "example": 5, "format": "int64" }, "deliveryType": { "type": "string", "description": "Delivery type: SLOW, BALANCED, FAST or BURST.", "example": "Aperiam debitis eos aut." }, "dynataLineItemReferenceId": { "type": "string", "description": "Sales Order Detail ID of the line item.", "example": "Dicta numquam qui reprehenderit quod sunt vel." }, "endLinks": { "$ref": "#/definitions/EndLinks" }, "extLineItemId": { "type": "string", "description": "Unique line item Id", "example": "lineItem001" }, "fieldSchedule": { "$ref": "#/definitions/fieldSchedule" }, "indicativeIncidence": { "type": "number", "description": "Expected incidence of the survey", "example": 20.5, "format": "double" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "launchedAt": { "type": "string", "description": "launched time.", "example": "Inventore aliquid necessitatibus rem et qui eligendi." }, "lengthOfInterview": { "type": "integer", "description": "expected duration of the survey in minutes", "example": 10, "format": "int64" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanData" }, "requiredCompletes": { "type": "integer", "description": "Number of complete required for the line item", "example": 200, "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/LineItemSource" }, "description": "id of the source where is the sample coming from", "example": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ] }, "state": { "type": "string", "description": "state", "example": "Nihil eligendi aut possimus." }, "stateLastUpdatedAt": { "type": "string", "description": "state last updated at.", "example": "Provident sit ipsa et repellendus sed." }, "stateReason": { "type": "string", "description": "state reason", "example": "Voluptatem necessitatibus." }, "surveyTestURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/test/start?tid=1234567abcdef" }, "surveyTestURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyTestURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "surveyTestingNotes": { "type": "string", "description": "survey testing notes", "example": "Accusantium rem facilis vel soluta." }, "surveyURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/start?tid=1234567abcdef" }, "surveyURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "targets": { "type": "array", "items": { "$ref": "#/definitions/Target" }, "description": "Data of completes/starts required for the line item", "example": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ] }, "title": { "type": "string", "description": "A title for the line item", "example": "US College Grads" }, "updatedAt": { "type": "string", "description": "updated time.", "example": "Odit excepturi ipsam distinctio." } }, "example": { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." } }, "LineItemSource": { "title": "LineItemSource", "type": "object", "properties": { "id": { "type": "integer", "description": "id of the source where is the sample coming from", "example": 6652941744735571000, "format": "int64" }, "name": { "type": "string", "description": "name of the source where is the sample coming from", "example": "dynata Consumer" } }, "example": { "id": 6652941744735571000, "name": "dynata Consumer" } }, "LineItems": { "title": "Mediatype identifier: application/vnd.lineitems+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/LineItemItemData" }, "example": [ { "countryISOCode": "US", "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "languageISOCode": "en", "launchedAt": "04/01/2018 00:00:00", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Created by Client", "surveyTestingNotes": "Atque laudantium debitis ad eveniet.", "title": "US College", "updatedAt": "04/01/2018 00:00:00" }, { "countryISOCode": "US", "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "languageISOCode": "en", "launchedAt": "04/01/2018 00:00:00", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Created by Client", "surveyTestingNotes": "Atque laudantium debitis ad eveniet.", "title": "US College", "updatedAt": "04/01/2018 00:00:00" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "LineItems media type (default view)", "example": { "data": [ { "countryISOCode": "US", "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "languageISOCode": "en", "launchedAt": "04/01/2018 00:00:00", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Created by Client", "surveyTestingNotes": "Atque laudantium debitis ad eveniet.", "title": "US College", "updatedAt": "04/01/2018 00:00:00" }, { "countryISOCode": "US", "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "languageISOCode": "en", "launchedAt": "04/01/2018 00:00:00", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Created by Client", "surveyTestingNotes": "Atque laudantium debitis ad eveniet.", "title": "US College", "updatedAt": "04/01/2018 00:00:00" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "Links": { "title": "Links", "type": "object", "properties": { "first": { "type": "string", "example": "Natus consequatur cumque ipsam vel." }, "last": { "type": "string", "example": "Omnis dignissimos facilis inventore ea animi eveniet." }, "next": { "type": "string", "example": "Provident quo enim quod." }, "prev": { "type": "string", "example": "Unde ad quidem consequuntur." }, "self": { "type": "string", "example": "Eum et." } }, "example": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." } }, "LogoutPayload": { "title": "LogoutPayload", "type": "object", "properties": { "accessToken": { "type": "string", "description": "Access token", "example": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" }, "clientId": { "type": "string", "description": "Client ID", "example": "app1" }, "refreshToken": { "type": "string", "description": "Refresh token", "example": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" } }, "example": { "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw", "clientId": "app1", "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" }, "required": [ "clientId", "accessToken", "refreshToken" ] }, "Meta": { "title": "Meta", "type": "object", "properties": { "links": { "$ref": "#/definitions/Links" }, "pageSize": { "type": "integer", "description": "Page size", "example": 2368005390717368000, "format": "int64" }, "total": { "type": "integer", "description": "Total records possible", "example": 1737945077937721300, "format": "int64" } }, "example": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 } }, "OrderDetail": { "title": "Mediatype identifier: application/vnd.orderdetail+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/OrderDetailResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "OrderDetail media type (default view)", "example": { "data": { "errors": [ { "message": "msg", "path": "path", "status": "100" } ], "salesOrder": { "basicSecurityKey": "12668", "guid": "guid", "highSecurityKey": "12276", "name": "name", "noCharge": true, "orderType": "PRODUCTION_ONLY", "ordernumber": "ORD123", "relatedOrderCpi": 2.5, "secureEndLinkLevel": 2, "secureEndLinkLevelName": "Basic" }, "salesOrderDetails": [ { "costPerInterview": 2.5, "costPerInterviewWithCurrency": "US", "countryIsoCode": "EN", "extendedamount": "extendedamount", "guid": "guid", "labelForMobile": "labelForMobile", "productIdGuid": "productIdGuid", "productIdName": "productIdName", "quantity": 333, "ssiAdditionalPoints": 0, "ssiCalculatedIr": "ssiCalculatedIr", "ssiCalculatedLoi": "ssiCalculatedLoi", "ssiChartsNum": 1, "ssiFamilyId": "ssiFamilyId", "ssiImagesNum": 1, "ssiImagesSpecialNum": 1, "ssiInputPrice": 1, "ssiIr": 1, "ssiLabel": "ssiLabel", "ssiProductType": "ssiProductType", "ssiProductTypeId": 1, "ssiSampleCountryCode": "ssiSampleCountryCode", "ssiSampleCountryId": "ssiSampleCountryId", "ssiTitle": "ssiTitle", "ssiVendorUsed": "ssiVendorUsed", "ssiVideosNum": 1, "vendorLine": true } ] }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "OrderDetailResponseData": { "title": "OrderDetailResponseData", "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/Errors" }, "description": "errors", "example": [ { "message": "msg", "path": "path", "status": "100" } ] }, "salesOrder": { "$ref": "#/definitions/SalesOrder" }, "salesOrderDetails": { "type": "array", "items": { "$ref": "#/definitions/SalesOrderDetails" }, "description": "sales details", "example": [ { "costPerInterview": 2.5, "costPerInterviewWithCurrency": "US", "countryIsoCode": "EN", "extendedamount": "extendedamount", "guid": "guid", "labelForMobile": "labelForMobile", "productIdGuid": "productIdGuid", "productIdName": "productIdName", "quantity": 333, "ssiAdditionalPoints": 0, "ssiCalculatedIr": "ssiCalculatedIr", "ssiCalculatedLoi": "ssiCalculatedLoi", "ssiChartsNum": 1, "ssiFamilyId": "ssiFamilyId", "ssiImagesNum": 1, "ssiImagesSpecialNum": 1, "ssiInputPrice": 1, "ssiIr": 1, "ssiLabel": "ssiLabel", "ssiProductType": "ssiProductType", "ssiProductTypeId": 1, "ssiSampleCountryCode": "ssiSampleCountryCode", "ssiSampleCountryId": "ssiSampleCountryId", "ssiTitle": "ssiTitle", "ssiVendorUsed": "ssiVendorUsed", "ssiVideosNum": 1, "vendorLine": true } ] } }, "example": { "errors": [ { "message": "msg", "path": "path", "status": "100" } ], "salesOrder": { "basicSecurityKey": "12668", "guid": "guid", "highSecurityKey": "12276", "name": "name", "noCharge": true, "orderType": "PRODUCTION_ONLY", "ordernumber": "ORD123", "relatedOrderCpi": 2.5, "secureEndLinkLevel": 2, "secureEndLinkLevelName": "Basic" }, "salesOrderDetails": [ { "costPerInterview": 2.5, "costPerInterviewWithCurrency": "US", "countryIsoCode": "EN", "extendedamount": "extendedamount", "guid": "guid", "labelForMobile": "labelForMobile", "productIdGuid": "productIdGuid", "productIdName": "productIdName", "quantity": 333, "ssiAdditionalPoints": 0, "ssiCalculatedIr": "ssiCalculatedIr", "ssiCalculatedLoi": "ssiCalculatedLoi", "ssiChartsNum": 1, "ssiFamilyId": "ssiFamilyId", "ssiImagesNum": 1, "ssiImagesSpecialNum": 1, "ssiInputPrice": 1, "ssiIr": 1, "ssiLabel": "ssiLabel", "ssiProductType": "ssiProductType", "ssiProductTypeId": 1, "ssiSampleCountryCode": "ssiSampleCountryCode", "ssiSampleCountryId": "ssiSampleCountryId", "ssiTitle": "ssiTitle", "ssiVendorUsed": "ssiVendorUsed", "ssiVideosNum": 1, "vendorLine": true } ] }, "required": [ "salesOrder", "salesOrderDetails", "errors" ] }, "Permissions": { "title": "Mediatype identifier: application/vnd.userpermissions+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/PermissionsResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Permissions media type (default view)", "example": { "data": { "currentUser": { "roles": [ "Cum sequi voluptatem.", "Cum sequi voluptatem.", "Cum sequi voluptatem." ] }, "extProjectId": "project001", "teams": [ { "id": 1, "name": "Sales Team" }, { "id": 1, "name": "Sales Team" } ], "users": [ { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" } ] }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "PermissionsResponseData": { "title": "PermissionsResponseData", "type": "object", "properties": { "currentUser": { "$ref": "#/definitions/CurrentUser" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "teams": { "type": "array", "items": { "$ref": "#/definitions/TeamsData" }, "description": "List of Teams that has permissions", "example": [ { "id": 1, "name": "Sales Team" }, { "id": 1, "name": "Sales Team" } ] }, "users": { "type": "array", "items": { "$ref": "#/definitions/UsersData" }, "description": "List of users that has permissions", "example": [ { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" } ] } }, "example": { "currentUser": { "roles": [ "Cum sequi voluptatem.", "Cum sequi voluptatem.", "Cum sequi voluptatem." ] }, "extProjectId": "project001", "teams": [ { "id": 1, "name": "Sales Team" }, { "id": 1, "name": "Sales Team" } ], "users": [ { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" } ] }, "required": [ "extProjectId", "currentUser", "users", "teams" ] }, "Project": { "title": "Project", "type": "object", "properties": { "category": { "$ref": "#/definitions/ProjectCategoryData" }, "devices": { "type": "array", "items": { "type": "string", "example": "Voluptate consequatur neque sint quo voluptatibus error." }, "description": "List of emails to subscribe to notifications", "example": [ "Voluptate consequatur neque sint quo voluptatibus error.", "Voluptate consequatur neque sint quo voluptatibus error.", "Voluptate consequatur neque sint quo voluptatibus error." ] }, "exclusions": { "$ref": "#/definitions/ExclusionData" }, "extProjectId": { "type": "string", "description": "Unique external project ID ", "example": "project001" }, "jobNumber": { "type": "string", "description": "Project job number", "example": "dynata123" }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/LineItemData" }, "description": "List of line items for the project.", "example": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.6829663611700619, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Nihil possimus illo id.", "dynataLineItemReferenceId": "45D02B56-6172-E911-945B-005056A14BD8", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Qui dolorum voluptas quos.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" } ] }, "notificationEmails": { "type": "array", "items": { "type": "string", "example": "Sunt eos quasi sed provident et." }, "description": "List of emails to subscribe to notifications", "example": [ "Sunt eos quasi sed provident et.", "Sunt eos quasi sed provident et.", "Sunt eos quasi sed provident et." ] }, "respondentFilters": { "type": "array", "items": { "$ref": "#/definitions/RespondentFilterData" }, "description": "Inclusion/Exclusions on the project", "example": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ] }, "title": { "type": "string", "description": "Project title", "example": "Test Survey" }, "useRelevantId": { "type": "boolean", "description": "set to true to dedupe using relevant id", "example": false } }, "example": { "category": { "studyRequirements": [ "Consequatur ut at.", "Consequatur ut at." ], "studyType": [ "Hic repellendus." ], "surveyTopic": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] }, "devices": [ "Voluptate consequatur neque sint quo voluptatibus error.", "Voluptate consequatur neque sint quo voluptatibus error.", "Voluptate consequatur neque sint quo voluptatibus error." ], "exclusions": { "list": [ "Et mollitia velit nihil aliquid." ], "type": "CATEGORY" }, "extProjectId": "project001", "jobNumber": "dynata123", "lineItems": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.6829663611700619, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Nihil possimus illo id.", "dynataLineItemReferenceId": "45D02B56-6172-E911-945B-005056A14BD8", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Qui dolorum voluptas quos.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" } ], "notificationEmails": [ "Sunt eos quasi sed provident et.", "Sunt eos quasi sed provident et.", "Sunt eos quasi sed provident et." ], "respondentFilters": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ], "title": "Test Survey", "useRelevantId": false }, "required": [ "extProjectId", "title", "category", "lineItems" ] }, "ProjectAction": { "title": "Mediatype identifier: application/vnd.project.action+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/ProjectActionResponse" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "ProjectAction media type (default view)", "example": { "data": { "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "createdAt": "04/01/2018 00:00:00", "extProjectId": "lineItem001", "lineItems": [ { "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "launchedAt": "04/01/2018 00:00:00", "state": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Paused by client", "updatedAt": "04/01/2018 00:00:00" } ], "state": "The current state of the Project can be one of: PROVISIONED, LAUNCHED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "updatedAt": "04/01/2018 00:00:00" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ProjectActionResponse": { "title": "ProjectActionResponse", "type": "object", "properties": { "billing": { "$ref": "#/definitions/Billing" }, "createdAt": { "type": "string", "description": "Timestamp of when the line item was created", "example": "04/01/2018 00:00:00" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "lineItem001" }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/LineItemActionResponse" }, "description": "line items for the project", "example": [ { "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "launchedAt": "04/01/2018 00:00:00", "state": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Paused by client", "updatedAt": "04/01/2018 00:00:00" } ] }, "state": { "type": "string", "description": "Current state of the Project", "example": "The current state of the Project can be one of: PROVISIONED, LAUNCHED, CLOSED, INVOICED" }, "stateLastUpdatedAt": { "type": "string", "description": "Timestamp of when the line item last changed its state", "example": "04/01/2018 00:00:00" }, "updatedAt": { "type": "string", "description": "Timestamp of when the line item was updated", "example": "04/01/2018 00:00:00" } }, "example": { "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "createdAt": "04/01/2018 00:00:00", "extProjectId": "lineItem001", "lineItems": [ { "createdAt": "04/01/2018 00:00:00", "extLineItemId": "lineItem001", "launchedAt": "04/01/2018 00:00:00", "state": "The current state of the line item: PROVISIONED, AWAITING_APPROVAL, LAUNCHED, PAUSED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "stateReason": "Paused by client", "updatedAt": "04/01/2018 00:00:00" } ], "state": "The current state of the Project can be one of: PROVISIONED, LAUNCHED, CLOSED, INVOICED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "updatedAt": "04/01/2018 00:00:00" } }, "ProjectCategoryData": { "title": "ProjectCategoryData", "type": "object", "properties": { "studyRequirements": { "type": "array", "items": { "type": "string", "example": "Consequatur ut at." }, "description": "List of survey requirements", "example": [ "Consequatur ut at.", "Consequatur ut at." ] }, "studyType": { "type": "array", "items": { "type": "string", "example": "Hic repellendus." }, "description": "List of survey types", "example": [ "Hic repellendus." ] }, "surveyTopic": { "type": "array", "items": { "type": "string", "example": "Quaerat doloremque aliquid a." }, "description": "List of survey topics", "example": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] } }, "example": { "studyRequirements": [ "Consequatur ut at.", "Consequatur ut at." ], "studyType": [ "Hic repellendus." ], "surveyTopic": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] }, "required": [ "surveyTopic" ] }, "ProjectCost": { "title": "ProjectCost", "type": "object", "properties": { "currency": { "type": "string", "description": "Currency ISO code", "example": "Voluptas aliquam harum amet voluptatibus est." }, "estimatedCost": { "type": "number", "description": "Total estimated cost for the project", "example": 2.5, "format": "double" }, "incurredCost": { "type": "number", "description": "Total incurred cost for the project", "example": 2.5, "format": "double" } }, "example": { "currency": "Voluptas aliquam harum amet voluptatibus est.", "estimatedCost": 2.5, "incurredCost": 2.5 }, "required": [ "currency", "estimatedCost", "incurredCost" ] }, "ProjectItemData": { "title": "ProjectItemData", "type": "object", "properties": { "author": { "$ref": "#/definitions/Author" }, "billing": { "$ref": "#/definitions/Billing" }, "closedAt": { "type": "string", "description": "Timestamp of when the project was closed", "example": "Alias pariatur itaque quasi." }, "createdAt": { "type": "string", "description": "Timestamp of when the project was created", "example": "04/01/2018 00:00:00" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "jobNumber": { "type": "string", "description": "project job number", "example": "dynata123" }, "launchedAt": { "type": "string", "description": "Timestamp of when the project was launched", "example": "Aspernatur explicabo ullam ipsum corporis." }, "state": { "type": "string", "description": "Current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED", "example": "PROVISIONED", "enum": [ "PROVISIONED", "LAUNCHED", "CLOSED", "INVOICED", "COMPLETED", "CANCELLED" ] }, "stateLastUpdatedAt": { "type": "string", "description": "Timestamp of when the project last changed its state", "example": "04/01/2018 00:00:00" }, "title": { "type": "string", "description": "Project title", "example": "Automotive Study" }, "updatedAt": { "type": "string", "description": "Timestamp of when the project was updated", "example": "04/01/2018 00:00:00" } }, "example": { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" }, "required": [ "extProjectId", "title", "state", "stateLastUpdatedAt", "createdAt", "updatedAt" ] }, "ProjectReport": { "title": "Mediatype identifier: application/vnd.projects.report+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/ProjectReportData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "ProjectReport media type (default view)", "example": { "data": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 300, "conversion": 30, "currency": "USD", "estimatedCost": 12.34, "extProjectId": "project001", "incompletes": 300, "incurredCost": 12.34, "lineItems": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" } ], "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "title": "US Test Survey" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ProjectReportData": { "title": "ProjectReportData", "type": "object", "properties": { "actualMedianLOI": { "type": "integer", "description": "Calculated median length of interview from actual panelists", "example": 20, "format": "int64" }, "attempts": { "type": "integer", "description": "Total number of panelists that entered the project", "example": 300, "format": "int64" }, "completes": { "type": "integer", "description": "Total number of panelists that completed the project", "example": 100, "format": "int64" }, "completesRefused": { "type": "integer", "description": "Total number of panelists that refused to complete the project", "example": 300, "format": "int64" }, "conversion": { "type": "number", "description": "Ratio of completes over attempts. (ranges from 0-1)", "example": 30, "format": "double" }, "currency": { "type": "string", "description": "Currency ISO code", "example": "USD" }, "estimatedCost": { "type": "number", "description": "Total estimated cost", "example": 12.34, "format": "double" }, "extProjectId": { "type": "string", "description": "A unique identifier for your project", "example": "project001" }, "incompletes": { "type": "integer", "description": "Total number of panelists that dropped the project", "example": 300, "format": "int64" }, "incurredCost": { "type": "number", "description": "Total incurred cost", "example": 12.34, "format": "double" }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/LineItemReportData" }, "example": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" } ] }, "overquotas": { "type": "integer", "description": "Total number of panelists that triggered an overquota for the project", "example": 100, "format": "int64" }, "remainingCompletes": { "type": "integer", "description": "Total remaining completes for the project", "example": 200, "format": "int64" }, "screenouts": { "type": "integer", "description": "Total number of panelists that got screened out of the project", "example": 100, "format": "int64" }, "state": { "type": "string", "description": "The current state of the project: PROVISIONED, LAUNCHED, PAUSED, CLOSED", "example": "LAUNCHED", "enum": [ "PROVISIONED", "LAUNCHED", "CLOSED", "INVOICED", "COMPLETED", "CANCELLED" ] }, "title": { "type": "string", "description": "Project Title", "example": "US Test Survey" } }, "example": { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 300, "conversion": 30, "currency": "USD", "estimatedCost": 12.34, "extProjectId": "project001", "incompletes": 300, "incurredCost": 12.34, "lineItems": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" } ], "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "title": "US Test Survey" }, "required": [ "extProjectId", "state", "attempts", "completes", "screenouts", "overquotas", "conversion", "remainingCompletes", "actualMedianLOI", "incurredCost", "estimatedCost", "currency", "title", "incompletes", "completesRefused" ] }, "ProjectReports": { "title": "Mediatype identifier: application/vnd.projects.reports+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ProjectReportData" }, "example": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 300, "conversion": 30, "currency": "USD", "estimatedCost": 12.34, "extProjectId": "project001", "incompletes": 300, "incurredCost": 12.34, "lineItems": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" } ], "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "title": "US Test Survey" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "ProjectReports media type (default view)", "example": { "data": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 300, "conversion": 30, "currency": "USD", "estimatedCost": 12.34, "extProjectId": "project001", "incompletes": 300, "incurredCost": 12.34, "lineItems": [ { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" }, { "actualMedianLOI": 20, "attempts": 300, "completes": 100, "completesRefused": 100, "conversion": 30, "countryISOCode": "US", "currency": "USD", "estimatedCost": 12.34, "extLineItemId": "lineItem001", "incompletes": 100, "incurredCost": 12.34, "languageISOCode": "en", "lastAcceptedIncidenceRate": 12.34, "lastAcceptedLOI": 10, "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "stateReason": "Project completed", "title": "US Social Research study" } ], "overquotas": 100, "remainingCompletes": 200, "screenouts": 100, "state": "LAUNCHED", "title": "US Test Survey" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ProjectResponse": { "title": "Mediatype identifier: application/vnd.create+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/ProjectResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "ProjectResponse media type (default view)", "example": { "data": { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "category": { "studyRequirements": [ "Consequatur ut at.", "Consequatur ut at." ], "studyType": [ "Hic repellendus." ], "surveyTopic": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] }, "closedAt": "Qui praesentium nulla cum molestiae exercitationem.", "createdAt": "Aut eum incidunt non.", "devices": [ "Ipsa dolor hic.", "Ipsa dolor hic.", "Ipsa dolor hic." ], "dynataLineItemReferenceId": "Asperiores a eum quae nihil.", "exclusions": { "list": [ "Et mollitia velit nihil aliquid." ], "type": "CATEGORY" }, "extProjectId": "project001", "jobNumber": "Test Survey", "launchedAt": "Voluptatibus debitis ipsa distinctio.", "lineItems": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." } ], "notificationEmails": [ "Itaque alias laboriosam fuga adipisci illum.", "Itaque alias laboriosam fuga adipisci illum." ], "respondentFilters": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ], "state": "Qui et iste porro delectus.", "stateLastUpdatedAt": "Nemo error.", "title": "Test Survey", "updatedAt": "Aut sunt a.", "useRelevantId": false }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ProjectResponseData": { "title": "ProjectResponseData", "type": "object", "properties": { "author": { "$ref": "#/definitions/Author" }, "billing": { "$ref": "#/definitions/Billing" }, "category": { "$ref": "#/definitions/ProjectCategoryData" }, "closedAt": { "type": "string", "description": "Timestamp of when the project was closed", "example": "Qui praesentium nulla cum molestiae exercitationem." }, "createdAt": { "type": "string", "description": "Timestamp of when the project was created", "example": "Aut eum incidunt non." }, "devices": { "type": "array", "items": { "type": "string", "example": "Ipsa dolor hic." }, "description": "List of emails to subscribe to notifications", "example": [ "Ipsa dolor hic.", "Ipsa dolor hic.", "Ipsa dolor hic." ] }, "dynataLineItemReferenceId": { "type": "string", "description": "Sales Order Detail ID of the line item.", "example": "Asperiores a eum quae nihil." }, "exclusions": { "$ref": "#/definitions/ExclusionData" }, "extProjectId": { "type": "string", "description": "Unique external project ID", "example": "project001" }, "jobNumber": { "type": "string", "description": "Project job number", "example": "Test Survey" }, "launchedAt": { "type": "string", "description": "Timestamp of when the project was launched", "example": "Voluptatibus debitis ipsa distinctio." }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/LineItemResponseData" }, "description": "List of line items for the project.", "example": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." } ] }, "notificationEmails": { "type": "array", "items": { "type": "string", "example": "Itaque alias laboriosam fuga adipisci illum." }, "description": "List of emails to subscribe to notifications", "example": [ "Itaque alias laboriosam fuga adipisci illum.", "Itaque alias laboriosam fuga adipisci illum." ] }, "respondentFilters": { "type": "array", "items": { "$ref": "#/definitions/RespondentFilterData" }, "description": "Inclusion/Exclusions on the project", "example": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ] }, "state": { "type": "string", "description": "Current state of the project", "example": "Qui et iste porro delectus." }, "stateLastUpdatedAt": { "type": "string", "description": "Timestamp of when the project last changed its state", "example": "Nemo error." }, "title": { "type": "string", "description": "Project title", "example": "Test Survey" }, "updatedAt": { "type": "string", "description": "Timestamp of when the project was updated", "example": "Aut sunt a." }, "useRelevantId": { "type": "boolean", "description": "set to true to dedupe using relevant id", "example": false } }, "example": { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "category": { "studyRequirements": [ "Consequatur ut at.", "Consequatur ut at." ], "studyType": [ "Hic repellendus." ], "surveyTopic": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] }, "closedAt": "Qui praesentium nulla cum molestiae exercitationem.", "createdAt": "Aut eum incidunt non.", "devices": [ "Ipsa dolor hic.", "Ipsa dolor hic.", "Ipsa dolor hic." ], "dynataLineItemReferenceId": "Asperiores a eum quae nihil.", "exclusions": { "list": [ "Et mollitia velit nihil aliquid." ], "type": "CATEGORY" }, "extProjectId": "project001", "jobNumber": "Test Survey", "launchedAt": "Voluptatibus debitis ipsa distinctio.", "lineItems": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "costPerInterview": 0.8133399851735352, "countryISOCode": "US", "createdAt": "At et sapiente optio at.", "daysInField": 5, "deliveryType": "Aperiam debitis eos aut.", "dynataLineItemReferenceId": "Dicta numquam qui reprehenderit quod sunt vel.", "endLinks": { "complete": "Delectus omnis placeat repudiandae sunt pariatur.", "overquota": "Non sed.", "screenout": "Consequuntur architecto saepe.", "securityKey1": "Nulla et totam.", "securityKey2": "Vel ratione qui facilis.", "securityLevel": "NONE", "signedURLSecurityKeyID": "Veniam deserunt tempore est rerum nisi.", "signedURLSecuritySecretKey": "Voluptas aut autem sed nulla." }, "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "launchedAt": "Inventore aliquid necessitatibus rem et qui eligendi.", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "state": "Nihil eligendi aut possimus.", "stateLastUpdatedAt": "Provident sit ipsa et repellendus sed.", "stateReason": "Voluptatem necessitatibus.", "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Accusantium rem facilis vel soluta.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads", "updatedAt": "Odit excepturi ipsam distinctio." } ], "notificationEmails": [ "Itaque alias laboriosam fuga adipisci illum.", "Itaque alias laboriosam fuga adipisci illum." ], "respondentFilters": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ], "state": "Qui et iste porro delectus.", "stateLastUpdatedAt": "Nemo error.", "title": "Test Survey", "updatedAt": "Aut sunt a.", "useRelevantId": false }, "required": [ "extProjectId", "title", "notificationEmails", "category", "lineItems", "state", "stateLastUpdatedAt", "createdAt", "updatedAt" ] }, "ProjectSurveyEndLinks": { "title": "Mediatype identifier: application/vnd.projects.survey.endlinks+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/ProjectSurveyEndLinksData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "ProjectSurveyEndLinks media type (default view)", "example": { "data": { "endLinks": { "complete": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "overquota": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "screenout": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] } }, "entryLink": "Nulla est cupiditate.", "securityKey1": "Et aut doloribus magni et porro.", "securityKey2": "Amet quia est.", "securityLevel": "SIGNED_URL", "signedURLSecurityKeyID": "Officia laboriosam magnam accusantium nulla est.", "signedURLSecuritySecretKey": "Magni est alias veniam sunt quasi.", "tests": [ { "disposition": "Aut ratione architecto doloribus.", "failReason": "Ullam sed unde ut recusandae et quaerat.", "isSuccessful": false, "pid": "Placeat voluptatibus.", "psid": "Quisquam est.", "testedAt": "Quidem veniam ut incidunt dicta quidem necessitatibus." } ] }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "ProjectSurveyEndLinksData": { "title": "ProjectSurveyEndLinksData", "type": "object", "properties": { "endLinks": { "$ref": "#/definitions/SurveyEndLinks" }, "entryLink": { "type": "string", "description": "Entry link URL", "example": "Nulla est cupiditate." }, "securityKey1": { "type": "string", "description": "Security Key 1", "example": "Et aut doloribus magni et porro." }, "securityKey2": { "type": "string", "description": "Security Key 2", "example": "Amet quia est." }, "securityLevel": { "type": "string", "description": "Security Level: NONE, BASIC, MEDIUM, HIGH, or SIGNED_URL", "example": "SIGNED_URL", "enum": [ "NONE", "BASIC", "MEDIUM", "HIGH", "SIGNED_URL" ] }, "signedURLSecurityKeyID": { "type": "string", "description": "Signed URL Security Key ID", "example": "Officia laboriosam magnam accusantium nulla est." }, "signedURLSecuritySecretKey": { "type": "string", "description": "Signed URL Security Secret Key", "example": "Magni est alias veniam sunt quasi." }, "tests": { "type": "array", "items": { "$ref": "#/definitions/SurveyTest" }, "example": [ { "disposition": "Aut ratione architecto doloribus.", "failReason": "Ullam sed unde ut recusandae et quaerat.", "isSuccessful": false, "pid": "Placeat voluptatibus.", "psid": "Quisquam est.", "testedAt": "Quidem veniam ut incidunt dicta quidem necessitatibus." } ] } }, "example": { "endLinks": { "complete": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "overquota": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "screenout": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] } }, "entryLink": "Nulla est cupiditate.", "securityKey1": "Et aut doloribus magni et porro.", "securityKey2": "Amet quia est.", "securityLevel": "SIGNED_URL", "signedURLSecurityKeyID": "Officia laboriosam magnam accusantium nulla est.", "signedURLSecuritySecretKey": "Magni est alias veniam sunt quasi.", "tests": [ { "disposition": "Aut ratione architecto doloribus.", "failReason": "Ullam sed unde ut recusandae et quaerat.", "isSuccessful": false, "pid": "Placeat voluptatibus.", "psid": "Quisquam est.", "testedAt": "Quidem veniam ut incidunt dicta quidem necessitatibus." } ] }, "required": [ "entryLink", "endLinks", "securityLevel" ] }, "Projects": { "title": "Mediatype identifier: application/vnd.projects+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/ProjectItemData" }, "example": [ { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" }, { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" }, { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Projects media type (default view)", "example": { "data": [ { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" }, { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" }, { "author": { "name": "Repellat ad saepe minima tempora nam.", "type": "api", "username": "Vel ut omnis est sed sit." }, "billing": { "billingDate": "Dolorem in ad tenetur veritatis.", "billingID": "Sed cum voluptas.", "type": "AGGREGATED_MONTHLY" }, "closedAt": "Alias pariatur itaque quasi.", "createdAt": "04/01/2018 00:00:00", "extProjectId": "project001", "jobNumber": "dynata123", "launchedAt": "Aspernatur explicabo ullam ipsum corporis.", "state": "PROVISIONED", "stateLastUpdatedAt": "04/01/2018 00:00:00", "title": "Automotive Study", "updatedAt": "04/01/2018 00:00:00" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "QuotaCell": { "title": "QuotaCell", "type": "object", "properties": { "count": { "type": "integer", "description": "number of the total completes for this cell", "example": 15, "format": "int64" }, "externalQuotaCellId": { "type": "string", "description": "external ID of the quota cell", "example": "Itaque ab rerum." }, "perc": { "type": "number", "description": "percentage of the total completes for this cell", "example": 15, "format": "double" }, "quotaCellId": { "type": "string", "description": "ID of the quota cell", "example": "Quis delectus error nisi." }, "quotaNodes": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "description": "nodes in the cell.", "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, "status": { "type": "string", "description": "status of the quota cell", "example": "PAUSED", "enum": [ "LAUNCHED", "PAUSED" ] } }, "example": { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } }, "QuotaCellFeasibility": { "title": "QuotaCellFeasibility", "type": "object", "properties": { "feasibilityCount": { "type": "integer", "example": 295563108902611140, "format": "int64" }, "quotaCellId": { "type": "string", "example": "Est qui esse quod sequi." }, "quotaNodes": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } }, "example": { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, "required": [ "quotaNodes", "feasibilityCount" ] }, "QuotaCellStatus": { "title": "Mediatype identifier: application/vnd.quotacellstatus+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/QuotaCell" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "QuotaCellStatus media type (default view)", "example": { "data": { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "QuotaCellTemplate": { "title": "QuotaCellTemplate", "type": "object", "properties": { "perc": { "type": "number", "description": "percentage of the total completes for this cell", "example": 15, "format": "double" }, "quotaNodes": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "description": "nodes in the cell.", "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } }, "example": { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } }, "QuotaGroupDat": { "title": "QuotaGroupDat", "type": "object", "properties": { "lineItemId": { "type": "string", "description": "line item ID", "example": "Hic aut voluptatum." }, "pickerEventId": { "type": "integer", "description": "Picker event ID", "example": 2196069144215630800, "format": "int64" }, "quotaGroupId": { "type": "integer", "description": "ID", "example": 3337713534643430400, "format": "int64" }, "salesOrderDetailId": { "type": "string", "description": "sales order ID", "example": "Labore suscipit fugiat." }, "surveyId": { "type": "integer", "description": "survey ID", "example": 6497709257602905000, "format": "int64" } }, "example": { "lineItemId": "Hic aut voluptatum.", "pickerEventId": 2196069144215630800, "quotaGroupId": 3337713534643430400, "salesOrderDetailId": "Labore suscipit fugiat.", "surveyId": 6497709257602905000 }, "required": [ "quotaGroupId", "salesOrderDetailId", "lineItemId", "pickerEventId", "surveyId" ] }, "QuotaGroupData": { "title": "QuotaGroupData", "type": "object", "properties": { "name": { "type": "string", "description": "name or desciption of the quota group.", "example": "Porro quod voluptatem porro velit." }, "quotaCells": { "type": "array", "items": { "$ref": "#/definitions/QuotaCell" }, "description": "List of quotas", "example": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ] }, "quotaGroupId": { "type": "string", "description": "ID of the quota group", "example": "Et dicta tenetur." } }, "example": { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, "required": [ "quotaCells" ] }, "QuotaGroupFeasibility": { "title": "QuotaGroupFeasibility", "type": "object", "properties": { "quotaCells": { "type": "array", "items": { "$ref": "#/definitions/QuotaCellFeasibility" }, "example": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } }, "example": { "quotaCells": [ { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, { "feasibilityCount": 295563108902611140, "quotaCellId": "Est qui esse quod sequi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } }, "QuotaGroupTemplate": { "title": "QuotaGroupTemplate", "type": "object", "properties": { "name": { "type": "string", "description": "name or desciption of the quota group.", "example": "Illum ipsam error repellendus." }, "quotaCells": { "type": "array", "items": { "$ref": "#/definitions/QuotaCellTemplate" }, "description": "List of quotas", "example": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } }, "example": { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] }, "required": [ "quotaCells" ] }, "QuotaPlanData": { "title": "QuotaPlanData", "type": "object", "properties": { "filters": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "description": "Filters are attributes which all panelists should have before qualifying for a survey", "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, "quotaGroups": { "type": "array", "items": { "$ref": "#/definitions/QuotaGroupData" }, "description": "Quota groups define the allocated targeting attributes for panelists within this line item", "example": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] } }, "example": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] } }, "QuotaPlanTemplate": { "title": "QuotaPlanTemplate", "type": "object", "properties": { "filters": { "type": "array", "items": { "$ref": "#/definitions/TargetingAttribute" }, "description": "Filters are attributes which all panelists should have before qualifying for a survey", "example": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] }, "quotaGroups": { "type": "array", "items": { "$ref": "#/definitions/QuotaGroupTemplate" }, "description": "Quota groups define the allocated targeting attributes for panelists within this line item", "example": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] } }, "example": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] } }, "Quote": { "title": "Quote", "type": "object", "properties": { "costPerUnit": { "type": "number", "description": "Amount Research Now SSI will be paid for each delivered complete", "example": 2.5, "format": "double" }, "currency": { "type": "string", "description": "Currency ISO code", "example": "Hic corrupti commodi." }, "detailedQuote": { "type": "array", "items": { "$ref": "#/definitions/DetailedQuote" }, "description": "Detailed quote with price breakdown", "example": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ] }, "estimatedCost": { "type": "number", "description": "Total estimated cost for the lineitem", "example": 2.5, "format": "double" } }, "example": { "costPerUnit": 2.5, "currency": "Hic corrupti commodi.", "detailedQuote": [ { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 }, { "costPerUnit": 2.5, "estimatedCost": 2.5, "title": "Fuga omnis sunt et veritatis sunt.", "type": "PREMIUM", "units": 7491021699759007000 } ], "estimatedCost": 2.5 } }, "Reason": { "title": "Reason", "type": "object", "properties": { "code": { "type": "string", "description": "code", "example": "Eos soluta tempore." }, "description": { "type": "string", "description": "description", "example": "Quia ut." } }, "example": { "code": "Eos soluta tempore.", "description": "Quia ut." }, "required": [ "code", "description" ] }, "Reconcile": { "title": "Mediatype identifier: application/vnd.projects.reconcile+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/reconcileData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Reconcile media type (default view)", "example": { "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "RefreshTokenPayload": { "title": "RefreshTokenPayload", "type": "object", "properties": { "clientId": { "type": "string", "description": "Client ID", "example": "app1" }, "clientSecret": { "type": "string", "description": "Client Secret", "example": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578" }, "refreshToken": { "type": "string", "description": "Refresh token", "example": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" } }, "example": { "clientId": "app1", "clientSecret": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578", "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" }, "required": [ "clientId", "refreshToken" ] }, "Reprice": { "title": "Mediatype identifier: application/vnd.reprice+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/RepriceData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Reprice media type (default view)", "example": { "data": { "IR": 12.12, "LOI": 12.12, "approvalId": "", "calculatedMaxPrice": 12.12, "completes": 123, "eventId": 123, "id": 123, "newEstimatedCost": 12.12, "originalCPI": 12.12, "originalEstimatedCost": 12.12, "projectId": 123, "quotaGroupId": 123, "reason": "IR_AND_LOI_CHANGE", "requestNewPrice": 12.12, "requiredCompletes": 123 }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "RepriceData": { "title": "RepriceData", "type": "object", "properties": { "IR": { "type": "number", "description": "Incident Rate", "example": 12.12, "format": "double" }, "LOI": { "type": "number", "description": "Length of Interview", "example": 12.12, "format": "double" }, "approvalId": { "type": "string", "description": "Approval ID", "example": "" }, "calculatedMaxPrice": { "type": "number", "description": "Calculated Maximum Price", "example": 12.12, "format": "double" }, "completes": { "type": "integer", "description": "Completes", "example": 123, "format": "int64" }, "eventId": { "type": "integer", "description": "Event ID", "example": 123, "format": "int64" }, "id": { "type": "integer", "description": "ID", "example": 123, "format": "int64" }, "newEstimatedCost": { "type": "number", "description": "New Estimated Cost", "example": 12.12, "format": "double" }, "originalCPI": { "type": "number", "description": "Original Cost Per Incident", "example": 12.12, "format": "double" }, "originalEstimatedCost": { "type": "number", "description": "Original Estimated Cost", "example": 12.12, "format": "double" }, "projectId": { "type": "integer", "description": "Project ID", "example": 123, "format": "int64" }, "quotaGroupId": { "type": "integer", "description": "Quota Group ID", "example": 123, "format": "int64" }, "reason": { "type": "string", "description": "Reason for event: LOI_CHANGE, IR_CHANGE, IR_AND_LOI_CHANGE, UNKNOWN", "example": "IR_AND_LOI_CHANGE", "enum": [ "LOI_CHANGE", "IR_CHANGE", "IR_AND_LOI_CHANGE", "UNKNOWN" ] }, "requestNewPrice": { "type": "number", "description": "Request New Price", "example": 12.12, "format": "double" }, "requiredCompletes": { "type": "integer", "description": "Required Completes", "example": 123, "format": "int64" } }, "example": { "IR": 12.12, "LOI": 12.12, "approvalId": "", "calculatedMaxPrice": 12.12, "completes": 123, "eventId": 123, "id": 123, "newEstimatedCost": 12.12, "originalCPI": 12.12, "originalEstimatedCost": 12.12, "projectId": 123, "quotaGroupId": 123, "reason": "IR_AND_LOI_CHANGE", "requestNewPrice": 12.12, "requiredCompletes": 123 }, "required": [ "id", "eventId", "approvalId", "projectId", "quotaGroupId", "requestNewPrice", "calculatedMaxPrice", "originalCPI", "IR", "LOI", "requiredCompletes", "completes", "originalEstimatedCost", "newEstimatedCost", "reason" ] }, "RepricePayload": { "title": "RepricePayload", "type": "object", "properties": { "IR": { "type": "number", "description": "Incident Rate", "example": 12.12, "format": "double" }, "LOI": { "type": "integer", "description": "Length of Interview", "example": 12, "format": "int64" }, "approvalId": { "type": "string", "description": "Approval ID", "example": "" }, "calculatedMaxPrice": { "type": "number", "description": "Calculated Maximum Price", "example": 12.12, "format": "double" }, "completes": { "type": "integer", "description": "Completes", "example": 123, "format": "int64" }, "newEstimatedCost": { "type": "number", "description": "New Estimated Cost", "example": 12.12, "format": "double" }, "originalCPI": { "type": "number", "description": "Original Cost Per Incident", "example": 12.12, "format": "double" }, "originalEstimatedCost": { "type": "number", "description": "Original Estimated Cost", "example": 12.12, "format": "double" }, "projectId": { "type": "integer", "description": "Project ID", "example": 123, "format": "int64" }, "quotaGroupId": { "type": "integer", "description": "Quota Group ID", "example": 123, "format": "int64" }, "reason": { "type": "string", "description": "Reason for event: UNKNOWN, LOI_CHANGE, IR_CHANGE", "example": "IR_CHANGE" }, "requestNewPrice": { "type": "number", "description": "Request New Price", "example": 12.12, "format": "double" }, "requiredCompletes": { "type": "integer", "description": "Required Completes", "example": 123, "format": "int64" } }, "example": { "IR": 12.12, "LOI": 12, "approvalId": "", "calculatedMaxPrice": 12.12, "completes": 123, "newEstimatedCost": 12.12, "originalCPI": 12.12, "originalEstimatedCost": 12.12, "projectId": 123, "quotaGroupId": 123, "reason": "IR_CHANGE", "requestNewPrice": 12.12, "requiredCompletes": 123 }, "required": [ "approvalId", "projectId", "quotaGroupId", "requestNewPrice", "calculatedMaxPrice", "originalCPI", "IR", "LOI", "requiredCompletes", "completes", "originalEstimatedCost", "newEstimatedCost", "reason" ] }, "Resource": { "title": "Resource", "type": "object", "properties": { "id": { "type": "string", "description": "Project ID or Line Item ID", "example": "Minus atque voluptas mollitia maiores porro dolorem." }, "type": { "type": "string", "description": "Identify the type as Project/LineItem", "example": "Eius vitae molestiae soluta." } }, "example": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." }, "required": [ "id", "type" ] }, "RespondentFilterData": { "title": "RespondentFilterData", "type": "object", "properties": { "dispositions": { "type": "array", "items": { "type": "string", "example": "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" }, "description": "Dispositions", "example": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ] }, "list": { "type": "array", "items": { "type": "string", "example": "Error qui amet at accusantium magnam." }, "description": "List of all the type values", "example": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ] }, "schedule": { "$ref": "#/definitions/schedule" }, "type": { "type": "string", "description": "Type of exclusion", "example": "PROJECT", "enum": [ "PROJECT", "CATEGORY" ] } }, "example": { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" }, "required": [ "type", "list" ] }, "Roles": { "title": "Mediatype identifier: application/vnd.rolesinfo+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/RolesResponseData" }, "example": [ { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" }, { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" }, { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Roles media type (default view)", "example": { "data": [ { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" }, { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" }, { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "RolesResponseData": { "title": "RolesResponseData", "type": "object", "properties": { "allowedActions": { "type": "array", "items": { "$ref": "#/definitions/AllowedActionsData" }, "description": "List of actions of user can perform", "example": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ] }, "assignableRoles": { "type": "array", "items": { "type": "string", "example": "Totam at qui fuga qui sit vero." }, "description": "List of Roles the user can assign", "example": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ] }, "description": { "type": "string", "description": "Role description", "example": "Ducimus suscipit." }, "id": { "type": "string", "description": "Unique Role ID", "example": "PROJECT_MANAGER" }, "name": { "type": "string", "description": "Role name", "example": "Project Manager" } }, "example": { "allowedActions": [ { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" }, { "action": "UPDATE PROJECT", "description": "Updating a Project", "id": "CREATE_PROJECT" } ], "assignableRoles": [ "Totam at qui fuga qui sit vero.", "Totam at qui fuga qui sit vero." ], "description": "Ducimus suscipit.", "id": "PROJECT_MANAGER", "name": "Project Manager" }, "required": [ "id", "name", "description", "allowedActions", "assignableRoles" ] }, "SalesOrder": { "title": "SalesOrder", "type": "object", "properties": { "basicSecurityKey": { "type": "string", "description": "basicSecurityKey", "example": "12668" }, "guid": { "type": "string", "description": "Unique guid", "example": "guid" }, "highSecurityKey": { "type": "string", "description": "highSecurityKey", "example": "12276" }, "name": { "type": "string", "description": "name", "example": "name" }, "noCharge": { "type": "boolean", "description": "noCharge", "example": true }, "orderType": { "type": "string", "description": "orderType", "example": "PRODUCTION_ONLY" }, "ordernumber": { "type": "string", "description": "ordernumber", "example": "ORD123" }, "relatedOrderCpi": { "type": "number", "description": "relatedOrderCpi", "example": 2.5, "format": "double" }, "secureEndLinkLevel": { "type": "integer", "description": "secureEndLinkLevel", "example": 2, "format": "int64" }, "secureEndLinkLevelName": { "type": "string", "description": "secureEndLinkLevelName", "example": "Basic" } }, "example": { "basicSecurityKey": "12668", "guid": "guid", "highSecurityKey": "12276", "name": "name", "noCharge": true, "orderType": "PRODUCTION_ONLY", "ordernumber": "ORD123", "relatedOrderCpi": 2.5, "secureEndLinkLevel": 2, "secureEndLinkLevelName": "Basic" }, "required": [ "guid", "name", "noCharge", "orderType", "ordernumber", "relatedOrderCpi", "basicSecurityKey", "highSecurityKey", "secureEndLinkLevel", "secureEndLinkLevelName" ] }, "SalesOrderDetails": { "title": "SalesOrderDetails", "type": "object", "properties": { "costPerInterview": { "type": "number", "description": "costPerInterview", "example": 2.5, "format": "double" }, "costPerInterviewWithCurrency": { "type": "string", "description": "costPerInterviewWithCurrency", "example": "US" }, "countryIsoCode": { "type": "string", "description": "countryIsoCode", "example": "EN" }, "extendedamount": { "type": "string", "description": "extendedamount", "example": "extendedamount" }, "guid": { "type": "string", "description": "guid", "example": "guid" }, "labelForMobile": { "type": "string", "description": "labelForMobile", "example": "labelForMobile" }, "productIdGuid": { "type": "string", "description": "productIdGuid", "example": "productIdGuid" }, "productIdName": { "type": "string", "description": "productIdName", "example": "productIdName" }, "quantity": { "type": "integer", "description": "quantity", "example": 333, "format": "int64" }, "ssiAdditionalPoints": { "type": "integer", "description": "ssiAdditionalPoints", "example": 0, "format": "int64" }, "ssiCalculatedIr": { "type": "string", "description": "ssiCalculatedIr", "example": "ssiCalculatedIr" }, "ssiCalculatedLoi": { "type": "string", "description": "ssiCalculatedLoi", "example": "ssiCalculatedLoi" }, "ssiChartsNum": { "type": "integer", "description": "ssiChartsNum", "example": 1, "format": "int64" }, "ssiFamilyId": { "type": "string", "description": "ssiFamilyId", "example": "ssiFamilyId" }, "ssiImagesNum": { "type": "integer", "description": "ssiImagesNum", "example": 1, "format": "int64" }, "ssiImagesSpecialNum": { "type": "integer", "description": "ssiImagesSpecialNum", "example": 1, "format": "int64" }, "ssiInputPrice": { "type": "number", "description": "ssiInputPrice", "example": 1, "format": "double" }, "ssiIr": { "type": "integer", "description": "ssiIr", "example": 1, "format": "int64" }, "ssiLabel": { "type": "string", "description": "ssiLabel", "example": "ssiLabel" }, "ssiProductType": { "type": "string", "description": "ssiProductType", "example": "ssiProductType" }, "ssiProductTypeId": { "type": "integer", "description": "ssiProductTypeId", "example": 1, "format": "int64" }, "ssiSampleCountryCode": { "type": "string", "description": "ssiSampleCountryCode", "example": "ssiSampleCountryCode" }, "ssiSampleCountryId": { "type": "string", "description": "ssiSampleCountryId", "example": "ssiSampleCountryId" }, "ssiTitle": { "type": "string", "description": "ssiTitle", "example": "ssiTitle" }, "ssiVendorUsed": { "type": "string", "description": "ssiVendorUsed", "example": "ssiVendorUsed" }, "ssiVideosNum": { "type": "integer", "description": "ssiVideosNum", "example": 1, "format": "int64" }, "vendorLine": { "type": "boolean", "description": "vendorLine", "example": true } }, "example": { "costPerInterview": 2.5, "costPerInterviewWithCurrency": "US", "countryIsoCode": "EN", "extendedamount": "extendedamount", "guid": "guid", "labelForMobile": "labelForMobile", "productIdGuid": "productIdGuid", "productIdName": "productIdName", "quantity": 333, "ssiAdditionalPoints": 0, "ssiCalculatedIr": "ssiCalculatedIr", "ssiCalculatedLoi": "ssiCalculatedLoi", "ssiChartsNum": 1, "ssiFamilyId": "ssiFamilyId", "ssiImagesNum": 1, "ssiImagesSpecialNum": 1, "ssiInputPrice": 1, "ssiIr": 1, "ssiLabel": "ssiLabel", "ssiProductType": "ssiProductType", "ssiProductTypeId": 1, "ssiSampleCountryCode": "ssiSampleCountryCode", "ssiSampleCountryId": "ssiSampleCountryId", "ssiTitle": "ssiTitle", "ssiVendorUsed": "ssiVendorUsed", "ssiVideosNum": 1, "vendorLine": true }, "required": [ "costPerInterview", "costPerInterviewWithCurrency", "countryIsoCode", "extendedamount", "guid", "labelForMobile", "productIdGuid", "productIdName", "quantity", "ssiAdditionalPoints", "ssiCalculatedIr", "ssiCalculatedLoi", "ssiChartsNum", "ssiFamilyId", "ssiImagesNum", "ssiImagesSpecialNum", "ssiInputPrice", "ssiIr", "ssiLabel", "ssiProductType", "ssiProductTypeId", "ssiSampleCountryCode", "ssiSampleCountryId", "ssiTitle", "ssiVendorUsed", "ssiVideosNum", "vendorLine" ] }, "SampleSource": { "title": "SampleSource", "type": "object", "properties": { "category": { "$ref": "#/definitions/SampleSourceCategory" }, "default": { "type": "boolean", "description": "Default Source for country", "example": true }, "deliverySystem": { "type": "string", "description": "Source Delivery System", "example": "nexus" }, "id": { "type": "integer", "description": "Source ID", "example": 123, "format": "int64" }, "name": { "type": "string", "description": "Source name", "example": "United States" } }, "example": { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, "required": [ "id", "name", "deliverySystem", "category", "default" ] }, "SampleSourceCategory": { "title": "SampleSourceCategory", "type": "object", "properties": { "surveyTopics": { "type": "array", "items": { "type": "string", "example": "Tempora ut corporis assumenda vero sapiente et." }, "description": "Survey Topics", "example": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] } }, "example": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "required": [ "surveyTopics" ] }, "SampleSourceData": { "title": "SampleSourceData", "type": "object", "properties": { "countryISOCode": { "type": "string", "description": "Country ISO code", "example": "US" }, "languageISOCode": { "type": "string", "description": "Language ISO code", "example": "en" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/SampleSource" }, "description": "Sample Sources", "example": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] } }, "example": { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] }, "required": [ "countryISOCode", "languageISOCode", "sources" ] }, "SampleSources": { "title": "Mediatype identifier: application/vnd.samplesources+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/SampleSourceData" }, "example": [ { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] }, { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] }, { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "SampleSources media type (default view)", "example": { "data": [ { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] }, { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] }, { "countryISOCode": "US", "languageISOCode": "en", "sources": [ { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" }, { "category": { "surveyTopics": [ "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et.", "Tempora ut corporis assumenda vero sapiente et." ] }, "default": true, "deliverySystem": "nexus", "id": 123, "name": "United States" } ] } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "StateChange": { "title": "Mediatype identifier: application/vnd.statechange+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/StateChangeData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "StateChange media type (default view)", "example": { "data": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "StateChangeData": { "title": "StateChangeData", "type": "object", "properties": { "webhookId": { "type": "string", "description": "Webhook message ID", "example": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" } }, "example": { "webhookId": "4ad796c6-a293-11e9-a2a3-2a2ae2dbcce4" }, "required": [ "webhookId" ] }, "StateChangePayload": { "title": "StateChangePayload", "type": "object", "properties": { "action": { "type": "string", "description": "LineItem Action", "example": "PAUSE" }, "extLineItemId": { "type": "string", "description": "Ext LineItem ID", "example": "lineItem002" }, "extProjectId": { "type": "string", "description": "Ext Project ID", "example": "project001" } }, "example": { "action": "PAUSE", "extLineItemId": "lineItem002", "extProjectId": "project001" }, "required": [ "extProjectId", "extLineItemId", "action" ] }, "Status": { "title": "Status", "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorType" }, "description": "Populated if there are multiple errors", "example": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ] }, "message": { "type": "string", "description": "Human readable explanation specific to this problem", "example": "Dignissimos aut." } }, "example": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." }, "required": [ "message", "errors" ] }, "StudyMetadata": { "title": "Mediatype identifier: application/vnd.studymetadata+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/StudyMetadataInfo" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "StudyMetadata media type (default view)", "example": { "data": { "category": { "studyRequirements": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "studyTypes": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "surveyTopics": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "deliveryTypes": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "StudyMetadataInfo": { "title": "StudyMetadataInfo", "type": "object", "properties": { "category": { "$ref": "#/definitions/CategoryMetadata" }, "deliveryTypes": { "type": "array", "items": { "$ref": "#/definitions/StudyMetadataItem" }, "description": "Delivery types", "example": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] } }, "example": { "category": { "studyRequirements": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "studyTypes": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ], "surveyTopics": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "deliveryTypes": [ { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." } ] }, "required": [ "category", "deliveryTypes" ] }, "StudyMetadataItem": { "title": "StudyMetadataItem", "type": "object", "properties": { "allowed": { "type": "boolean", "description": "Is usage allowed", "example": true }, "description": { "type": "string", "description": "Description", "example": "Cum consequatur quia sed." }, "id": { "type": "string", "description": "Unique identifier", "example": "Voluptates asperiores sequi exercitationem." }, "name": { "type": "string", "description": "Field name", "example": "Esse autem doloremque eos quia eligendi architecto." } }, "example": { "allowed": true, "description": "Cum consequatur quia sed.", "id": "Voluptates asperiores sequi exercitationem.", "name": "Esse autem doloremque eos quia eligendi architecto." }, "required": [ "name", "id", "description", "allowed" ] }, "SupportedLanguage": { "title": "SupportedLanguage", "type": "object", "properties": { "id": { "type": "string", "description": "Unique language ID", "example": "en" }, "isoCode": { "type": "string", "description": "ISO language code", "example": "en" }, "languageName": { "type": "string", "description": "Language name", "example": "English" } }, "example": { "id": "en", "isoCode": "en", "languageName": "English" }, "required": [ "id", "languageName", "isoCode" ] }, "SurveyEndLinks": { "title": "SurveyEndLinks", "type": "object", "properties": { "complete": { "$ref": "#/definitions/SurveyTestLink" }, "overquota": { "$ref": "#/definitions/SurveyTestLink" }, "screenout": { "$ref": "#/definitions/SurveyTestLink" } }, "example": { "complete": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "overquota": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "screenout": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] } }, "required": [ "complete", "screenout", "overquota" ] }, "SurveyTest": { "title": "SurveyTest", "type": "object", "properties": { "disposition": { "type": "string", "description": "indicates the status of the test", "example": "Aut ratione architecto doloribus." }, "failReason": { "type": "string", "description": "if the test wasnt successful, this indicates the reason behind failure", "example": "Ullam sed unde ut recusandae et quaerat." }, "isSuccessful": { "type": "boolean", "description": "denotes if the test was successful or not", "example": false }, "pid": { "type": "string", "description": "Respondent id that was used for this test", "example": "Placeat voluptatibus." }, "psid": { "type": "string", "description": "unique session id that was used for this test", "example": "Quisquam est." }, "testedAt": { "type": "string", "description": "timestamp of when the test was completed", "example": "Quidem veniam ut incidunt dicta quidem necessitatibus." } }, "example": { "disposition": "Aut ratione architecto doloribus.", "failReason": "Ullam sed unde ut recusandae et quaerat.", "isSuccessful": false, "pid": "Placeat voluptatibus.", "psid": "Quisquam est.", "testedAt": "Quidem veniam ut incidunt dicta quidem necessitatibus." }, "required": [ "pid", "psid", "disposition", "testedAt", "isSuccessful" ] }, "SurveyTestId": { "title": "SurveyTestId", "type": "object", "properties": { "pid": { "type": "integer", "description": "pid value", "example": 6567586486103712000, "format": "int64" }, "testSuccessful": { "type": "boolean", "description": "Test successful indicator", "example": false }, "testedAt": { "type": "string", "description": "Timestamp of test", "example": "Expedita magnam et." } }, "example": { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, "required": [ "pid", "testSuccessful", "testedAt" ] }, "SurveyTestLink": { "title": "SurveyTestLink", "type": "object", "properties": { "link": { "type": "string", "description": "URL", "example": "Cum nesciunt quia." }, "testedIds": { "type": "array", "items": { "$ref": "#/definitions/SurveyTestId" }, "description": "List of tested Ids", "example": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] } }, "example": { "link": "Cum nesciunt quia.", "testedIds": [ { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." }, { "pid": 6567586486103712000, "testSuccessful": false, "testedAt": "Expedita magnam et." } ] }, "required": [ "link", "testedIds" ] }, "SwitchCompanyPayload": { "title": "SwitchCompanyPayload", "type": "object", "properties": { "clientId": { "type": "string", "description": "Client ID", "example": "app1" }, "clientSecret": { "type": "string", "description": "Client Secret", "example": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578" }, "companyId": { "type": "number", "description": "Company ID", "example": 1, "format": "double" }, "refreshToken": { "type": "string", "description": "Refresh token", "example": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" } }, "example": { "clientId": "app1", "clientSecret": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578", "companyId": 1, "refreshToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgO...qH1hQ9jv2n3q6T57_F8hZ6hybGRJw" }, "required": [ "clientId", "refreshToken", "companyId" ] }, "Target": { "title": "Target", "type": "object", "properties": { "count": { "type": "integer", "description": "requiredCompletes for COMPLETE target type.", "example": 200, "format": "int64" }, "dailyLimit": { "type": "integer", "description": "target value for dailyLimit", "example": 200, "format": "int64" }, "softLaunch": { "type": "integer", "description": "target value for softLaunch", "example": 200, "format": "int64" }, "type": { "type": "string", "description": "target type can be starts/completes.", "example": "COMPLETE", "enum": [ "COMPLETE" ] } }, "example": { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, "required": [ "type", "count" ] }, "TargetingAttribute": { "title": "TargetingAttribute", "type": "object", "properties": { "attributeId": { "type": "string", "description": "Id of the attribute", "example": "4091" }, "operator": { "type": "string", "description": "option to exclude or include the options for the particular feature id", "example": "exclude", "enum": [ "INCLUDE", "EXCLUDE", "include", "exclude" ] }, "options": { "type": "array", "items": { "type": "string", "example": "Minima delectus omnis qui error nulla modi." }, "description": "Options for the attribute", "example": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } }, "example": { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, "required": [ "attributeId", "options" ] }, "TeamData": { "title": "TeamData", "type": "object", "properties": { "default": { "type": "boolean", "description": "set to true if the team is default for the company", "example": true }, "id": { "type": "integer", "description": "Unique team ID", "example": 1, "format": "int64" }, "name": { "type": "string", "description": "Team name", "example": "Test Team" }, "role": { "type": "string", "description": "Role name", "example": "PROJECT_MANAGER" }, "status": { "type": "string", "description": "Status of the team", "example": "ACTIVE" } }, "example": { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, "required": [ "id", "name", "status", "default", "role" ] }, "TeamItemData": { "title": "TeamItemData", "type": "object", "properties": { "createdAt": { "type": "string", "description": "Timestamp of when the team was created", "example": "07/07/2020 00:00:00" }, "default": { "type": "boolean", "description": "set to true if the team is default for the company", "example": false }, "description": { "type": "string", "description": "Team description", "example": "This is the Test Team" }, "id": { "type": "integer", "description": "Unique team ID", "example": 1, "format": "int64" }, "name": { "type": "string", "description": "Team name", "example": "Test Team" }, "status": { "type": "string", "description": "Status of the team", "example": "ACTIVE" }, "updatedAt": { "type": "string", "description": "Timestamp of when the team was updated", "example": "07/07/2020 00:00:00" } }, "example": { "createdAt": "07/07/2020 00:00:00", "default": false, "description": "This is the Test Team", "id": 1, "name": "Test Team", "status": "ACTIVE", "updatedAt": "07/07/2020 00:00:00" }, "required": [ "id", "name", "description", "status", "createdAt", "updatedAt", "default" ] }, "TeamPermissionData": { "title": "TeamPermissionData", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique team ID", "example": 1, "format": "int64" } }, "example": { "id": 1 }, "required": [ "id" ] }, "Teams": { "title": "Mediatype identifier: application/vnd.teams+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/TeamItemData" }, "example": [ { "createdAt": "07/07/2020 00:00:00", "default": false, "description": "This is the Test Team", "id": 1, "name": "Test Team", "status": "ACTIVE", "updatedAt": "07/07/2020 00:00:00" } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Teams media type (default view)", "example": { "data": [ { "createdAt": "07/07/2020 00:00:00", "default": false, "description": "This is the Test Team", "id": 1, "name": "Test Team", "status": "ACTIVE", "updatedAt": "07/07/2020 00:00:00" } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "TeamsData": { "title": "TeamsData", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique team ID", "example": 1, "format": "int64" }, "name": { "type": "string", "description": "Team name", "example": "Sales Team" } }, "example": { "id": 1, "name": "Sales Team" }, "required": [ "id", "name" ] }, "Template": { "title": "Mediatype identifier: application/vnd.template+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/TemplateData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Template media type (default view)", "example": { "data": { "countryISOCode": "US", "createdAt": "Omnis at ab rerum.", "description": "Targeting template for US census", "editable": true, "id": 111, "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "state": "DEPRECATED", "tags": [ "At eos et omnis deleniti." ], "updatedAt": "Consequatur qui minus neque esse." }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "TemplateData": { "title": "TemplateData", "type": "object", "properties": { "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "createdAt": { "type": "string", "description": "created time.", "example": "Omnis at ab rerum." }, "description": { "type": "string", "description": "Template description", "example": "Targeting template for US census" }, "editable": { "type": "boolean", "description": "specifies if the template is editable or noe", "example": true }, "id": { "type": "integer", "description": "ID", "example": 111, "format": "int64" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "name": { "type": "string", "description": "Template name", "example": "US Census" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanTemplate" }, "state": { "type": "string", "description": "State of the template", "example": "DEPRECATED", "enum": [ "ACTIVE", "DEPRECATED", "INACTIVE" ] }, "tags": { "type": "array", "items": { "type": "string", "example": "At eos et omnis deleniti." }, "description": "Tags to identify the template", "example": [ "At eos et omnis deleniti." ] }, "updatedAt": { "type": "string", "description": "updated time.", "example": "Consequatur qui minus neque esse." } }, "example": { "countryISOCode": "US", "createdAt": "Omnis at ab rerum.", "description": "Targeting template for US census", "editable": true, "id": 111, "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "state": "DEPRECATED", "tags": [ "At eos et omnis deleniti." ], "updatedAt": "Consequatur qui minus neque esse." }, "required": [ "id", "name", "description", "countryISOCode", "languageISOCode", "quotaPlan", "editable", "tags", "state", "createdAt", "updatedAt" ] }, "Templates": { "title": "Mediatype identifier: application/vnd.templates+json; view=default", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/TemplateData" }, "example": [ { "countryISOCode": "US", "createdAt": "Omnis at ab rerum.", "description": "Targeting template for US census", "editable": true, "id": 111, "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "state": "DEPRECATED", "tags": [ "At eos et omnis deleniti." ], "updatedAt": "Consequatur qui minus neque esse." } ] }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "Templates media type (default view)", "example": { "data": [ { "countryISOCode": "US", "createdAt": "Omnis at ab rerum.", "description": "Targeting template for US census", "editable": true, "id": 111, "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "state": "DEPRECATED", "tags": [ "At eos et omnis deleniti." ], "updatedAt": "Consequatur qui minus neque esse." } ], "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "TokenMedia": { "title": "Mediatype identifier: application/vnd.token+json; view=default", "type": "object", "properties": { "accessToken": { "type": "string", "description": "Access token", "example": "Error maiores inventore totam sit." }, "expiresIn": { "type": "integer", "description": "Access token expires in seconds", "example": 6246787585439925000, "format": "int64" }, "refreshExpiresIn": { "type": "integer", "description": "Refresh token expires in seconds", "example": 8173957916431830000, "format": "int64" }, "refreshToken": { "type": "string", "description": "Refresh token", "example": "Voluptas id eum ipsa voluptatem." } }, "description": "TokenMedia media type (default view)", "example": { "accessToken": "Error maiores inventore totam sit.", "expiresIn": 6246787585439925000, "refreshExpiresIn": 8173957916431830000, "refreshToken": "Voluptas id eum ipsa voluptatem." }, "required": [ "accessToken", "expiresIn", "refreshToken", "refreshExpiresIn" ] }, "TokenPayload": { "title": "TokenPayload", "type": "object", "properties": { "clientId": { "type": "string", "description": "Client ID", "example": "app1" }, "clientSecret": { "type": "string", "description": "Client Secret", "example": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578" }, "password": { "type": "string", "description": "User password", "example": "my1P@ssword" }, "username": { "type": "string", "description": "User username", "example": "user1" } }, "example": { "clientId": "app1", "clientSecret": "40cc097b-2a57-4c17-b36a-8fdf3fc2d578", "password": "my1P@ssword", "username": "user1" }, "required": [ "clientId", "username", "password" ] }, "URLParam": { "title": "URLParam", "type": "object", "properties": { "key": { "type": "string", "description": "key of the URL", "example": "4091" }, "values": { "type": "array", "items": { "type": "string", "example": "Minus error." }, "description": "values for the URL key", "example": [ "Minus error.", "Minus error." ] } }, "example": { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, "required": [ "key", "values" ] }, "UpdateLineItem": { "title": "UpdateLineItem", "type": "object", "properties": { "channelDistribution": { "$ref": "#/definitions/ChannelDistribution" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "daysInField": { "type": "integer", "description": "Duration of the project in days.", "example": 5, "format": "int64" }, "deliveryType": { "type": "string", "description": "Delivery type: SLOW, BALANCED, FAST, or BURST.", "example": "Cumque molestiae sit." }, "dynataLineItemReferenceId": { "type": "string", "description": "Sales Order Detail ID of the line item.", "example": "Quod quam est repellendus sunt est cupiditate." }, "fieldSchedule": { "$ref": "#/definitions/fieldSchedule" }, "indicativeIncidence": { "type": "number", "description": "Expected incidence of the survey", "example": 20.5, "format": "double" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "lengthOfInterview": { "type": "integer", "description": "expected duration of the survey in minutes", "example": 10, "format": "int64" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanData" }, "requiredCompletes": { "type": "integer", "description": "Number of complete required for the line item", "example": 200, "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/LineItemSource" }, "description": "id of the source where is the sample coming from", "example": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ] }, "surveyTestURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/test/start?tid=1234567abcdef" }, "surveyTestURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyTestURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "surveyTestingNotes": { "type": "string", "description": "Survey testing notes", "example": "Ipsum et tempora magni optio quidem aliquam." }, "surveyURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/start?tid=1234567abcdef" }, "surveyURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "targets": { "type": "array", "items": { "$ref": "#/definitions/Target" }, "description": "Data of completes/starts required for the line item", "example": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ] }, "title": { "type": "string", "description": "A title for the line item", "example": "US College Grads" } }, "example": { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Cumque molestiae sit.", "dynataLineItemReferenceId": "Quod quam est repellendus sunt est cupiditate.", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" }, { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Ipsum et tempora magni optio quidem aliquam.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" }, { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" } }, "UpdatePermissions": { "title": "UpdatePermissions", "type": "object", "properties": { "teams": { "type": "array", "items": { "$ref": "#/definitions/TeamPermissionData" }, "description": "List of teams to update the permissions", "example": [ { "id": 1 } ] }, "users": { "type": "array", "items": { "$ref": "#/definitions/UserPermissionData" }, "description": "List of users to update the permissions", "example": [ { "id": 1, "role": "PROJECT_MANAGER" } ] } }, "example": { "teams": [ { "id": 1 } ], "users": [ { "id": 1, "role": "PROJECT_MANAGER" } ] } }, "UpdateProjectData": { "title": "UpdateProjectData", "type": "object", "properties": { "category": { "$ref": "#/definitions/ProjectCategoryData" }, "devices": { "type": "array", "items": { "type": "string", "example": "Totam quia asperiores illum ratione repudiandae ut." }, "description": "List of emails to subscribe to notifications", "example": [ "Totam quia asperiores illum ratione repudiandae ut." ] }, "exclusions": { "$ref": "#/definitions/ExclusionData" }, "jobNumber": { "type": "string", "description": "Project job number", "example": "dynata123" }, "lineItems": { "type": "array", "items": { "$ref": "#/definitions/UpdateProjectLineItem" }, "description": "List of line items for the project.", "example": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Quia alias tenetur at.", "dynataLineItemReferenceId": "Voluptatem qui.", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Et voluptatem autem.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Quia alias tenetur at.", "dynataLineItemReferenceId": "Voluptatem qui.", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Et voluptatem autem.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" } ] }, "notificationEmails": { "type": "array", "items": { "type": "string", "example": "Magnam velit rerum enim quae accusamus." }, "description": "List of emails to subscribe to notifications", "example": [ "Magnam velit rerum enim quae accusamus.", "Magnam velit rerum enim quae accusamus.", "Magnam velit rerum enim quae accusamus." ] }, "respondentFilters": { "type": "array", "items": { "$ref": "#/definitions/RespondentFilterData" }, "description": "Inclusion/Exclusions on the project", "example": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" }, { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" }, { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ] }, "title": { "type": "string", "description": "Project title", "example": "Test Survey" }, "useRelevantId": { "type": "boolean", "description": "set to true to dedupe using relevant id", "example": false } }, "example": { "category": { "studyRequirements": [ "Consequatur ut at.", "Consequatur ut at." ], "studyType": [ "Hic repellendus." ], "surveyTopic": [ "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a.", "Quaerat doloremque aliquid a." ] }, "devices": [ "Totam quia asperiores illum ratione repudiandae ut." ], "exclusions": { "list": [ "Et mollitia velit nihil aliquid." ], "type": "CATEGORY" }, "jobNumber": "dynata123", "lineItems": [ { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Quia alias tenetur at.", "dynataLineItemReferenceId": "Voluptatem qui.", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Et voluptatem autem.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" }, { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Quia alias tenetur at.", "dynataLineItemReferenceId": "Voluptatem qui.", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Et voluptatem autem.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" } ], "notificationEmails": [ "Magnam velit rerum enim quae accusamus.", "Magnam velit rerum enim quae accusamus.", "Magnam velit rerum enim quae accusamus." ], "respondentFilters": [ { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" }, { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" }, { "dispositions": [ "COMPLETED, OVERQUOTA, SCREENOUT, INCOMPLETE" ], "list": [ "Error qui amet at accusantium magnam.", "Error qui amet at accusantium magnam." ], "schedule": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 }, "type": "PROJECT" } ], "title": "Test Survey", "useRelevantId": false } }, "UpdateProjectLineItem": { "title": "UpdateProjectLineItem", "type": "object", "properties": { "channelDistribution": { "$ref": "#/definitions/ChannelDistribution" }, "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "daysInField": { "type": "integer", "description": "Duration of the project in days.", "example": 5, "format": "int64" }, "deliveryType": { "type": "string", "description": "Delivery type: SLOW, BALANCED, FAST or BURST.", "example": "Quia alias tenetur at." }, "dynataLineItemReferenceId": { "type": "string", "description": "Sales Order Detail ID of the line item.", "example": "Voluptatem qui." }, "extLineItemId": { "type": "string", "description": "Unique line item Id", "example": "lineItem001" }, "fieldSchedule": { "$ref": "#/definitions/fieldSchedule" }, "indicativeIncidence": { "type": "number", "description": "Expected incidence of the survey", "example": 20.5, "format": "double" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "lengthOfInterview": { "type": "integer", "description": "expected duration of the survey in minutes", "example": 10, "format": "int64" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanData" }, "requiredCompletes": { "type": "integer", "description": "Number of complete required for the line item", "example": 200, "format": "int64" }, "sources": { "type": "array", "items": { "$ref": "#/definitions/LineItemSource" }, "description": "id of the source where is the sample coming from", "example": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ] }, "surveyTestURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/test/start?tid=1234567abcdef" }, "surveyTestURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyTestURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "surveyTestingNotes": { "type": "string", "description": "Survey testing notes", "example": "Et voluptatem autem." }, "surveyURL": { "type": "string", "description": "Entry link for the user.", "example": "http://researchnow.com/survey/start?tid=1234567abcdef" }, "surveyURLParams": { "type": "array", "items": { "$ref": "#/definitions/URLParam" }, "description": "SurveyURL Params of the line item.", "example": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ] }, "targets": { "type": "array", "items": { "$ref": "#/definitions/Target" }, "description": "Data of completes/starts required for the line item", "example": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ] }, "title": { "type": "string", "description": "A title for the line item", "example": "US College Grads" } }, "example": { "channelDistribution": { "integratedChannelPercent": 44, "loyaltyChannelPercent": 10, "openChannelPercent": 46 }, "countryISOCode": "US", "daysInField": 5, "deliveryType": "Quia alias tenetur at.", "dynataLineItemReferenceId": "Voluptatem qui.", "extLineItemId": "lineItem001", "fieldSchedule": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" }, "indicativeIncidence": 20.5, "languageISOCode": "en", "lengthOfInterview": 10, "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." }, { "name": "Porro quod voluptatem porro velit.", "quotaCells": [ { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" }, { "count": 15, "externalQuotaCellId": "Itaque ab rerum.", "perc": 15, "quotaCellId": "Quis delectus error nisi.", "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "status": "PAUSED" } ], "quotaGroupId": "Et dicta tenetur." } ] }, "requiredCompletes": 200, "sources": [ { "id": 6652941744735571000, "name": "dynata Consumer" } ], "surveyTestURL": "http://researchnow.com/survey/test/start?tid=1234567abcdef", "surveyTestURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "surveyTestingNotes": "Et voluptatem autem.", "surveyURL": "http://researchnow.com/survey/start?tid=1234567abcdef", "surveyURLParams": [ { "key": "4091", "values": [ "Minus error.", "Minus error." ] }, { "key": "4091", "values": [ "Minus error.", "Minus error." ] } ], "targets": [ { "count": 200, "dailyLimit": 200, "softLaunch": 200, "type": "COMPLETE" } ], "title": "US College Grads" }, "required": [ "extLineItemId" ] }, "UpdateTemplate": { "title": "UpdateTemplate", "type": "object", "properties": { "countryISOCode": { "type": "string", "description": "ISO country code", "example": "US" }, "description": { "type": "string", "description": "Template description", "example": "Targeting template for US census" }, "languageISOCode": { "type": "string", "description": "ISO language code", "example": "en" }, "name": { "type": "string", "description": "Template name", "example": "US Census" }, "quotaPlan": { "$ref": "#/definitions/QuotaPlanTemplate" }, "tags": { "type": "array", "items": { "type": "string", "example": "Autem ea quo provident velit harum nemo." }, "description": "Tags to identify the template", "example": [ "Autem ea quo provident velit harum nemo.", "Autem ea quo provident velit harum nemo.", "Autem ea quo provident velit harum nemo." ] } }, "example": { "countryISOCode": "US", "description": "Targeting template for US census", "languageISOCode": "en", "name": "US Census", "quotaPlan": { "filters": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ], "quotaGroups": [ { "name": "Illum ipsam error repellendus.", "quotaCells": [ { "perc": 15, "quotaNodes": [ { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] }, { "attributeId": "4091", "operator": "exclude", "options": [ "Minima delectus omnis qui error nulla modi.", "Minima delectus omnis qui error nulla modi." ] } ] } ] } ] }, "tags": [ "Autem ea quo provident velit harum nemo.", "Autem ea quo provident velit harum nemo.", "Autem ea quo provident velit harum nemo." ] }, "required": [ "name", "description", "countryISOCode", "languageISOCode", "quotaPlan" ] }, "User": { "title": "Mediatype identifier: application/vnd.user+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/UserResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "User media type (default view)", "example": { "data": { "companies": [ { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] }, { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] } ], "currentCompanyId": 1, "email": "sample.user@dynata.com", "fullName": "Sample User", "id": 1, "userName": "sample_user" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "UserInfo": { "title": "Mediatype identifier: application/vnd.userinfo+json; view=default", "type": "object", "properties": { "data": { "$ref": "#/definitions/UserInfoResponseData" }, "meta": { "$ref": "#/definitions/Meta" }, "status": { "$ref": "#/definitions/Status" } }, "description": "UserInfo media type (default view)", "example": { "data": { "applications": [ { "appId": 1, "current": true, "default": false, "name": "AppCity" }, { "appId": 1, "current": true, "default": false, "name": "AppCity" } ], "companyId": 1, "companyName": "Test Company", "email": "sample.user@dynata.com", "fullName": "Sample User", "userName": "sample_user" }, "meta": { "links": { "first": "Natus consequatur cumque ipsam vel.", "last": "Omnis dignissimos facilis inventore ea animi eveniet.", "next": "Provident quo enim quod.", "prev": "Unde ad quidem consequuntur.", "self": "Eum et." }, "pageSize": 2368005390717368000, "total": 1737945077937721300 }, "status": { "errors": [ { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } }, { "code": "Cupiditate nesciunt atque.", "message": "Quod doloribus.", "resource": { "id": "Minus atque voluptas mollitia maiores porro dolorem.", "type": "Eius vitae molestiae soluta." } } ], "message": "Dignissimos aut." } }, "required": [ "data", "meta", "status" ] }, "UserInfoResponseData": { "title": "UserInfoResponseData", "type": "object", "properties": { "applications": { "type": "array", "items": { "$ref": "#/definitions/ApplicationItemData" }, "description": "List of applications for the user.", "example": [ { "appId": 1, "current": true, "default": false, "name": "AppCity" }, { "appId": 1, "current": true, "default": false, "name": "AppCity" } ] }, "companyId": { "type": "integer", "description": "Unique company ID", "example": 1, "format": "int64" }, "companyName": { "type": "string", "description": "Comopany name", "example": "Test Company" }, "email": { "type": "string", "description": "email of the current user", "example": "sample.user@dynata.com" }, "fullName": { "type": "string", "description": "Full name of the current user", "example": "Sample User" }, "userName": { "type": "string", "description": "username of the current user", "example": "sample_user" } }, "example": { "applications": [ { "appId": 1, "current": true, "default": false, "name": "AppCity" }, { "appId": 1, "current": true, "default": false, "name": "AppCity" } ], "companyId": 1, "companyName": "Test Company", "email": "sample.user@dynata.com", "fullName": "Sample User", "userName": "sample_user" }, "required": [ "companyId", "companyName", "applications", "fullName", "userName", "email" ] }, "UserPermissionData": { "title": "UserPermissionData", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique user ID", "example": 1, "format": "int64" }, "role": { "type": "string", "description": "Role name", "example": "PROJECT_MANAGER" } }, "example": { "id": 1, "role": "PROJECT_MANAGER" }, "required": [ "id", "role" ] }, "UserResponseData": { "title": "UserResponseData", "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/definitions/CompanyData" }, "description": "List of companies for the user.", "example": [ { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] }, { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] } ] }, "currentCompanyId": { "type": "integer", "description": "company ID of the current user", "example": 1, "format": "int64" }, "email": { "type": "string", "description": "email of the current user", "example": "sample.user@dynata.com" }, "fullName": { "type": "string", "description": "Full name of the current user", "example": "Sample User" }, "id": { "type": "integer", "description": "Unique user ID", "example": 1, "format": "int64" }, "userName": { "type": "string", "description": "username of the current user", "example": "sample_user" } }, "example": { "companies": [ { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] }, { "default": false, "defaultRole": "PROJECT_MANAGER", "id": 1, "name": "Test Company", "teams": [ { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" }, { "default": true, "id": 1, "name": "Test Team", "role": "PROJECT_MANAGER", "status": "ACTIVE" } ] } ], "currentCompanyId": 1, "email": "sample.user@dynata.com", "fullName": "Sample User", "id": 1, "userName": "sample_user" }, "required": [ "id", "companies", "fullName", "userName", "email", "currentCompanyId" ] }, "UsersData": { "title": "UsersData", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique user ID", "example": 1, "format": "int64" }, "role": { "type": "string", "description": "Role name", "example": "PROJECT_MANAGER" }, "username": { "type": "string", "description": "username of the user", "example": "creedbratton" } }, "example": { "id": 1, "role": "PROJECT_MANAGER", "username": "creedbratton" }, "required": [ "id", "username", "role" ] }, "UsersItemData": { "title": "UsersItemData", "type": "object", "properties": { "email": { "type": "string", "description": "email of the current user", "example": "sample.user@dynata.com" }, "id": { "type": "integer", "description": "Unique team ID", "example": 1, "format": "int64" }, "name": { "type": "string", "description": "Full name of the current user", "example": "Sample User" }, "userName": { "type": "string", "description": "username of the current user", "example": "sample_user" } }, "example": { "email": "sample.user@dynata.com", "id": 1, "name": "Sample User", "userName": "sample_user" }, "required": [ "id", "name", "userName", "email" ] }, "fieldSchedule": { "title": "fieldSchedule", "type": "object", "properties": { "endTime": { "type": "string", "description": "Date and time at which the fielding is expected to end in UTC timezone", "example": "2020/06/04 15:36:54" }, "startTime": { "type": "string", "description": "Date and time at which the fielding is expected to start in UTC timezone", "example": "2020/06/04 15:36:54" } }, "example": { "endTime": "2020/06/04 15:36:54", "startTime": "2020/06/04 15:36:54" } }, "reconcileData": { "title": "reconcileData", "type": "object" }, "schedule": { "title": "schedule", "type": "object", "properties": { "endDate": { "type": "string", "description": "End date for custom schedule type", "example": "2021/07/29", "pattern": "^[0-9]{4}/(((0[13578]|(10|12))/(0[1-9]|[1-2][0-9]|3[0-1]))|(02/(0[1-9]|[1-2][0-9]))|((0[469]|11)/(0[1-9]|[1-2][0-9]|30)))$" }, "startDate": { "type": "string", "description": "Start date for custom schedule type", "example": "2006/01/02", "pattern": "^[0-9]{4}/(((0[13578]|(10|12))/(0[1-9]|[1-2][0-9]|3[0-1]))|(02/(0[1-9]|[1-2][0-9]))|((0[469]|11)/(0[1-9]|[1-2][0-9]|30)))$" }, "type": { "type": "string", "description": "Type of schedule", "example": "LAST_MONTHS", "enum": [ "ALL_DATES", "LAST_DAYS", "LAST_MONTHS", "CUSTOM" ] }, "value": { "type": "integer", "description": "The number of past days/months before", "example": 5, "format": "int64" } }, "example": { "endDate": "2021/07/29", "startDate": "2006/01/02", "type": "LAST_MONTHS", "value": 5 } } }, "responses": { "InternalServerError": { "description": "Internal Server Error" }, "NoContent": { "description": "No Content" }, "NotFound": { "description": "Not Found" }, "OK": { "description": "OK" } }, "securityDefinitions": { "jwt": { "type": "apiKey", "name": "Authorization", "in": "header" } } }