Jump to

• Request
• Response

Retrieve Questionnaire Authorization Reasons

get

/spms/v2/ships/{shipId}/reservations/{reservationId}/questionnaireAcknowledgements/{questionnairesAcknowledgementId}/authorizationReasons

This is to retrieve acknowledged questionnaire authorization reasons by reservation id and template id

Request

Supported Media Types

• application/json

Path Parameters

• questionnairesAcknowledgementId(required): number
• reservationId(required): number
• shipId(required): number

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Questionnaire Authorization Reason Response

Type: object

Title: Questionnaire Authorization Reason Response

Questionnaire Authorization Reason Response

Show Source

• items: array items

{
    "title":"Questionnaire Authorization Reason Response",
    "description":"Questionnaire Authorization Reason Response",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/authorizationReason"
            },
            "example":[
                {
                    "authorizedId":"1",
                    "questionId":"1001",
                    "answerId":"1111",
                    "authorizedReasonId":"1",
                    "authorizer":{
                        "id":"1",
                        "name":"Gary"
                    },
                    "authorizedDateTime":"2009-10-31T06:59:00.000",
                    "editor":{
                        "id":"1",
                        "name":"Gary"
                    },
                    "modifiedDateTime":"2009-10-31T06:59:00.000"
                },
                {
                    "authorizedId":"2",
                    "questionId":"1002",
                    "answerId":"222",
                    "authorizedReasonId":"2",
                    "authorizer":{
                        "id":"22",
                        "name":"James"
                    },
                    "authorizedDateTime":"2009-10-31T06:59:00.000",
                    "editor":{
                        "id":"1",
                        "name":"Gary"
                    },
                    "modifiedDateTime":"2009-10-31T06:59:00.000"
                },
                {
                    "authorizedId":"3",
                    "questionId":"1003",
                    "answerId":"333",
                    "authorizedReasonId":"55",
                    "authorizer":{
                        "id":"1",
                        "name":"Gary"
                    },
                    "authorizedDateTime":"2009-10-31T06:59:00.000",
                    "editor":{
                        "id":"1",
                        "name":"Gary"
                    },
                    "modifiedDateTime":"2009-10-31T06:59:00.000"
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object authorizationReason
  Authorization Reason

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/authorizationReason"
    },
    "example":[
        {
            "authorizedId":"1",
            "questionId":"1001",
            "answerId":"1111",
            "authorizedReasonId":"1",
            "authorizer":{
                "id":"1",
                "name":"Gary"
            },
            "authorizedDateTime":"2009-10-31T06:59:00.000",
            "editor":{
                "id":"1",
                "name":"Gary"
            },
            "modifiedDateTime":"2009-10-31T06:59:00.000"
        },
        {
            "authorizedId":"2",
            "questionId":"1002",
            "answerId":"222",
            "authorizedReasonId":"2",
            "authorizer":{
                "id":"22",
                "name":"James"
            },
            "authorizedDateTime":"2009-10-31T06:59:00.000",
            "editor":{
                "id":"1",
                "name":"Gary"
            },
            "modifiedDateTime":"2009-10-31T06:59:00.000"
        },
        {
            "authorizedId":"3",
            "questionId":"1003",
            "answerId":"333",
            "authorizedReasonId":"55",
            "authorizer":{
                "id":"1",
                "name":"Gary"
            },
            "authorizedDateTime":"2009-10-31T06:59:00.000",
            "editor":{
                "id":"1",
                "name":"Gary"
            },
            "modifiedDateTime":"2009-10-31T06:59:00.000"
        }
    ]
}

Example:

[
    {
        "authorizedId":"1",
        "questionId":"1001",
        "answerId":"1111",
        "authorizedReasonId":"1",
        "authorizer":{
            "id":"1",
            "name":"Gary"
        },
        "authorizedDateTime":"2009-10-31T06:59:00.000",
        "editor":{
            "id":"1",
            "name":"Gary"
        },
        "modifiedDateTime":"2009-10-31T06:59:00.000"
    },
    {
        "authorizedId":"2",
        "questionId":"1002",
        "answerId":"222",
        "authorizedReasonId":"2",
        "authorizer":{
            "id":"22",
            "name":"James"
        },
        "authorizedDateTime":"2009-10-31T06:59:00.000",
        "editor":{
            "id":"1",
            "name":"Gary"
        },
        "modifiedDateTime":"2009-10-31T06:59:00.000"
    },
    {
        "authorizedId":"3",
        "questionId":"1003",
        "answerId":"333",
        "authorizedReasonId":"55",
        "authorizer":{
            "id":"1",
            "name":"Gary"
        },
        "authorizedDateTime":"2009-10-31T06:59:00.000",
        "editor":{
            "id":"1",
            "name":"Gary"
        },
        "modifiedDateTime":"2009-10-31T06:59:00.000"
    }
]

Nested Schema : authorizationReason

Type: object

Authorization Reason

Show Source

• answerId(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Questionnaire Answer Id

  Example: 1001
• authorizedDateTime(required): string(ISO 8601)
  Authorized Date Time

  Example: 2009-10-31T06:59:00.000
• authorizedId(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Authorized Id

  Example: 1001
• authorizedReasonId(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Authorized Reason Id

  Example: 1001
• authorizer(required): object authorizer
  Authorizer
• editor(required): object editor
  Editor
• modifiedDateTime(required): string(ISO 8601)
  Modified Date Time

  Example: 2009-10-31T06:59:00.000
• questionId(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Questionnaire Question Id

  Example: 1001

{
    "description":"Authorization Reason",
    "type":"object",
    "properties":{
        "authorizedId":{
            "$ref":"#/definitions/authorizedId"
        },
        "questionId":{
            "$ref":"#/definitions/questionId"
        },
        "answerId":{
            "$ref":"#/definitions/answerId"
        },
        "authorizedReasonId":{
            "$ref":"#/definitions/authorizedReasonId"
        },
        "authorizer":{
            "$ref":"#/definitions/authorizer"
        },
        "authorizedDateTime":{
            "$ref":"#/definitions/authorizedDateTime"
        },
        "editor":{
            "$ref":"#/definitions/editor"
        },
        "modifiedDateTime":{
            "$ref":"#/definitions/modifiedDateTime"
        }
    },
    "required":[
        "authorizedId",
        "questionId",
        "answerId",
        "authorizedReasonId",
        "authorizer",
        "authorizedDateTime",
        "editor",
        "modifiedDateTime"
    ]
}

Nested Schema : authorizer

Type: object

Authorizer

Show Source

• id(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Authorizer Id

  Example: 1001
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Authorizer Name

  Example: Gary

{
    "description":"Authorizer",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/authorizedBy"
        },
        "name":{
            "$ref":"#/definitions/authorizerName"
        }
    },
    "required":[
        "id",
        "name"
    ]
}

Nested Schema : editor

Type: object

Editor

Show Source

• id(required): number
  Minimum Value: 1

  Pattern: ^[0-9]*$

  Editor Id

  Example: 1001
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Editor Name

  Example: Gary

{
    "description":"Editor",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/modifiedBy"
        },
        "name":{
            "$ref":"#/definitions/editorName"
        }
    },
    "required":[
        "id",
        "name"
    ]
}

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter questionnairesAcknowledgementId has incorrect format"
    }
}

Example:

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

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "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: string
• title: string
• type: string

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

404 Response

NOT FOUND

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Authorization cannot be found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Authorization cannot be found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "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: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "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: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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: string
• title: string
• type: string

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

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/QuestionnaireAuthorizatioErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable.  Try again later"
    }
}

Example:

{
    "type":"https://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: string
• title: string
• type: string

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

Back to Top