Jump to

• Request
• Response

Get Work Activity Appointment Slots

post

https://server:port/rest/apis/cross/digitalAssets/appointmentSlots/availableSlots

This REST web service provides the details of the available appointment slots over a date range for the crew required for a specified work order activity.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• appointmentRequest: object appointmentRequest

{
    "type":"object",
    "properties":{
        "appointmentRequest":{
            "type":"object",
            "properties":{
                "serviceDate":{
                    "type":"string",
                    "format":"date",
                    "description":"A beginning date from which the crew's availability should be obtained.",
                    "example":"2024-01-12"
                },
                "serviceDays":{
                    "type":"number",
                    "maximum":9,
                    "minimum":0,
                    "description":"Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.",
                    "example":"5"
                },
                "serviceArea":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work."
                },
                "tempWorkOrderIdentifier":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Unique external identifier to fetch Template Work Order."
                },
                "tempWorkActivitySeqNum":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":0,
                    "description":"Template Activity Number.",
                    "example":"1"
                },
                "activityType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records."
                }
            }
        }
    },
    "xml":{
        "name":"X1WAppSlots"
    }
}

Nested Schema : appointmentRequest

Type: object

Show Source

• activityType: string
  Maximum Length: 30

  Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records.
• serviceArea: string
  Maximum Length: 30

  Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work.
• serviceDate: string (date)
  A beginning date from which the crew's availability should be obtained.

  Example: 2024-01-12
• serviceDays: number
  Minimum Value: 0

  Maximum Value: 9

  Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.

  Example: 5
• tempWorkActivitySeqNum: number
  Minimum Value: 0

  Maximum Value: 99999

  Template Activity Number.

  Example: 1
• tempWorkOrderIdentifier: string
  Maximum Length: 60

  Unique external identifier to fetch Template Work Order.

{
    "type":"object",
    "properties":{
        "serviceDate":{
            "type":"string",
            "format":"date",
            "description":"A beginning date from which the crew's availability should be obtained.",
            "example":"2024-01-12"
        },
        "serviceDays":{
            "type":"number",
            "maximum":9,
            "minimum":0,
            "description":"Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.",
            "example":"5"
        },
        "serviceArea":{
            "type":"string",
            "maxLength":30,
            "description":"Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work."
        },
        "tempWorkOrderIdentifier":{
            "type":"string",
            "maxLength":60,
            "description":"Unique external identifier to fetch Template Work Order."
        },
        "tempWorkActivitySeqNum":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Template Activity Number.",
            "example":"1"
        },
        "activityType":{
            "type":"string",
            "maxLength":30,
            "description":"Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• appointmentRequest: object appointmentRequest

{
    "type":"object",
    "properties":{
        "appointmentRequest":{
            "type":"object",
            "properties":{
                "serviceDate":{
                    "type":"string",
                    "format":"date",
                    "description":"A beginning date from which the crew's availability should be obtained.",
                    "example":"2024-01-12"
                },
                "serviceDays":{
                    "type":"number",
                    "maximum":9,
                    "minimum":0,
                    "description":"Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.",
                    "example":"5"
                },
                "serviceArea":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work."
                },
                "tempWorkOrderIdentifier":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Unique external identifier to fetch Template Work Order."
                },
                "tempWorkActivitySeqNum":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":0,
                    "description":"Template Activity Number.",
                    "example":"1"
                },
                "activityType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records."
                }
            }
        }
    },
    "xml":{
        "name":"X1WAppSlots"
    }
}

Nested Schema : appointmentRequest

Type: object

Show Source

• activityType: string
  Maximum Length: 30

  Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records.
• serviceArea: string
  Maximum Length: 30

  Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work.
• serviceDate: string (date)
  A beginning date from which the crew's availability should be obtained.

  Example: 2024-01-12
• serviceDays: number
  Minimum Value: 0

  Maximum Value: 9

  Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.

  Example: 5
• tempWorkActivitySeqNum: number
  Minimum Value: 0

  Maximum Value: 99999

  Template Activity Number.

  Example: 1
• tempWorkOrderIdentifier: string
  Maximum Length: 60

  Unique external identifier to fetch Template Work Order.

{
    "type":"object",
    "properties":{
        "serviceDate":{
            "type":"string",
            "format":"date",
            "description":"A beginning date from which the crew's availability should be obtained.",
            "example":"2024-01-12"
        },
        "serviceDays":{
            "type":"number",
            "maximum":9,
            "minimum":0,
            "description":"Number of Days added to the Service Date to form a date range for retrieving Appointment Slots.",
            "example":"5"
        },
        "serviceArea":{
            "type":"string",
            "maxLength":30,
            "description":"Service areas defines a logical boundary of an organization's territory. Every crew shift is populated with a list of service areas that the crew shift is allowed to work."
        },
        "tempWorkOrderIdentifier":{
            "type":"string",
            "maxLength":60,
            "description":"Unique external identifier to fetch Template Work Order."
        },
        "tempWorkActivitySeqNum":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Template Activity Number.",
            "example":"1"
        },
        "activityType":{
            "type":"string",
            "maxLength":30,
            "description":"Activity types define the main attributes for activities of a certain type and act as a model and template for Activity records."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1WAppSlots

Type: object

Show Source

• appointmentSlots: object appointmentSlots

{
    "type":"object",
    "properties":{
        "appointmentSlots":{
            "type":"object",
            "properties":{
                "crewShiftList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "crewShiftId":{
                                "type":"string",
                                "maxLength":14,
                                "description":"Unique identifier for crew shift."
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Crew Shift Start Date Time.",
                                "example":"2024-01-12-06.00.00"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Crew Shift End Date Time",
                                "example":"2024-01-12-08.00.00"
                            },
                            "crewName":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Name of the crew.",
                                "example":"SMITH"
                            },
                            "crewId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Crew"
                            },
                            "workAvailabilityDuration":{
                                "type":"number",
                                "maximum":9.999999999999E10,
                                "minimum":0,
                                "description":"Duration of Crew availability.",
                                "example":"4"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1WAppSlots"
    }
}

Nested Schema : appointmentSlots

Type: object

Show Source

• crewShiftList: array crewShiftList

{
    "type":"object",
    "properties":{
        "crewShiftList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "crewShiftId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"Unique identifier for crew shift."
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Crew Shift Start Date Time.",
                        "example":"2024-01-12-06.00.00"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Crew Shift End Date Time",
                        "example":"2024-01-12-08.00.00"
                    },
                    "crewName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Name of the crew.",
                        "example":"SMITH"
                    },
                    "crewId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Crew"
                    },
                    "workAvailabilityDuration":{
                        "type":"number",
                        "maximum":9.999999999999E10,
                        "minimum":0,
                        "description":"Duration of Crew availability.",
                        "example":"4"
                    }
                }
            }
        }
    }
}

Nested Schema : crewShiftList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "crewShiftId":{
                "type":"string",
                "maxLength":14,
                "description":"Unique identifier for crew shift."
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Crew Shift Start Date Time.",
                "example":"2024-01-12-06.00.00"
            },
            "endDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Crew Shift End Date Time",
                "example":"2024-01-12-08.00.00"
            },
            "crewName":{
                "type":"string",
                "maxLength":254,
                "description":"Name of the crew.",
                "example":"SMITH"
            },
            "crewId":{
                "type":"string",
                "maxLength":12,
                "description":"Crew"
            },
            "workAvailabilityDuration":{
                "type":"number",
                "maximum":9.999999999999E10,
                "minimum":0,
                "description":"Duration of Crew availability.",
                "example":"4"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• crewId: string
  Maximum Length: 12

  Crew
• crewName: string
  Maximum Length: 254

  Name of the crew.

  Example: SMITH
• crewShiftId: string
  Maximum Length: 14

  Unique identifier for crew shift.
• endDateTime: string (date-time)
  Crew Shift End Date Time

  Example: 2024-01-12-08.00.00
• startDateTime: string (date-time)
  Crew Shift Start Date Time.

  Example: 2024-01-12-06.00.00
• workAvailabilityDuration: number
  Minimum Value: 0

  Maximum Value: 9.999999999999E10

  Duration of Crew availability.

  Example: 4

{
    "type":"object",
    "properties":{
        "crewShiftId":{
            "type":"string",
            "maxLength":14,
            "description":"Unique identifier for crew shift."
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Crew Shift Start Date Time.",
            "example":"2024-01-12-06.00.00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Crew Shift End Date Time",
            "example":"2024-01-12-08.00.00"
        },
        "crewName":{
            "type":"string",
            "maxLength":254,
            "description":"Name of the crew.",
            "example":"SMITH"
        },
        "crewId":{
            "type":"string",
            "maxLength":12,
            "description":"Crew"
        },
        "workAvailabilityDuration":{
            "type":"number",
            "maximum":9.999999999999E10,
            "minimum":0,
            "description":"Duration of Crew availability.",
            "example":"4"
        }
    }
}

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 problemDetailDocument_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":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "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 problemDetailDocument_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":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top