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
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns updated ExternalHandoffDetails
Root Schema : ResponseDtoWrapper
Type:
Show Source
object
-
data(optional):
ResponseResourceSupport
-
messages(optional):
object ResponseDto
ResponseDto model
Nested Schema : ResponseResourceSupport
Match All
Show Source
-
object
ResponseResourceSupport-allOf[0]
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
Nested Schema : ResponseResourceSupport-allOf[0]
Type:
object
Discriminator:
resouce_type
Nested Schema : httpStatusCode
Type:
array
Schedule Details
Show Source
-
Array of:
object responseCodes
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
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