Jump to

• Request
• Response

Retrieve questionnaire authorize reasons

get

/spms/v1/questionnaireAuthorizationReasons

This is to retrieve a list of questionnaire authorize reasons

Request

Supported Media Types

• application/json

Query Parameters

• enabled: boolean
  Activation status of Questionnaire Authorize Reason: * `true` - Questionnaire Authorize Reason is active * `false` - Questionnaire Authorize Reason is inactive
• limit: integer(int32)
  Minimum Value: 1

  Paging limit
• offset: integer(int32)
  Minimum Value: 0

  Paging offset
• reason: string
  Filter Questionnaire Authorize Reason

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : List of Questionnaire Authorize Reason Setup response

Type: object

Title: List of Questionnaire Authorize Reason Setup response

List of Questionnaire Authorize Reason Setup response

Show Source

• count(optional): number
  The total number of items in the list.

  Example: 3
• hasMore(optional): boolean
  Flag which indicates whether or not there are more items.

  Example: false
• items(optional): array items
• limit(optional): number
  Paging limit

  Example: 5
• offset(optional): number
  Paging offset

  Example: 10

{
    "title":"List of Questionnaire Authorize Reason Setup response",
    "description":"List of Questionnaire Authorize Reason Setup response",
    "type":"object",
    "properties":{
        "count":{
            "description":"The total number of items in the list.",
            "type":"number",
            "example":3
        },
        "hasMore":{
            "description":"Flag which indicates whether or not there are more items.",
            "type":"boolean",
            "example":false
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/questionnaireAuthorizeReasonWithId"
            },
            "example":[
                {
                    "id":1001,
                    "reason":"Approved by doctor",
                    "enabled":true
                },
                {
                    "id":1002,
                    "reason":"Approved by police",
                    "enabled":true
                },
                {
                    "id":1003,
                    "reason":"Approved by manager",
                    "enabled":false
                }
            ]
        },
        "limit":{
            "description":"Paging limit",
            "type":"number",
            "example":5
        },
        "offset":{
            "description":"Paging offset",
            "type":"number",
            "example":10
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object questionnaireAuthorizeReasonWithId
  Questionnaire Authorize Reason

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/questionnaireAuthorizeReasonWithId"
    },
    "example":[
        {
            "id":1001,
            "reason":"Approved by doctor",
            "enabled":true
        },
        {
            "id":1002,
            "reason":"Approved by police",
            "enabled":true
        },
        {
            "id":1003,
            "reason":"Approved by manager",
            "enabled":false
        }
    ]
}

Example:

[
    {
        "id":1001,
        "reason":"Approved by doctor",
        "enabled":true
    },
    {
        "id":1002,
        "reason":"Approved by police",
        "enabled":true
    },
    {
        "id":1003,
        "reason":"Approved by manager",
        "enabled":false
    }
]

Nested Schema : questionnaireAuthorizeReasonWithId

Type: object

Questionnaire Authorize Reason

Show Source

• enabled: boolean
  Activation status of Questionnaire Authorize Reason: * `true` - Questionnaire Authorize Reason is active * `false` - Questionnaire Authorize Reason is inactive
• id: number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Questionnaire Authorize Reason id

  Example: 1001
• reason: string
  Minimum Length: 1

  Maximum Length: 255

  Authorization reason

  Example: Approved by doctor

{
    "description":"Questionnaire Authorize Reason",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/id"
        },
        "reason":{
            "$ref":"#/definitions/reason"
        },
        "enabled":{
            "$ref":"#/definitions/enabled"
        }
    },
    "required":[
        "id",
        "reason",
        "enabled"
    ]
}

204 Response

No Content

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter enabled has incorrect format"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter enabled has incorrect format"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Allowed",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizeReasonSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable.  Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): object detail
• title(optional): string
• type(optional): string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"object"
        }
    }
}

Nested Schema : detail

Type: object

Back to Top