Jump to

• Request
• Response

Retrieve Pending Tasks

post

/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

• account: object account
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The system-generated unique identifier of an account.",
                    "example":"1589809032"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Offset"
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The system-generated unique identifier of an account.

  Example: 1589809032

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The system-generated unique identifier of an account.",
            "example":"1589809032"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account: object account
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The system-generated unique identifier of an account.",
                    "example":"1589809032"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Offset"
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  The system-generated unique identifier of an account.

  Example: 1589809032

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The system-generated unique identifier of an account.",
            "example":"1589809032"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1PenAppList

Type: object

Show Source

• account: object account
• appointmentList: array appointmentList
• limit: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Limit
• offset: number
  Minimum Value: 0

  Maximum Value: 999999999.999999

  Page Offset
• totalNumberOfRecords: number
  Minimum Value: 0

  Maximum Value: 99999

  Total Number Of Records

{
    "type":"object",
    "properties":{
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The system-generated unique identifier of an account.",
                    "example":"1589809032"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page 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":"Unique identifier for a service task created for an appointment."
                    },
                    "fieldActivity":{
                        "type":"object",
                        "properties":{
                            "fieldActivityId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"The system-generated unique identifier for the field activity request.",
                                "example":"48269690619977"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "fieldTaskType":{
                        "type":"string",
                        "maxLength":254,
                        "description":"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"
                    },
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Indicates the service point where the activity takes place.",
                                "example":"214672087211"
                            },
                            "timeZone":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Indicates the service point where the activity takes place.",
                                "example":"214672087211"
                            },
                            "timeZoneName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Indicates the service point where the activity takes place.",
                                "example":"214672087211"
                            },
                            "timeZoneDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Indicates the service point where the activity takes place.",
                                "example":"214672087211"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "servicePointType":{
                        "type":"object",
                        "description":"Indicates the category of the device location where the service is delivered.",
                        "properties":{
                            "servicePointType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Indicates the category of the device location where the service is delivered.",
                                "example":"ZZ_ERT_ITM_SP_TYPE_01"
                            },
                            "servicePointTypeDescription":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Indicates the category of the device location where the service is delivered.",
                                "example":"ZZ_ERT_ITM_SP_TYPE_01"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "serviceType":{
                        "type":"object",
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":80,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "serviceTypeDescription":{
                                "type":"string",
                                "maxLength":100,
                                "description":"Service Type defines the type of service associated with the SA type.",
                                "example":"E"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "meter":{
                        "type":"object",
                        "properties":{
                            "meterId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The unique system identifier of additional equipment installed at the service point.",
                                "example":"BN20_YC_7529"
                            },
                            "badgeNumber":{
                                "type":"string",
                                "maxLength":120,
                                "description":"The unique system identifier of additional equipment installed at the service point.",
                                "example":"BN20_YC_7529"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "appointmentStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Field Activity's appointment start Date/Time.",
                        "example":"04-10-2021 08:00:00AM"
                    },
                    "appointmentEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Field Activity's appointment stop Date/Time.",
                        "example":"04-12-2021 08:00:00AM"
                    },
                    "serviceDate":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Field Activity's start Date/Time."
                    },
                    "isStartStopEvent":{
                        "type":"boolean",
                        "description":"Indicates if the appointment is a start or stop service event. A value of true indicates a start or stop service event.",
                        "example":"true"
                    },
                    "isAppointmentSet":{
                        "type":"boolean",
                        "description":"Flag to show if appointment has already been booked for field activities.",
                        "example":"true"
                    },
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"object",
                                "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.",
                                "properties":{
                                    "country":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country."
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The postal code of the address."
                            },
                            "address1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The first line of the address."
                            },
                            "address2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The second line of the address."
                            },
                            "address3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The third line of the address."
                            },
                            "address4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"The fourth line of the address."
                            },
                            "city":{
                                "type":"string",
                                "maxLength":90,
                                "description":"The city of the address.",
                                "example":"San Francisco"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":6,
                                "description":"The first street number line of the address."
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":4,
                                "description":"The second street number line of the address."
                            },
                            "county":{
                                "type":"string",
                                "maxLength":90,
                                "description":"The county of the address.",
                                "example":"San Francisco"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"Indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":11,
                                "description":"Defines the physical address location that is used to apply proper taxation rules."
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.",
                                "example":"true"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":6,
                                "description":"The state of the address.",
                                "example":"CA"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1PenAppList"
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  The system-generated unique identifier of an account.

  Example: 1589809032

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"The system-generated unique identifier of an account.",
            "example":"1589809032"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : appointmentList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "referenceId":{
                "type":"string",
                "maxLength":30,
                "description":"Unique identifier for a service task created for an appointment."
            },
            "fieldActivity":{
                "type":"object",
                "properties":{
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The system-generated unique identifier for the field activity request.",
                        "example":"48269690619977"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "fieldTaskType":{
                "type":"string",
                "maxLength":254,
                "description":"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"
            },
            "servicePoint":{
                "type":"object",
                "properties":{
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Indicates the service point where the activity takes place.",
                        "example":"214672087211"
                    },
                    "timeZone":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Indicates the service point where the activity takes place.",
                        "example":"214672087211"
                    },
                    "timeZoneName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Indicates the service point where the activity takes place.",
                        "example":"214672087211"
                    },
                    "timeZoneDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Indicates the service point where the activity takes place.",
                        "example":"214672087211"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "servicePointType":{
                "type":"object",
                "description":"Indicates the category of the device location where the service is delivered.",
                "properties":{
                    "servicePointType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Indicates the category of the device location where the service is delivered.",
                        "example":"ZZ_ERT_ITM_SP_TYPE_01"
                    },
                    "servicePointTypeDescription":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Indicates the category of the device location where the service is delivered.",
                        "example":"ZZ_ERT_ITM_SP_TYPE_01"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "serviceType":{
                "type":"object",
                "description":"Service Type defines the type of service associated with the SA type.",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":80,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "serviceTypeDescription":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Service Type defines the type of service associated with the SA type.",
                        "example":"E"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "meter":{
                "type":"object",
                "properties":{
                    "meterId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The unique system identifier of additional equipment installed at the service point.",
                        "example":"BN20_YC_7529"
                    },
                    "badgeNumber":{
                        "type":"string",
                        "maxLength":120,
                        "description":"The unique system identifier of additional equipment installed at the service point.",
                        "example":"BN20_YC_7529"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "appointmentStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Field Activity's appointment start Date/Time.",
                "example":"04-10-2021 08:00:00AM"
            },
            "appointmentEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Field Activity's appointment stop Date/Time.",
                "example":"04-12-2021 08:00:00AM"
            },
            "serviceDate":{
                "type":"string",
                "format":"date-time",
                "description":"Field Activity's start Date/Time."
            },
            "isStartStopEvent":{
                "type":"boolean",
                "description":"Indicates if the appointment is a start or stop service event. A value of true indicates a start or stop service event.",
                "example":"true"
            },
            "isAppointmentSet":{
                "type":"boolean",
                "description":"Flag to show if appointment has already been booked for field activities.",
                "example":"true"
            },
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"object",
                        "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":3,
                                "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country."
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The postal code of the address."
                    },
                    "address1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The first line of the address."
                    },
                    "address2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The second line of the address."
                    },
                    "address3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The third line of the address."
                    },
                    "address4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The fourth line of the address."
                    },
                    "city":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The city of the address.",
                        "example":"San Francisco"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":6,
                        "description":"The first street number line of the address."
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":4,
                        "description":"The second street number line of the address."
                    },
                    "county":{
                        "type":"string",
                        "maxLength":90,
                        "description":"The county of the address.",
                        "example":"San Francisco"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"Indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":11,
                        "description":"Defines the physical address location that is used to apply proper taxation rules."
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.",
                        "example":"true"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":6,
                        "description":"The state of the address.",
                        "example":"CA"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• appointmentEndDateTime: string (date-time)
  Field Activity's appointment stop Date/Time.

  Example: 04-12-2021 08:00:00AM
• appointmentStartDateTime: string (date-time)
  Field Activity's appointment start Date/Time.

  Example: 04-10-2021 08:00:00AM
• fieldActivity: object fieldActivity
• fieldTaskType: string
  Maximum Length: 254

  Defines details about the type of task to be performed and how the system will process the activity.

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

  Description for the Field Task Type.

  Example: Test Field Task Type - KK
• isAppointmentSet: boolean
  Flag to show if appointment has already been booked for field activities.

  Example: true
• isStartStopEvent: boolean
  Indicates if the appointment is a start or stop service event. A value of true indicates a start or stop service event.

  Example: true
• meter: object meter
• referenceId: string
  Maximum Length: 30

  Unique identifier for a service task created for an appointment.
• serviceDate: string (date-time)
  Field Activity's start Date/Time.
• servicePoint: object servicePoint
• servicePointType: object servicePointType
  Indicates the category of the device location where the service is delivered.
• serviceType: object serviceType
  Service Type defines the type of service associated with the SA type.

{
    "type":"object",
    "properties":{
        "referenceId":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier for a service task created for an appointment."
        },
        "fieldActivity":{
            "type":"object",
            "properties":{
                "fieldActivityId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The system-generated unique identifier for the field activity request.",
                    "example":"48269690619977"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "fieldTaskType":{
            "type":"string",
            "maxLength":254,
            "description":"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"
        },
        "servicePoint":{
            "type":"object",
            "properties":{
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Indicates the service point where the activity takes place.",
                    "example":"214672087211"
                },
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Indicates the service point where the activity takes place.",
                    "example":"214672087211"
                },
                "timeZoneName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Indicates the service point where the activity takes place.",
                    "example":"214672087211"
                },
                "timeZoneDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Indicates the service point where the activity takes place.",
                    "example":"214672087211"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "servicePointType":{
            "type":"object",
            "description":"Indicates the category of the device location where the service is delivered.",
            "properties":{
                "servicePointType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Indicates the category of the device location where the service is delivered.",
                    "example":"ZZ_ERT_ITM_SP_TYPE_01"
                },
                "servicePointTypeDescription":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Indicates the category of the device location where the service is delivered.",
                    "example":"ZZ_ERT_ITM_SP_TYPE_01"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "serviceType":{
            "type":"object",
            "description":"Service Type defines the type of service associated with the SA type.",
            "properties":{
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "serviceTypeDescription":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "meter":{
            "type":"object",
            "properties":{
                "meterId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The unique system identifier of additional equipment installed at the service point.",
                    "example":"BN20_YC_7529"
                },
                "badgeNumber":{
                    "type":"string",
                    "maxLength":120,
                    "description":"The unique system identifier of additional equipment installed at the service point.",
                    "example":"BN20_YC_7529"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "appointmentStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Field Activity's appointment start Date/Time.",
            "example":"04-10-2021 08:00:00AM"
        },
        "appointmentEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Field Activity's appointment stop Date/Time.",
            "example":"04-12-2021 08:00:00AM"
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Field Activity's start Date/Time."
        },
        "isStartStopEvent":{
            "type":"boolean",
            "description":"Indicates if the appointment is a start or stop service event. A value of true indicates a start or stop service event.",
            "example":"true"
        },
        "isAppointmentSet":{
            "type":"boolean",
            "description":"Flag to show if appointment has already been booked for field activities.",
            "example":"true"
        },
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"object",
                    "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.",
                    "properties":{
                        "country":{
                            "type":"string",
                            "maxLength":3,
                            "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country."
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "postal":{
                    "type":"string",
                    "maxLength":12,
                    "description":"The postal code of the address."
                },
                "address1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The first line of the address."
                },
                "address2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The second line of the address."
                },
                "address3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The third line of the address."
                },
                "address4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"The fourth line of the address."
                },
                "city":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The city of the address.",
                    "example":"San Francisco"
                },
                "number1":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The first street number line of the address."
                },
                "number2":{
                    "type":"string",
                    "maxLength":4,
                    "description":"The second street number line of the address."
                },
                "county":{
                    "type":"string",
                    "maxLength":90,
                    "description":"The county of the address.",
                    "example":"San Francisco"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"Indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":11,
                    "description":"Defines the physical address location that is used to apply proper taxation rules."
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.",
                    "example":"true"
                },
                "state":{
                    "type":"string",
                    "maxLength":6,
                    "description":"The state of the address.",
                    "example":"CA"
                }
            }
        }
    }
}

Nested Schema : address

Type: object

Show Source

• address1: string
  Maximum Length: 254

  The first line of the address.
• address2: string
  Maximum Length: 254

  The second line of the address.
• address3: string
  Maximum Length: 254

  The third line of the address.
• address4: string
  Maximum Length: 254

  The fourth line of the address.
• city: string
  Maximum Length: 90

  The city of the address.

  Example: San Francisco
• country: object country
  The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.
• county: string
  Maximum Length: 90

  The county of the address.

  Example: San Francisco
• geographic: string
  Maximum Length: 11

  Defines the physical address location that is used to apply proper taxation rules.
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  Indicates the type of house. * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.

  Example: true
• number1: string
  Maximum Length: 6

  The first street number line of the address.
• number2: string
  Maximum Length: 4

  The second street number line of the address.
• postal: string
  Maximum Length: 12

  The postal code of the address.
• state: string
  Maximum Length: 6

  The state of the address.

  Example: CA

{
    "type":"object",
    "properties":{
        "country":{
            "type":"object",
            "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":3,
                    "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "postal":{
            "type":"string",
            "maxLength":12,
            "description":"The postal code of the address."
        },
        "address1":{
            "type":"string",
            "maxLength":254,
            "description":"The first line of the address."
        },
        "address2":{
            "type":"string",
            "maxLength":254,
            "description":"The second line of the address."
        },
        "address3":{
            "type":"string",
            "maxLength":254,
            "description":"The third line of the address."
        },
        "address4":{
            "type":"string",
            "maxLength":254,
            "description":"The fourth line of the address."
        },
        "city":{
            "type":"string",
            "maxLength":90,
            "description":"The city of the address.",
            "example":"San Francisco"
        },
        "number1":{
            "type":"string",
            "maxLength":6,
            "description":"The first street number line of the address."
        },
        "number2":{
            "type":"string",
            "maxLength":4,
            "description":"The second street number line of the address."
        },
        "county":{
            "type":"string",
            "maxLength":90,
            "description":"The county of the address.",
            "example":"San Francisco"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"Indicates the type of house.\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "geographic":{
            "type":"string",
            "maxLength":11,
            "description":"Defines the physical address location that is used to apply proper taxation rules."
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"Indicates if the address is considered within the physical limits of a city. A value of true indicates within city limits.",
            "example":"true"
        },
        "state":{
            "type":"string",
            "maxLength":6,
            "description":"The state of the address.",
            "example":"CA"
        }
    }
}

Nested Schema : fieldActivity

Type: object

Show Source

• _link: string
  _link
• fieldActivityId: string
  Maximum Length: 10

  The system-generated unique identifier for the field activity request.

  Example: 48269690619977

{
    "type":"object",
    "properties":{
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"The system-generated unique identifier for the field activity request.",
            "example":"48269690619977"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : meter

Type: object

Show Source

• _link: string
  _link
• badgeNumber: string
  Maximum Length: 120

  The unique system identifier of additional equipment installed at the service point.

  Example: BN20_YC_7529
• meterId: string
  Maximum Length: 12

  The unique system identifier of additional equipment installed at the service point.

  Example: BN20_YC_7529

{
    "type":"object",
    "properties":{
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"The unique system identifier of additional equipment installed at the service point.",
            "example":"BN20_YC_7529"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The unique system identifier of additional equipment installed at the service point.",
            "example":"BN20_YC_7529"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Indicates the service point where the activity takes place.

  Example: 214672087211
• timeZone: string
  Maximum Length: 10

  Indicates the service point where the activity takes place.

  Example: 214672087211
• timeZoneDescription: string
  Maximum Length: 60

  Indicates the service point where the activity takes place.

  Example: 214672087211
• timeZoneName: string
  Maximum Length: 50

  Indicates the service point where the activity takes place.

  Example: 214672087211

{
    "type":"object",
    "properties":{
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Indicates the service point where the activity takes place.",
            "example":"214672087211"
        },
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Indicates the service point where the activity takes place.",
            "example":"214672087211"
        },
        "timeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"Indicates the service point where the activity takes place.",
            "example":"214672087211"
        },
        "timeZoneDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Indicates the service point where the activity takes place.",
            "example":"214672087211"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : servicePointType

Type: object

Indicates the category of the device location where the service is delivered.

Show Source

• _link: string
  _link
• servicePointType: string
  Maximum Length: 30

  Indicates the category of the device location where the service is delivered.

  Example: ZZ_ERT_ITM_SP_TYPE_01
• servicePointTypeDescription: string
  Maximum Length: 50

  Indicates the category of the device location where the service is delivered.

  Example: ZZ_ERT_ITM_SP_TYPE_01

{
    "type":"object",
    "description":"Indicates the category of the device location where the service is delivered.",
    "properties":{
        "servicePointType":{
            "type":"string",
            "maxLength":30,
            "description":"Indicates the category of the device location where the service is delivered.",
            "example":"ZZ_ERT_ITM_SP_TYPE_01"
        },
        "servicePointTypeDescription":{
            "type":"string",
            "maxLength":50,
            "description":"Indicates the category of the device location where the service is delivered.",
            "example":"ZZ_ERT_ITM_SP_TYPE_01"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : serviceType

Type: object

Service Type defines the type of service associated with the SA type.

Show Source

• _link: string
  _link
• serviceType: string
  Maximum Length: 80

  Service Type defines the type of service associated with the SA type.

  Example: E
• serviceTypeDescription: string
  Maximum Length: 100

  Service Type defines the type of service associated with the SA type.

  Example: E

{
    "type":"object",
    "description":"Service Type defines the type of service associated with the SA type.",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "serviceTypeDescription":{
            "type":"string",
            "maxLength":100,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : country

Type: object

The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.

Show Source

• _link: string
  _link
• country: string
  Maximum Length: 3

  The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.

{
    "type":"object",
    "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country.",
    "properties":{
        "country":{
            "type":"string",
            "maxLength":3,
            "description":"The country of the address. Defaults from the installation options. The applicable address constituents may differ depending on the Country."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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