Questions

Create questions

post

Create new questions for a survey

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

anyOptional

Responses

200Success

application/json

post

/api/surveys/questions

POST /api/surveys/questions HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Upsert questions

put

Create or update questions for a survey

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

surveyIdstringRequiredPattern: [^\/#\?]+?

Body

anyOptional

Responses

200Success

application/json

put

/api/surveys/{surveyId}/questions

PUT /api/surveys/{surveyId}/questions HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Update a question

put

Update a specific question in a survey

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

surveyIdstringRequiredPattern: [^\/#\?]+?

questionIdstringRequiredPattern: [^\/#\?]+?

Body

idstringOptional

Unique identifier for the question

Example: 12345

surveyIdstringOptional

Identifier for the survey

Example: survey123

maxLengthnumberOptional

Maximum length of the answer

Example: 255

pageNumbernumberRequired

Page number where the question appears

Default: 1Example: 1

parentQuestionIdstringOptional

Identifier for the parent question

Example: parent123

ordernumberOptional

Order of the question

Example: 1

scorenumberOptional

Score associated with the question

Example: 10

answerValueSetstringOptional

Value set for the answer

Example: valueSet123

linkIdstringRequired

Link identifier

Example: link123

headingstringOptional

Heading of the question

Example: Question Heading

labelstringOptional

Label of the question

Example: Question Label

definitionstringOptional

Definition of the question

Example: Question Definition

prefixstringOptional

Prefix for the question

Example: Q

textstringOptional

Text of the question

Example: What is your name?

multiSelectbooleanOptional

Indicates if multiple selections are allowed

Example: true

typestring · enumRequired

Type of the question

Default: textExample: radioButtonPossible values:

displayTypestring · enumOptional

Display type of the question

Default: shortAnswerExample: multipleChoicePossible values:

enableBehaviorstring · enumOptional

Behavior to enable the question

Default: anyExample: allPossible values:

requiredbooleanOptional

Indicates if the question is required

Example: true

repeatsbooleanOptional

Indicates if the question can be repeated

Example: true

readOnlybooleanOptional

Indicates if the question is read-only

Example: true

attributesanyOptional

Additional attributes for the question

Default: {}

Responses

200Success

application/json

put

/api/surveys/{surveyId}/questions/{questionId}

PUT /api/surveys/{surveyId}/questions/{questionId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 588

{
  "id": "12345",
  "surveyId": "survey123",
  "maxLength": 255,
  "pageNumber": 1,
  "parentQuestionId": "parent123",
  "order": 1,
  "score": 10,
  "answerValueSet": "valueSet123",
  "linkId": "link123",
  "heading": "Question Heading",
  "label": "Question Label",
  "definition": "Question Definition",
  "prefix": "Q",
  "text": "What is your name?",
  "multiSelect": true,
  "type": "radioButton",
  "displayType": "multipleChoice",
  "enableBehavior": "all",
  "required": true,
  "repeats": true,
  "readOnly": true,
  "initial": [
    "initial1",
    "initial2"
  ],
  "code": [
    "code1",
    "code2"
  ],
  "extension": [
    "ext1",
    "ext2"
  ],
  "item": [],
  "answerOption": [],
  "enableWhen": [],
  "attributes": {}
}

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Update a question

put

Update a specific question

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

questionIdstringRequiredPattern: [^\/#\?]+?

Body

idstringOptional

Unique identifier for the question

Example: 12345

surveyIdstringOptional

Identifier for the survey

Example: survey123

maxLengthnumberOptional

Maximum length of the answer

Example: 255

pageNumbernumberRequired

Page number where the question appears

Default: 1Example: 1

parentQuestionIdstringOptional

Identifier for the parent question

Example: parent123

ordernumberOptional

Order of the question

Example: 1

scorenumberOptional

Score associated with the question

Example: 10

answerValueSetstringOptional

Value set for the answer

Example: valueSet123

linkIdstringRequired

Link identifier

Example: link123

headingstringOptional

Heading of the question

Example: Question Heading

labelstringOptional

Label of the question

Example: Question Label

definitionstringOptional

Definition of the question

Example: Question Definition

prefixstringOptional

Prefix for the question

Example: Q

textstringOptional

Text of the question

Example: What is your name?

multiSelectbooleanOptional

Indicates if multiple selections are allowed

Example: true

typestring · enumRequired

Type of the question

Default: textExample: radioButtonPossible values:

displayTypestring · enumOptional

Display type of the question

Default: shortAnswerExample: multipleChoicePossible values:

enableBehaviorstring · enumOptional

Behavior to enable the question

Default: anyExample: allPossible values:

requiredbooleanOptional

Indicates if the question is required

Example: true

repeatsbooleanOptional

Indicates if the question can be repeated

Example: true

readOnlybooleanOptional

Indicates if the question is read-only

Example: true

attributesanyOptional

Additional attributes for the question

Default: {}

Responses

200Success

application/json

put

/api/surveys/questions/{questionId}

PUT /api/surveys/questions/{questionId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 588

{
  "id": "12345",
  "surveyId": "survey123",
  "maxLength": 255,
  "pageNumber": 1,
  "parentQuestionId": "parent123",
  "order": 1,
  "score": 10,
  "answerValueSet": "valueSet123",
  "linkId": "link123",
  "heading": "Question Heading",
  "label": "Question Label",
  "definition": "Question Definition",
  "prefix": "Q",
  "text": "What is your name?",
  "multiSelect": true,
  "type": "radioButton",
  "displayType": "multipleChoice",
  "enableBehavior": "all",
  "required": true,
  "repeats": true,
  "readOnly": true,
  "initial": [
    "initial1",
    "initial2"
  ],
  "code": [
    "code1",
    "code2"
  ],
  "extension": [
    "ext1",
    "ext2"
  ],
  "item": [],
  "answerOption": [],
  "enableWhen": [],
  "attributes": {}
}

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Delete a question

delete

Delete a specific question

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

questionIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/surveys/questions/{questionId}

DELETE /api/surveys/questions/{questionId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

PreviousVersion NextUser content