Jump to

• Request
• Response

Retrieve Pending Tasks

post

https://server:port/spl/rest/apis/cross/service/appointmentTasks/tasks

This Operation handles the Integration Suite API to Search Appointment Tasks.

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

• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 1589809032
• appointmentList: array appointmentList
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589809032"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "appointmentList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "referenceId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Reference ID for a service task created for an appointment."
                    },
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                        "example":"48269690619977"
                    },
                    "fieldTaskType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                        "example":"ZZ-FaTypKK"
                    },
                    "fieldTaskTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description for the Field Task Type.",
                        "example":"Test Field Task Type - KK"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID indicates service point where the activity takes place",
                        "example":"214672087211"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Time Zone"
                    },
                    "timeZoneDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Time Zone Descr"
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Time Zone Name"
                    },
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Point Type"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Service Point Type Description"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Service Type Description"
                    },
                    "meterId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "appointmentStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Start Date/Time",
                        "example":"04-10-2021 08:00:00AM"
                    },
                    "appointmentEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Stop Date/Time",
                        "example":"04-12-2021 08:00:00AM"
                    },
                    "serviceDate":{
                        "type":"string",
                        "maxLength":26,
                        "description":"FA's Start Date/Time"
                    },
                    "isStartStopEvent":{
                        "type":"boolean",
                        "description":"Start/Stop Event flag",
                        "example":"true"
                    },
                    "isAppointmentSet":{
                        "type":"boolean",
                        "description":"Is Appointment Set"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Postal"
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address"
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 2"
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 3"
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 4"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"City"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Number 2"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"County"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Geographical Code"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"State"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : appointmentList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "referenceId":{
                "type":"string",
                "maxLength":30,
                "description":"Reference ID for a service task created for an appointment."
            },
            "fieldActivityId":{
                "type":"string",
                "maxLength":10,
                "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                "example":"48269690619977"
            },
            "fieldTaskType":{
                "type":"string",
                "maxLength":254,
                "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                "example":"ZZ-FaTypKK"
            },
            "fieldTaskTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description for the Field Task Type.",
                "example":"Test Field Task Type - KK"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID indicates service point where the activity takes place",
                "example":"214672087211"
            },
            "timeZone":{
                "type":"string",
                "maxLength":10,
                "description":"Time Zone"
            },
            "timeZoneDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Time Zone Descr"
            },
            "timeZoneName":{
                "type":"string",
                "maxLength":50,
                "description":"Time Zone Name"
            },
            "servicePointType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Point Type"
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":50,
                "description":"Service Point Type Description"
            },
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Service Type Description"
            },
            "meterId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "appointmentStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Start Date/Time",
                "example":"04-10-2021 08:00:00AM"
            },
            "appointmentEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Stop Date/Time",
                "example":"04-12-2021 08:00:00AM"
            },
            "serviceDate":{
                "type":"string",
                "maxLength":26,
                "description":"FA's Start Date/Time"
            },
            "isStartStopEvent":{
                "type":"boolean",
                "description":"Start/Stop Event flag",
                "example":"true"
            },
            "isAppointmentSet":{
                "type":"boolean",
                "description":"Is Appointment Set"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Postal"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 2"
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 3"
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 4"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"City"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"County"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"State"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• appointmentEndDateTime: string (date-time)
  FA's Appointment Stop Date/Time

  Example: 04-12-2021 08:00:00AM
• appointmentStartDateTime: string (date-time)
  FA's Appointment Start Date/Time

  Example: 04-10-2021 08:00:00AM
• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID is the system-generated unique identifier for the field activity request.

  Example: 48269690619977
• fieldTaskType: string
  Maximum Length: 254

  Field Task Type defines details about the type of task to be performed and how the system will process the activity.

  Example: ZZ-FaTypKK
• fieldTaskTypeDescription: string
  Maximum Length: 60

  Description for the Field Task Type.

  Example: Test Field Task Type - KK
• isAppointmentSet: boolean
  Is Appointment Set
• isStartStopEvent: boolean
  Start/Stop Event flag

  Example: true
• meterId: string
  Maximum Length: 12

  Device ID
• referenceId: string
  Maximum Length: 30

  Reference ID for a service task created for an appointment.
• serviceDate: string
  Maximum Length: 26

  FA's Start Date/Time
• servicePointId: string
  Maximum Length: 10

  Service Point ID indicates service point where the activity takes place

  Example: 214672087211
• servicePointType: string
  Maximum Length: 30

  Service Point Type
• servicePointTypeDescription: string
  Maximum Length: 50

  Service Point Type Description
• serviceType: string
  Maximum Length: 80

  Service Type
• serviceTypeDescription: string
  Maximum Length: 100

  Service Type Description
• timeZone: string
  Maximum Length: 10

  Time Zone
• timeZoneDescription: string
  Maximum Length: 60

  Time Zone Descr
• timeZoneName: string
  Maximum Length: 50

  Time Zone Name

{
    "type":"object",
    "properties":{
        "referenceId":{
            "type":"string",
            "maxLength":30,
            "description":"Reference ID for a service task created for an appointment."
        },
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
            "example":"48269690619977"
        },
        "fieldTaskType":{
            "type":"string",
            "maxLength":254,
            "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
            "example":"ZZ-FaTypKK"
        },
        "fieldTaskTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for the Field Task Type.",
            "example":"Test Field Task Type - KK"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID indicates service point where the activity takes place",
            "example":"214672087211"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone"
        },
        "timeZoneDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Time Zone Descr"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"Time Zone Name"
        },
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":50,
            "description":"Service Point Type Description"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Service Type Description"
        },
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "appointmentStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Start Date/Time",
            "example":"04-10-2021 08:00:00AM"
        },
        "appointmentEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Stop Date/Time",
            "example":"04-12-2021 08:00:00AM"
        },
        "serviceDate":{
            "type":"string",
            "maxLength":26,
            "description":"FA's Start Date/Time"
        },
        "isStartStopEvent":{
            "type":"boolean",
            "description":"Start/Stop Event flag",
            "example":"true"
        },
        "isAppointmentSet":{
            "type":"boolean",
            "description":"Is Appointment Set"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: 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
• 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

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 1589809032
• appointmentList: array appointmentList
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589809032"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "appointmentList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "referenceId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Reference ID for a service task created for an appointment."
                    },
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                        "example":"48269690619977"
                    },
                    "fieldTaskType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                        "example":"ZZ-FaTypKK"
                    },
                    "fieldTaskTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description for the Field Task Type.",
                        "example":"Test Field Task Type - KK"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID indicates service point where the activity takes place",
                        "example":"214672087211"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Time Zone"
                    },
                    "timeZoneDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Time Zone Descr"
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Time Zone Name"
                    },
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Point Type"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Service Point Type Description"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Service Type Description"
                    },
                    "meterId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "appointmentStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Start Date/Time",
                        "example":"04-10-2021 08:00:00AM"
                    },
                    "appointmentEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Stop Date/Time",
                        "example":"04-12-2021 08:00:00AM"
                    },
                    "serviceDate":{
                        "type":"string",
                        "maxLength":26,
                        "description":"FA's Start Date/Time"
                    },
                    "isStartStopEvent":{
                        "type":"boolean",
                        "description":"Start/Stop Event flag",
                        "example":"true"
                    },
                    "isAppointmentSet":{
                        "type":"boolean",
                        "description":"Is Appointment Set"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Postal"
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address"
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 2"
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 3"
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 4"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"City"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Number 2"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"County"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Geographical Code"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"State"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : appointmentList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "referenceId":{
                "type":"string",
                "maxLength":30,
                "description":"Reference ID for a service task created for an appointment."
            },
            "fieldActivityId":{
                "type":"string",
                "maxLength":10,
                "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                "example":"48269690619977"
            },
            "fieldTaskType":{
                "type":"string",
                "maxLength":254,
                "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                "example":"ZZ-FaTypKK"
            },
            "fieldTaskTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description for the Field Task Type.",
                "example":"Test Field Task Type - KK"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID indicates service point where the activity takes place",
                "example":"214672087211"
            },
            "timeZone":{
                "type":"string",
                "maxLength":10,
                "description":"Time Zone"
            },
            "timeZoneDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Time Zone Descr"
            },
            "timeZoneName":{
                "type":"string",
                "maxLength":50,
                "description":"Time Zone Name"
            },
            "servicePointType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Point Type"
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":50,
                "description":"Service Point Type Description"
            },
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Service Type Description"
            },
            "meterId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "appointmentStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Start Date/Time",
                "example":"04-10-2021 08:00:00AM"
            },
            "appointmentEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Stop Date/Time",
                "example":"04-12-2021 08:00:00AM"
            },
            "serviceDate":{
                "type":"string",
                "maxLength":26,
                "description":"FA's Start Date/Time"
            },
            "isStartStopEvent":{
                "type":"boolean",
                "description":"Start/Stop Event flag",
                "example":"true"
            },
            "isAppointmentSet":{
                "type":"boolean",
                "description":"Is Appointment Set"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Postal"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 2"
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 3"
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 4"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"City"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"County"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"State"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• appointmentEndDateTime: string (date-time)
  FA's Appointment Stop Date/Time

  Example: 04-12-2021 08:00:00AM
• appointmentStartDateTime: string (date-time)
  FA's Appointment Start Date/Time

  Example: 04-10-2021 08:00:00AM
• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID is the system-generated unique identifier for the field activity request.

  Example: 48269690619977
• fieldTaskType: string
  Maximum Length: 254

  Field Task Type defines details about the type of task to be performed and how the system will process the activity.

  Example: ZZ-FaTypKK
• fieldTaskTypeDescription: string
  Maximum Length: 60

  Description for the Field Task Type.

  Example: Test Field Task Type - KK
• isAppointmentSet: boolean
  Is Appointment Set
• isStartStopEvent: boolean
  Start/Stop Event flag

  Example: true
• meterId: string
  Maximum Length: 12

  Device ID
• referenceId: string
  Maximum Length: 30

  Reference ID for a service task created for an appointment.
• serviceDate: string
  Maximum Length: 26

  FA's Start Date/Time
• servicePointId: string
  Maximum Length: 10

  Service Point ID indicates service point where the activity takes place

  Example: 214672087211
• servicePointType: string
  Maximum Length: 30

  Service Point Type
• servicePointTypeDescription: string
  Maximum Length: 50

  Service Point Type Description
• serviceType: string
  Maximum Length: 80

  Service Type
• serviceTypeDescription: string
  Maximum Length: 100

  Service Type Description
• timeZone: string
  Maximum Length: 10

  Time Zone
• timeZoneDescription: string
  Maximum Length: 60

  Time Zone Descr
• timeZoneName: string
  Maximum Length: 50

  Time Zone Name

{
    "type":"object",
    "properties":{
        "referenceId":{
            "type":"string",
            "maxLength":30,
            "description":"Reference ID for a service task created for an appointment."
        },
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
            "example":"48269690619977"
        },
        "fieldTaskType":{
            "type":"string",
            "maxLength":254,
            "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
            "example":"ZZ-FaTypKK"
        },
        "fieldTaskTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for the Field Task Type.",
            "example":"Test Field Task Type - KK"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID indicates service point where the activity takes place",
            "example":"214672087211"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone"
        },
        "timeZoneDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Time Zone Descr"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"Time Zone Name"
        },
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":50,
            "description":"Service Point Type Description"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Service Type Description"
        },
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "appointmentStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Start Date/Time",
            "example":"04-10-2021 08:00:00AM"
        },
        "appointmentEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Stop Date/Time",
            "example":"04-12-2021 08:00:00AM"
        },
        "serviceDate":{
            "type":"string",
            "maxLength":26,
            "description":"FA's Start Date/Time"
        },
        "isStartStopEvent":{
            "type":"boolean",
            "description":"Start/Stop Event flag",
            "example":"true"
        },
        "isAppointmentSet":{
            "type":"boolean",
            "description":"Is Appointment Set"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: 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
• 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

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1PenAppList

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The Account ID is a system-assigned random number that stays with an account for life.

  Example: 1589809032
• appointmentList: array appointmentList
• limit: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E8

  Offset
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589809032"
        },
        "limit":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Limit"
        },
        "offset":{
            "type":"number",
            "maximum":9.99999999999999E8,
            "minimum":0,
            "description":"Offset"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "appointmentList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "referenceId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Reference ID for a service task created for an appointment."
                    },
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                        "example":"48269690619977"
                    },
                    "fieldTaskType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                        "example":"ZZ-FaTypKK"
                    },
                    "fieldTaskTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description for the Field Task Type.",
                        "example":"Test Field Task Type - KK"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID indicates service point where the activity takes place",
                        "example":"214672087211"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Time Zone"
                    },
                    "timeZoneDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Time Zone Descr"
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Time Zone Name"
                    },
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Point Type"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Service Point Type Description"
                    },
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Service Type Description"
                    },
                    "meterId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Device ID"
                    },
                    "appointmentStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Start Date/Time",
                        "example":"04-10-2021 08:00:00AM"
                    },
                    "appointmentEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"FA's Appointment Stop Date/Time",
                        "example":"04-12-2021 08:00:00AM"
                    },
                    "serviceDate":{
                        "type":"string",
                        "maxLength":26,
                        "description":"FA's Start Date/Time"
                    },
                    "isStartStopEvent":{
                        "type":"boolean",
                        "description":"Start/Stop Event flag",
                        "example":"true"
                    },
                    "isAppointmentSet":{
                        "type":"boolean",
                        "description":"Is Appointment Set"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Country"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Postal"
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address"
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 2"
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 3"
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Address 4"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"City"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Number 2"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"County"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Geographical Code"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"State"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : appointmentList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "referenceId":{
                "type":"string",
                "maxLength":30,
                "description":"Reference ID for a service task created for an appointment."
            },
            "fieldActivityId":{
                "type":"string",
                "maxLength":10,
                "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
                "example":"48269690619977"
            },
            "fieldTaskType":{
                "type":"string",
                "maxLength":254,
                "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
                "example":"ZZ-FaTypKK"
            },
            "fieldTaskTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description for the Field Task Type.",
                "example":"Test Field Task Type - KK"
            },
            "servicePointId":{
                "type":"string",
                "maxLength":10,
                "description":"Service Point ID indicates service point where the activity takes place",
                "example":"214672087211"
            },
            "timeZone":{
                "type":"string",
                "maxLength":10,
                "description":"Time Zone"
            },
            "timeZoneDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Time Zone Descr"
            },
            "timeZoneName":{
                "type":"string",
                "maxLength":50,
                "description":"Time Zone Name"
            },
            "servicePointType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Point Type"
            },
            "servicePointTypeDescription":{
                "type":"string",
                "maxLength":50,
                "description":"Service Point Type Description"
            },
            "serviceType":{
                "type":"string",
                "maxLength":80,
                "description":"Service Type"
            },
            "serviceTypeDescription":{
                "type":"string",
                "maxLength":100,
                "description":"Service Type Description"
            },
            "meterId":{
                "type":"string",
                "maxLength":12,
                "description":"Device ID"
            },
            "appointmentStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Start Date/Time",
                "example":"04-10-2021 08:00:00AM"
            },
            "appointmentEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"FA's Appointment Stop Date/Time",
                "example":"04-12-2021 08:00:00AM"
            },
            "serviceDate":{
                "type":"string",
                "maxLength":26,
                "description":"FA's Start Date/Time"
            },
            "isStartStopEvent":{
                "type":"boolean",
                "description":"Start/Stop Event flag",
                "example":"true"
            },
            "isAppointmentSet":{
                "type":"boolean",
                "description":"Is Appointment Set"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Country"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Postal"
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address"
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 2"
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 3"
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Address 4"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"City"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Number 2"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"County"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Geographical Code"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"State"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• appointmentEndDateTime: string (date-time)
  FA's Appointment Stop Date/Time

  Example: 04-12-2021 08:00:00AM
• appointmentStartDateTime: string (date-time)
  FA's Appointment Start Date/Time

  Example: 04-10-2021 08:00:00AM
• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID is the system-generated unique identifier for the field activity request.

  Example: 48269690619977
• fieldTaskType: string
  Maximum Length: 254

  Field Task Type defines details about the type of task to be performed and how the system will process the activity.

  Example: ZZ-FaTypKK
• fieldTaskTypeDescription: string
  Maximum Length: 60

  Description for the Field Task Type.

  Example: Test Field Task Type - KK
• isAppointmentSet: boolean
  Is Appointment Set
• isStartStopEvent: boolean
  Start/Stop Event flag

  Example: true
• meterId: string
  Maximum Length: 12

  Device ID
• referenceId: string
  Maximum Length: 30

  Reference ID for a service task created for an appointment.
• serviceDate: string
  Maximum Length: 26

  FA's Start Date/Time
• servicePointId: string
  Maximum Length: 10

  Service Point ID indicates service point where the activity takes place

  Example: 214672087211
• servicePointType: string
  Maximum Length: 30

  Service Point Type
• servicePointTypeDescription: string
  Maximum Length: 50

  Service Point Type Description
• serviceType: string
  Maximum Length: 80

  Service Type
• serviceTypeDescription: string
  Maximum Length: 100

  Service Type Description
• timeZone: string
  Maximum Length: 10

  Time Zone
• timeZoneDescription: string
  Maximum Length: 60

  Time Zone Descr
• timeZoneName: string
  Maximum Length: 50

  Time Zone Name

{
    "type":"object",
    "properties":{
        "referenceId":{
            "type":"string",
            "maxLength":30,
            "description":"Reference ID for a service task created for an appointment."
        },
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID is the system-generated unique identifier for the field activity request.",
            "example":"48269690619977"
        },
        "fieldTaskType":{
            "type":"string",
            "maxLength":254,
            "description":"Field Task Type defines details about the type of task to be performed and how the system will process the activity.",
            "example":"ZZ-FaTypKK"
        },
        "fieldTaskTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description for the Field Task Type.",
            "example":"Test Field Task Type - KK"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID indicates service point where the activity takes place",
            "example":"214672087211"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Time Zone"
        },
        "timeZoneDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Time Zone Descr"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"Time Zone Name"
        },
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Point Type"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":50,
            "description":"Service Point Type Description"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Service Type Description"
        },
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "appointmentStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Start Date/Time",
            "example":"04-10-2021 08:00:00AM"
        },
        "appointmentEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"FA's Appointment Stop Date/Time",
            "example":"04-12-2021 08:00:00AM"
        },
        "serviceDate":{
            "type":"string",
            "maxLength":26,
            "description":"FA's Start Date/Time"
        },
        "isStartStopEvent":{
            "type":"boolean",
            "description":"Start/Stop Event flag",
            "example":"true"
        },
        "isAppointmentSet":{
            "type":"boolean",
            "description":"Is Appointment Set"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Country"
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Postal"
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address"
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 2"
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 3"
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address 4"
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"City"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Number 2"
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"County"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Geographical Code"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"State"
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  Address
• address2: string
  Maximum Length: 254

  Address 2
• address3: string
  Maximum Length: 254

  Address 3
• address4: 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
• 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

{
    "type":"object",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"Country"
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"Postal"
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"Address"
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"Address 2"
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"Address 3"
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"Address 4"
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"City"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"Number 2"
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"County"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Geographical Code"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"State"
        }
    }
}

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