Book Appointment
post
https://server:port/spl/rest/apis/cross/service/appointmentTasks/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The system-generated unique identifier of an account.Example:1589809032
-
appointmentEndDateTime: string
(date-time)
Field Activity's appointment stop Date/Time.Example:
04-12-2021 08:00:00AM
-
appointmentStartDateTime: string
(date-time)
Field Activity's appointment start Date/Time.Example:
04-10-2021 08:00:00AM
-
boStatus: string
Maximum Length:
12
Business Object status.Example:Active
-
fieldActivity: object
fieldActivity
-
fieldTaskType: string
Maximum Length:
254
Defines details about the type of task to be performed and how the system will process the activity.Example:ZZ-FaTypKK
-
ipAddress: string
Maximum Length:
15
IP Address -
referenceId: string
Maximum Length:
30
Unique identifier for a service task created for an appointment.Example:58340022155822
-
requestAppointmentDate: string
(date-time)
The appointment date and time as requested by the customer.Example:
2022-04-14T01:23:11-07:00
-
servicePointId: string
Maximum Length:
10
Indicates the service point where the activity takes place.Example:214672087211
-
webUserId: string
Maximum Length:
30
Unique identifier for web users for the Digital Self Service - Transactions web portal.
Nested Schema : fieldActivity
Type:
Show Source
object
-
fieldActivityId: string
Maximum Length:
10
The system-generated unique identifier for the field activity request.Example:48269690619977
Root Schema : schema
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
The system-generated unique identifier of an account.Example:1589809032
-
appointmentEndDateTime: string
(date-time)
Field Activity's appointment stop Date/Time.Example:
04-12-2021 08:00:00AM
-
appointmentStartDateTime: string
(date-time)
Field Activity's appointment start Date/Time.Example:
04-10-2021 08:00:00AM
-
boStatus: string
Maximum Length:
12
Business Object status.Example:Active
-
fieldActivity: object
fieldActivity
-
fieldTaskType: string
Maximum Length:
254
Defines details about the type of task to be performed and how the system will process the activity.Example:ZZ-FaTypKK
-
ipAddress: string
Maximum Length:
15
IP Address -
referenceId: string
Maximum Length:
30
Unique identifier for a service task created for an appointment.Example:58340022155822
-
requestAppointmentDate: string
(date-time)
The appointment date and time as requested by the customer.Example:
2022-04-14T01:23:11-07:00
-
servicePointId: string
Maximum Length:
10
Indicates the service point where the activity takes place.Example:214672087211
-
webUserId: string
Maximum Length:
30
Unique identifier for web users for the Digital Self Service - Transactions web portal.
Nested Schema : fieldActivity
Type:
Show Source
object
-
fieldActivityId: string
Maximum Length:
10
The system-generated unique identifier for the field activity request.Example:48269690619977
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1BookApList
Type:
Show Source
object
-
appointmentEndDateTime: string
(date-time)
Field Activity's appointment stop Date/Time.Example:
04-12-2021 08:00:00AM
-
appointmentStartDateTime: string
(date-time)
Field Activity's appointment start Date/Time.Example:
04-10-2021 08:00:00AM
-
fieldActivity: object
fieldActivity
-
ipAddress: string
Maximum Length:
15
IP Address -
referenceId: string
Maximum Length:
30
Unique identifier for a service task created for an appointment.Example:58340022155822
-
requestAppointmentDate: string
(date-time)
The appointment date and time as requested by the customer.Example:
2022-04-14T01:23:11-07:00
-
webUserId: string
Maximum Length:
30
Unique identifier for web users for the Digital Self Service - Transactions web portal.
Nested Schema : fieldActivity
Type:
Show Source
object
-
_link: string
_link
-
fieldActivityId: string
Maximum Length:
10
The system-generated unique identifier for the field activity request.Example:48269690619977
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.