Stop Service Finalization
post
https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/stopServiceFinalization
This is the final operation called when stopping or transferring service. It is used to update the self-service start/stop/transfer task with any additional contact information for the main customer and to transition it out of the pending status.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
contactDetails: object
contactDetails
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Nested Schema : mailingAddressDetails
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: string
Maximum Length:
3
Country -
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
isSameAsServiceAddress: boolean
Same As Service Address switch indicates whether or not the customer's mailing address is the same as the service address.Example:
true
-
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Root Schema : schema
Type:
Show Source
object
-
contactDetails: object
contactDetails
-
serviceTaskId: string
Maximum Length:
14
Self-Service Task ID is the system-assigned unique identifier of the self-service task.Example:69216126491457
Nested Schema : mailingAddressDetails
Type:
Show Source
object
-
addressLine1: string
Maximum Length:
254
Address -
addressLine2: string
Maximum Length:
254
Address 2 -
addressLine3: string
Maximum Length:
254
Address 3 -
addressLine4: string
Maximum Length:
254
Address 4 -
city: string
Maximum Length:
90
City -
country: string
Maximum Length:
3
Country -
county: string
Maximum Length:
90
County -
geographic: string
Maximum Length:
11
Geographical Code -
houseType: string
Allowed Values:
[ "AB ", "WW " ]
House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference -
inCityLimit: boolean
In City Limit
-
isSameAsServiceAddress: boolean
Same As Service Address switch indicates whether or not the customer's mailing address is the same as the service address.Example:
true
-
number1: string
Maximum Length:
6
Number 1 -
number2: string
Maximum Length:
4
Number 2 -
postal: string
Maximum Length:
12
Postal -
state: string
Maximum Length:
6
State
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Nested Schema : items
Type:
Show Source
object
-
activeInactive: string
Allowed Values:
[ "C1AC", "C1IN" ]
Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive -
contactId: string
Maximum Length:
10
Contact Detail ID is a system-assigned unique identifier of the person contact.Example:4050952629
-
contactNickname: string
Maximum Length:
100
Person contact details nickname.Example:Home
-
contactStatus: string
Allowed Values:
[ "C1AP", "C1PN", "C1RJ" ]
Contact Status indicates the option contact's status. * `C1AP` - Approved, * `C1PN` - Pending, * `C1RJ` - Rejected. -
contactType: string
Maximum Length:
30
Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.Example:HOMEPHONE, WORKEMAIL
-
contactValue: string
Maximum Length:
254
Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.Example:415-123-4567, mark.brazil@email.com
-
contactValueExtension: string
Maximum Length:
6
Extension, if any, of the contact information. (This field is only active when the contact's contact routing is phone or fax.)Example:121
-
doNotDisturbEndTime: string
Do Not Disturb (To) indicates the end time when a person contact should not be used.Example:
20.30.00
-
doNotDisturbStartTime: string
Do Not Disturb (From) indicates the start time when a person contact should not be used.Example:
08.00.00
-
primaryContact: string
Allowed Values:
[ "C1NO", "C1YS" ]
Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SSFinStopS
Type:
Show Source
object
-
finalizeMessages: object
finalizeMessages
-
serviceTaskStatus: string
Allowed Values:
[ "C1CM", "C1ER", "C1PR" ]
Self-Service Task Status indicates the general status of the self-service task. * `C1CM` - Complete, * `C1ER` - Error, * `C1PR` - In Progress
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.