Jump to

• Request
• Response

Cancel Service Call

patch

https://server:port/rest/apis/asset/work/serviceCalls/{serviceCallId}/cancelRequest

This operation is used to request the cancelation of a service call. It creates a new communication log and a to do entry to process the cancelation request manually.

Request

Path Parameters

• serviceCallId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• cancelReason: string
  Maximum Length: 4000

  Indicates the reason for the service call cancelation.

  Example: No longer needed.
• comments: string
  Maximum Length: 4000

  Information from the customer.

  Example: Cancel meter read.
• communicationExternald: string
  Maximum Length: 254

  The external system's unique identifier for the communication log.

  Example: CN189761809
• communicationType: string
  Allowed Values: [ "W1CN", "W1EM", "W1PH" ]

  Indicates how the communication was received from the customer. * `W1CN` - Counter, * `W1EM` - Email, * `W1PH` - Phone

  Example: Email
• firstName: string
  Maximum Length: 254

  The first name of the contact person.

  Example: Robert
• homePhone: string
  Maximum Length: 24

  The home phone number of the contact person.

  Example: 330-532-9834
• lastName: string
  Maximum Length: 254

  The last name of the contact person.

  Example: Brown
• mobilePhone: string
  Maximum Length: 24

  The mobile phone number of the contact person.

  Example: 330-532-9834
• primaryPhone: string
  Maximum Length: 24

  The primary phone number of the contact person.

  Example: 330-532-9834

{
    "type":"object",
    "properties":{
        "communicationExternald":{
            "type":"string",
            "maxLength":"254",
            "description":"The external system's unique identifier for the communication log.",
            "example":"CN189761809"
        },
        "comments":{
            "type":"string",
            "maxLength":"4000",
            "description":"Information from the customer.",
            "example":"Cancel meter read."
        },
        "firstName":{
            "type":"string",
            "maxLength":"254",
            "description":"The first name of the contact person.",
            "example":"Robert"
        },
        "lastName":{
            "type":"string",
            "maxLength":"254",
            "description":"The last name of the contact person.",
            "example":"Brown"
        },
        "communicationType":{
            "type":"string",
            "enum":[
                "W1CN",
                "W1EM",
                "W1PH"
            ],
            "description":"Indicates how the communication was received from the customer.\n* `W1CN` - Counter,\n* `W1EM` - Email,\n* `W1PH` - Phone",
            "example":"Email"
        },
        "primaryPhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The primary phone number of the contact person.",
            "example":"330-532-9834"
        },
        "homePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The home phone number of the contact person.",
            "example":"330-532-9834"
        },
        "mobilePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The mobile phone number of the contact person.",
            "example":"330-532-9834"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":"4000",
            "description":"Indicates the reason for the service call cancelation.",
            "example":"No longer needed."
        }
    },
    "xml":{
        "name":"W1ReqCanSC"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cancelReason: string
  Maximum Length: 4000

  Indicates the reason for the service call cancelation.

  Example: No longer needed.
• comments: string
  Maximum Length: 4000

  Information from the customer.

  Example: Cancel meter read.
• communicationExternald: string
  Maximum Length: 254

  The external system's unique identifier for the communication log.

  Example: CN189761809
• communicationType: string
  Allowed Values: [ "W1CN", "W1EM", "W1PH" ]

  Indicates how the communication was received from the customer. * `W1CN` - Counter, * `W1EM` - Email, * `W1PH` - Phone

  Example: Email
• firstName: string
  Maximum Length: 254

  The first name of the contact person.

  Example: Robert
• homePhone: string
  Maximum Length: 24

  The home phone number of the contact person.

  Example: 330-532-9834
• lastName: string
  Maximum Length: 254

  The last name of the contact person.

  Example: Brown
• mobilePhone: string
  Maximum Length: 24

  The mobile phone number of the contact person.

  Example: 330-532-9834
• primaryPhone: string
  Maximum Length: 24

  The primary phone number of the contact person.

  Example: 330-532-9834

{
    "type":"object",
    "properties":{
        "communicationExternald":{
            "type":"string",
            "maxLength":"254",
            "description":"The external system's unique identifier for the communication log.",
            "example":"CN189761809"
        },
        "comments":{
            "type":"string",
            "maxLength":"4000",
            "description":"Information from the customer.",
            "example":"Cancel meter read."
        },
        "firstName":{
            "type":"string",
            "maxLength":"254",
            "description":"The first name of the contact person.",
            "example":"Robert"
        },
        "lastName":{
            "type":"string",
            "maxLength":"254",
            "description":"The last name of the contact person.",
            "example":"Brown"
        },
        "communicationType":{
            "type":"string",
            "enum":[
                "W1CN",
                "W1EM",
                "W1PH"
            ],
            "description":"Indicates how the communication was received from the customer.\n* `W1CN` - Counter,\n* `W1EM` - Email,\n* `W1PH` - Phone",
            "example":"Email"
        },
        "primaryPhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The primary phone number of the contact person.",
            "example":"330-532-9834"
        },
        "homePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The home phone number of the contact person.",
            "example":"330-532-9834"
        },
        "mobilePhone":{
            "type":"string",
            "maxLength":"24",
            "description":"The mobile phone number of the contact person.",
            "example":"330-532-9834"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":"4000",
            "description":"Indicates the reason for the service call cancelation.",
            "example":"No longer needed."
        }
    },
    "xml":{
        "name":"W1ReqCanSC"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : W1ReqCanSC

Type: object

Show Source

• _self: string
  _self
• communication: object communication
• communicationExternald: string
  Maximum Length: 254

  The external system's unique identifier for the communication log.

  Example: CN189761809
• serviceCallId: string
  Maximum Length: 14

  The system-generated unique identifier for the service call.

  Example: 20124908366206
• toDoEntry: object toDoEntry

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "serviceCallId":{
            "type":"string",
            "maxLength":"14",
            "description":"The system-generated unique identifier for the service call.",
            "example":"20124908366206"
        },
        "communication":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "communicationId":{
                    "type":"string",
                    "maxLength":"14",
                    "description":"The system-generated unique identifier for the communication log.",
                    "example":"17796561499666"
                }
            }
        },
        "communicationExternald":{
            "type":"string",
            "maxLength":"254",
            "description":"The external system's unique identifier for the communication log.",
            "example":"CN189761809"
        },
        "toDoEntry":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "toDoEntryId":{
                    "type":"string",
                    "maxLength":"14",
                    "description":"The system-generated unique identifier for the to do.",
                    "example":"34124734366378"
                }
            }
        }
    },
    "xml":{
        "name":"W1ReqCanSC"
    }
}

Nested Schema : communication

Type: object

Show Source

• _link: string
  _link
• communicationId: string
  Maximum Length: 14

  The system-generated unique identifier for the communication log.

  Example: 17796561499666

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "communicationId":{
            "type":"string",
            "maxLength":"14",
            "description":"The system-generated unique identifier for the communication log.",
            "example":"17796561499666"
        }
    }
}

Nested Schema : toDoEntry

Type: object

Show Source

• _link: string
  _link
• toDoEntryId: string
  Maximum Length: 14

  The system-generated unique identifier for the to do.

  Example: 34124734366378

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "toDoEntryId":{
            "type":"string",
            "maxLength":"14",
            "description":"The system-generated unique identifier for the to do.",
            "example":"34124734366378"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top