Jump to

• Request
• Response

Get Mailing Addresses

get

/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses

Request

Path Parameters

• accountId(required): string
  The Account ID is a system-assigned random number that stays with an account for life.

  Example:

  0833559999

• personId(required): string
  Person ID is a system-assigned random number that stays with a person for the life of the system.

  Example:

  3903069999

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1GetMailAdd

Type: object

Show Source

• accountAddress: object accountAddress
• addressSource: string
  Allowed Values: [ "ACOV", "PER ", "PREM" ]

  Bill Address Source: * `ACOV` - Account Override, * `PER ` - Person, * `PREM` - Mailing Premise on Account
• currentMailingAddress: object currentMailingAddress
• numberOfOtherAccounts: number
  Minimum Value: 0

  Maximum Value: 99999

  Number of Accounts Linked
• personAddress: object personAddress
• personSeasonalAddress: array personSeasonalAddress
• premiseAddress: object premiseAddress

{
    "type":"object",
    "properties":{
        "addressSource":{
            "type":"string",
            "enum":[
                "ACOV",
                "PER ",
                "PREM"
            ],
            "description":"Bill Address Source:\n* `ACOV` - Account Override,\n* `PER ` - Person,\n* `PREM` - Mailing Premise on  Account"
        },
        "premiseAddress":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country"
                },
                "addressLine1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "addressLine2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 2"
                },
                "addressLine3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 3"
                },
                "addressLine4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 4"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Number 2"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"City"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographical Code"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Postal"
                }
            }
        },
        "accountAddress":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country"
                },
                "addressLine1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "addressLine2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 2"
                },
                "addressLine3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 3"
                },
                "addressLine4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 4"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Number 2"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"City"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographical Code"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Postal"
                }
            }
        },
        "personAddress":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country"
                },
                "addressLine1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "addressLine2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 2"
                },
                "addressLine3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 3"
                },
                "addressLine4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 4"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Number 2"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"City"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographical Code"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Postal"
                }
            }
        },
        "personSeasonalAddress":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "address":{
                        "type":"object",
                        "properties":{
                            "country":{
                                "type":"string",
                                "maxLength":"3",
                                "description":"Country"
                            },
                            "addressLine1":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Address"
                            },
                            "addressLine2":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Address 2"
                            },
                            "addressLine3":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Address 3"
                            },
                            "addressLine4":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Address 4"
                            },
                            "houseType":{
                                "type":"string",
                                "enum":[
                                    "AB  ",
                                    "WW  "
                                ],
                                "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                            },
                            "number1":{
                                "type":"string",
                                "maxLength":"6",
                                "description":"Number 1"
                            },
                            "number2":{
                                "type":"string",
                                "maxLength":"4",
                                "description":"Number 2"
                            },
                            "inCityLimit":{
                                "type":"boolean",
                                "description":"In City Limit"
                            },
                            "city":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"City"
                            },
                            "geographic":{
                                "type":"string",
                                "maxLength":"11",
                                "description":"Geographical Code"
                            },
                            "county":{
                                "type":"string",
                                "maxLength":"90",
                                "description":"County"
                            },
                            "state":{
                                "type":"string",
                                "maxLength":"6",
                                "description":"State"
                            },
                            "postal":{
                                "type":"string",
                                "maxLength":"12",
                                "description":"Postal"
                            }
                        }
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                        "example":"10"
                    },
                    "seasonStartTime":{
                        "type":"string",
                        "maxLength":"4",
                        "description":"Season Start"
                    },
                    "seasonEndTime":{
                        "type":"string",
                        "maxLength":"4",
                        "description":"Season End"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "A   ",
                            "I   "
                        ],
                        "description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"
                    },
                    "inEffect":{
                        "type":"boolean",
                        "description":"In Effect"
                    }
                }
            }
        },
        "currentMailingAddress":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country"
                },
                "addressLine1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "addressLine2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 2"
                },
                "addressLine3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 3"
                },
                "addressLine4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 4"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Number 2"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"City"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographical Code"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Postal"
                }
            }
        },
        "numberOfOtherAccounts":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Number of Accounts Linked"
        }
    },
    "xml":{
        "name":"C1GetMailAdd"
    }
}

Nested Schema : accountAddress

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• 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"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"Postal"
        }
    }
}

Nested Schema : currentMailingAddress

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• 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"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"Postal"
        }
    }
}

Nested Schema : personAddress

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• 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"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"Postal"
        }
    }
}

Nested Schema : personSeasonalAddress

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "address":{
                "type":"object",
                "properties":{
                    "country":{
                        "type":"string",
                        "maxLength":"3",
                        "description":"Country"
                    },
                    "addressLine1":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Address"
                    },
                    "addressLine2":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Address 2"
                    },
                    "addressLine3":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Address 3"
                    },
                    "addressLine4":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Address 4"
                    },
                    "houseType":{
                        "type":"string",
                        "enum":[
                            "AB  ",
                            "WW  "
                        ],
                        "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                    },
                    "number1":{
                        "type":"string",
                        "maxLength":"6",
                        "description":"Number 1"
                    },
                    "number2":{
                        "type":"string",
                        "maxLength":"4",
                        "description":"Number 2"
                    },
                    "inCityLimit":{
                        "type":"boolean",
                        "description":"In City Limit"
                    },
                    "city":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"City"
                    },
                    "geographic":{
                        "type":"string",
                        "maxLength":"11",
                        "description":"Geographical Code"
                    },
                    "county":{
                        "type":"string",
                        "maxLength":"90",
                        "description":"County"
                    },
                    "state":{
                        "type":"string",
                        "maxLength":"6",
                        "description":"State"
                    },
                    "postal":{
                        "type":"string",
                        "maxLength":"12",
                        "description":"Postal"
                    }
                }
            },
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
                "example":"10"
            },
            "seasonStartTime":{
                "type":"string",
                "maxLength":"4",
                "description":"Season Start"
            },
            "seasonEndTime":{
                "type":"string",
                "maxLength":"4",
                "description":"Season End"
            },
            "status":{
                "type":"string",
                "enum":[
                    "A   ",
                    "I   "
                ],
                "description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"
            },
            "inEffect":{
                "type":"boolean",
                "description":"In Effect"
            }
        }
    }
}

Nested Schema : premiseAddress

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• 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"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"Postal"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: object address
• inEffect: boolean
  In Effect
• seasonEndTime: string
  Maximum Length: 4

  Season End
• seasonStartTime: string
  Maximum Length: 4

  Season Start
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence if the notification type is a subscription that allows for an option to be set.

  Example: 10
• status: string
  Allowed Values: [ "A ", "I " ]

  Status: * `A ` - Active, * `I ` - Inactive

{
    "type":"object",
    "properties":{
        "address":{
            "type":"object",
            "properties":{
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Country"
                },
                "addressLine1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address"
                },
                "addressLine2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 2"
                },
                "addressLine3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 3"
                },
                "addressLine4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Address 4"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                        "AB  ",
                        "WW  "
                    ],
                    "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Number 1"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Number 2"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"In City Limit"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"City"
                },
                "geographic":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"Geographical Code"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Postal"
                }
            }
        },
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence if the notification type is a subscription that allows for an option to be set.",
            "example":"10"
        },
        "seasonStartTime":{
            "type":"string",
            "maxLength":"4",
            "description":"Season Start"
        },
        "seasonEndTime":{
            "type":"string",
            "maxLength":"4",
            "description":"Season End"
        },
        "status":{
            "type":"string",
            "enum":[
                "A   ",
                "I   "
            ],
            "description":"Status:\n* `A   ` - Active,\n* `I   ` - Inactive"
        },
        "inEffect":{
            "type":"boolean",
            "description":"In Effect"
        }
    }
}

Nested Schema : address

Type: object

Show Source

• addressLine1: string
  Maximum Length: 254

  Address
• addressLine2: string
  Maximum Length: 254

  Address 2
• addressLine3: string
  Maximum Length: 254

  Address 3
• addressLine4: string
  Maximum Length: 254

  Address 4
• city: string
  Maximum Length: 90

  City
• country: string
  Maximum Length: 3

  Country
• county: string
  Maximum Length: 90

  County
• geographic: string
  Maximum Length: 11

  Geographical Code
• houseType: string
  Allowed Values: [ "AB ", "WW " ]

  House Type: * `AB ` - House Boat References, * `WW ` - House Trailer Reference
• inCityLimit: boolean
  In City Limit
• 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"
        },
        "addressLine1":{
            "type":"string",
            "maxLength":"254",
            "description":"Address"
        },
        "addressLine2":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 2"
        },
        "addressLine3":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 3"
        },
        "addressLine4":{
            "type":"string",
            "maxLength":"254",
            "description":"Address 4"
        },
        "houseType":{
            "type":"string",
            "enum":[
                "AB  ",
                "WW  "
            ],
            "description":"House Type:\n* `AB  ` - House Boat References,\n* `WW  ` - House Trailer Reference"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Number 1"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Number 2"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"In City Limit"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"City"
        },
        "geographic":{
            "type":"string",
            "maxLength":"11",
            "description":"Geographical Code"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"Postal"
        }
    }
}

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