Jump to

• Request
• Response

Update an existing ExternalHandoff

put

/clmo-handoff-services/service/v1/externalHandoff/{handoffRefNo}/updatestatus

This operation update an existing ExternalHandoff using External Handoff Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• handoffRefNo: string
  handoffRefNo of the External Handoff details that need to be updated

Body ()

Request Body that contains data required for updating handoff response status

Root Schema : ExternalHandoffStatusModel

Type: object

ExternalHandoffService model

Show Source

• errorCode(optional): string
  Error Code for failed handoff
• errorDescription(optional): string
  Error description
• handoffExtRefNo(optional): string
  Handoff External Ref No
• handoffRefNumber: string
  Handoff Reference Number
• handoffStatus(optional): string
  Handoff Status
• remarks(optional): string
  Remarks for the handoff

{
    "description":"ExternalHandoffService model",
    "type":"object",
    "required":[
        "applicationNumber",
        "handoffRefNumber"
    ],
    "properties":{
        "handoffRefNumber":{
            "description":"Handoff Reference Number",
            "type":"string"
        },
        "handoffExtRefNo":{
            "description":"Handoff External Ref No",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks for the handoff",
            "type":"string"
        },
        "handoffStatus":{
            "description":"Handoff Status",
            "type":"string"
        },
        "errorCode":{
            "description":"Error Code for failed handoff",
            "type":"string"
        },
        "errorDescription":{
            "description":"Error description",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated ExternalHandoffDetails

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): ResponseResourceSupport
• messages(optional): object ResponseDto
  ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes(optional): string
  Codes
• httpStatusCode(optional): array httpStatusCode
  Schedule Details
• keyId(optional): string
  KeyId
• overrideAuthLevelsReqd(optional): string
  OverrideAuthLevelsReqd
• requestId(optional): string
  RequestId
• status(optional): string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code(optional): string
  Code
• desc(optional): string
  Description
• error(optional): string
  Error
• info(optional): string
  Info
• language(optional): string
  Language
• override(optional): string
  Override
• type(optional): string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top