Oracle Utilities REST API for Metering and Customer Information

Retrieve Service-Related Customer Details

post

https://server:port/spl/rest/apis/customer/service/startStopTransferTasks/serviceRelatedCustomerDetails

This operation is used to retrieve the service-related information for the input account and/or person.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

accountId: string

Maximum Length: 10

Account ID
customerServiceRequestType: string

Maximum Length: 30

Customer Service Request Type controls how a specific customer service request is processed.

Example: DSS-NEW-SERVICE
personId: string

Maximum Length: 10

Person ID
personOrBusiness: string

Allowed Values: [ "B ", "P " ]

Person/Business: * `B ` - Business, * `P ` - Person

{
    "type":"object",
    "properties":{
        "customerServiceRequestType":{
            "type":"string",
            "maxLength":30,
            "description":"Customer Service Request Type controls how a specific customer service request is processed.",
            "example":"DSS-NEW-SERVICE"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Person/Business:\n* `B   ` - Business,\n* `P   ` - Person"
        }
    },
    "xml":{
        "name":"C1SSCustRead"
    }
}

Root Schema : schema

Type: object

Show Source

accountId: string

Maximum Length: 10

Account ID
customerServiceRequestType: string

Maximum Length: 30

Customer Service Request Type controls how a specific customer service request is processed.

Example: DSS-NEW-SERVICE
personId: string

Maximum Length: 10

Person ID
personOrBusiness: string

Allowed Values: [ "B ", "P " ]

Person/Business: * `B ` - Business, * `P ` - Person

{
    "type":"object",
    "properties":{
        "customerServiceRequestType":{
            "type":"string",
            "maxLength":30,
            "description":"Customer Service Request Type controls how a specific customer service request is processed.",
            "example":"DSS-NEW-SERVICE"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Person/Business:\n* `B   ` - Business,\n* `P   ` - Person"
        }
    },
    "xml":{
        "name":"C1SSCustRead"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1SSCustRead

Type: object

Show Source

emailContacts: object emailContacts
entityName: string

Maximum Length: 254

Name
faxContacts: object faxContacts
firstName: string

Maximum Length: 50

First Name
lastName: string

Maximum Length: 50

Last Name
mailingAddress: object mailingAddress
otherContacts: object otherContacts
otherPendStopExists: boolean

Another Pending Task Exists switch indicates whether or not a non-final self-service task with phone and email information exists for an account.

Example: true
personIdentifiers: object personIdentifiers
phoneContacts: object phoneContacts
phoneNumbers: object phoneNumbers
shouldPromptForId: boolean

Should Prompt For ID switch indicates whether or not the customer will be prompted for an Identification Number.

Example: true

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "maxLength":50,
            "description":"First Name"
        },
        "lastName":{
            "type":"string",
            "maxLength":50,
            "description":"Last Name"
        },
        "entityName":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "mailingAddress":{
            "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"
                }
            }
        },
        "phoneNumbers":{
            "type":"object",
            "properties":{
                "phoneNumber":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "phoneType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Phone Type"
                            },
                            "phoneTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "phone":{
                                "type":"string",
                                "maxLength":24,
                                "description":"Phone Number"
                            }
                        }
                    }
                }
            }
        },
        "phoneContacts":{
            "type":"object",
            "properties":{
                "phoneContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, mark.brazil@email.com"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactPrimary":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "contactActiveInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            }
                        }
                    }
                }
            }
        },
        "faxContacts":{
            "type":"object",
            "properties":{
                "faxContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, mark.brazil@email.com"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactPrimary":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "contactActiveInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            }
                        }
                    }
                }
            }
        },
        "emailContacts":{
            "type":"object",
            "properties":{
                "emailContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, mark.brazil@email.com"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactPrimary":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "contactActiveInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            }
                        }
                    }
                }
            }
        },
        "otherContacts":{
            "type":"object",
            "properties":{
                "otherContact":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "contactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                                "example":"4050952629"
                            },
                            "contactValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                                "example":"415-123-4567, mark.brazil@email.com"
                            },
                            "contactType":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                                "example":"HOMEPHONE, WORKEMAIL"
                            },
                            "contactPrimary":{
                                "type":"string",
                                "enum":[
                                    "C1NO",
                                    "C1YS"
                                ],
                                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                            },
                            "contactActiveInactive":{
                                "type":"string",
                                "enum":[
                                    "C1AC",
                                    "C1IN"
                                ],
                                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                            }
                        }
                    }
                }
            }
        },
        "shouldPromptForId":{
            "type":"boolean",
            "description":"Should Prompt For ID switch indicates whether or not the customer will be prompted for an Identification Number.",
            "example":"true"
        },
        "personIdentifiers":{
            "type":"object",
            "properties":{
                "personIdentifier":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "idType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"ID Type defines the type of identification.",
                                "example":"SSN"
                            }
                        }
                    }
                }
            }
        },
        "otherPendStopExists":{
            "type":"boolean",
            "description":"Another Pending Task Exists switch indicates whether or not a non-final self-service task with phone and email information exists for an account.",
            "example":"true"
        }
    },
    "xml":{
        "name":"C1SSCustRead"
    }
}

Nested Schema : emailContacts

Type: object

Show Source

emailContact: array emailContact

{
    "type":"object",
    "properties":{
        "emailContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, mark.brazil@email.com"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactPrimary":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "contactActiveInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    }
                }
            }
        }
    }
}

Nested Schema : faxContacts

Type: object

Show Source

faxContact: array faxContact

{
    "type":"object",
    "properties":{
        "faxContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, mark.brazil@email.com"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactPrimary":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "contactActiveInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    }
                }
            }
        }
    }
}

Nested Schema : mailingAddress

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 : otherContacts

Type: object

Show Source

otherContact: array otherContact

{
    "type":"object",
    "properties":{
        "otherContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, mark.brazil@email.com"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactPrimary":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "contactActiveInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    }
                }
            }
        }
    }
}

Nested Schema : personIdentifiers

Type: object

Show Source

personIdentifier: array personIdentifier

{
    "type":"object",
    "properties":{
        "personIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "idType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"ID Type defines the type of identification.",
                        "example":"SSN"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneContacts

Type: object

Show Source

phoneContact: array phoneContact

{
    "type":"object",
    "properties":{
        "phoneContact":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "contactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                        "example":"4050952629"
                    },
                    "contactValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                        "example":"415-123-4567, mark.brazil@email.com"
                    },
                    "contactType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                        "example":"HOMEPHONE, WORKEMAIL"
                    },
                    "contactPrimary":{
                        "type":"string",
                        "enum":[
                            "C1NO",
                            "C1YS"
                        ],
                        "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
                    },
                    "contactActiveInactive":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1IN"
                        ],
                        "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
                    }
                }
            }
        }
    }
}

Nested Schema : phoneNumbers

Type: object

Show Source

phoneNumber: array phoneNumber

{
    "type":"object",
    "properties":{
        "phoneNumber":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "phoneType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Phone Type"
                    },
                    "phoneTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "phone":{
                        "type":"string",
                        "maxLength":24,
                        "description":"Phone Number"
                    }
                }
            }
        }
    }
}

Nested Schema : emailContact

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, mark.brazil@email.com"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactPrimary":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "contactActiveInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactActiveInactive: string

Allowed Values: [ "C1AC", "C1IN" ]

Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive
contactId: string

Maximum Length: 10

Contact Detail ID is a system-assigned unique identifier of the person contact.

Example: 4050952629
contactPrimary: string

Allowed Values: [ "C1NO", "C1YS" ]

Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
contactType: string

Maximum Length: 30

Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.

Example: HOMEPHONE, WORKEMAIL
contactValue: string

Maximum Length: 254

Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.

Example: 415-123-4567, mark.brazil@email.com

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, mark.brazil@email.com"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactPrimary":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "contactActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        }
    }
}

Nested Schema : faxContact

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, mark.brazil@email.com"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactPrimary":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "contactActiveInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactActiveInactive: string

Allowed Values: [ "C1AC", "C1IN" ]

Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive
contactId: string

Maximum Length: 10

Contact Detail ID is a system-assigned unique identifier of the person contact.

Example: 4050952629
contactPrimary: string

Allowed Values: [ "C1NO", "C1YS" ]

Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
contactType: string

Maximum Length: 30

Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.

Example: HOMEPHONE, WORKEMAIL
contactValue: string

Maximum Length: 254

Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.

Example: 415-123-4567, mark.brazil@email.com

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, mark.brazil@email.com"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactPrimary":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "contactActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        }
    }
}

Nested Schema : otherContact

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, mark.brazil@email.com"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactPrimary":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "contactActiveInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactActiveInactive: string

Allowed Values: [ "C1AC", "C1IN" ]

Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive
contactId: string

Maximum Length: 10

Contact Detail ID is a system-assigned unique identifier of the person contact.

Example: 4050952629
contactPrimary: string

Allowed Values: [ "C1NO", "C1YS" ]

Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
contactType: string

Maximum Length: 30

Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.

Example: HOMEPHONE, WORKEMAIL
contactValue: string

Maximum Length: 254

Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.

Example: 415-123-4567, mark.brazil@email.com

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, mark.brazil@email.com"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactPrimary":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "contactActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        }
    }
}

Nested Schema : personIdentifier

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "idType":{
                "type":"string",
                "maxLength":8,
                "description":"ID Type defines the type of identification.",
                "example":"SSN"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

idType: string

Maximum Length: 8

ID Type defines the type of identification.

Example: SSN

{
    "type":"object",
    "properties":{
        "idType":{
            "type":"string",
            "maxLength":8,
            "description":"ID Type defines the type of identification.",
            "example":"SSN"
        }
    }
}

Nested Schema : phoneContact

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "contactId":{
                "type":"string",
                "maxLength":10,
                "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
                "example":"4050952629"
            },
            "contactValue":{
                "type":"string",
                "maxLength":254,
                "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
                "example":"415-123-4567, mark.brazil@email.com"
            },
            "contactType":{
                "type":"string",
                "maxLength":30,
                "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
                "example":"HOMEPHONE, WORKEMAIL"
            },
            "contactPrimary":{
                "type":"string",
                "enum":[
                    "C1NO",
                    "C1YS"
                ],
                "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
            },
            "contactActiveInactive":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1IN"
                ],
                "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

contactActiveInactive: string

Allowed Values: [ "C1AC", "C1IN" ]

Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive. * `C1AC` - Active, * `C1IN` - Inactive
contactId: string

Maximum Length: 10

Contact Detail ID is a system-assigned unique identifier of the person contact.

Example: 4050952629
contactPrimary: string

Allowed Values: [ "C1NO", "C1YS" ]

Primary switch must be set for exactly one person contact for each contact routing. * `C1NO` - No, * `C1YS` - Yes
contactType: string

Maximum Length: 30

Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.

Example: HOMEPHONE, WORKEMAIL
contactValue: string

Maximum Length: 254

Contact Detail Value contains the specific contact information such as the phone number or email address in the associated format.

Example: 415-123-4567, mark.brazil@email.com

{
    "type":"object",
    "properties":{
        "contactId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned unique identifier of the person contact.",
            "example":"4050952629"
        },
        "contactValue":{
            "type":"string",
            "maxLength":254,
            "description":"Contact Detail Value contains the specific contact information such as  the phone number or email address in the associated format.",
            "example":"415-123-4567, mark.brazil@email.com"
        },
        "contactType":{
            "type":"string",
            "maxLength":30,
            "description":"Person Contact Type indicates the type of contact such as, home phone, cell phone, or work email.",
            "example":"HOMEPHONE, WORKEMAIL"
        },
        "contactPrimary":{
            "type":"string",
            "enum":[
                "C1NO",
                "C1YS"
            ],
            "description":"Primary switch must be set for exactly one person contact for each contact routing.\n* `C1NO` - No,\n* `C1YS` - Yes"
        },
        "contactActiveInactive":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1IN"
            ],
            "description":"Most contact preferences will remain active. When a contact is no longer valid, the existing contact should be updated to Inactive.\n* `C1AC` - Active,\n* `C1IN` - Inactive"
        }
    }
}

Nested Schema : phoneNumber

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "phoneType":{
                "type":"string",
                "maxLength":12,
                "description":"Phone Type"
            },
            "phoneTypeDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "phone":{
                "type":"string",
                "maxLength":24,
                "description":"Phone Number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

phone: string

Maximum Length: 24

Phone Number
phoneType: string

Maximum Length: 12

Phone Type
phoneTypeDescription: string

Maximum Length: 60

Description
sequence: number

Minimum Value: -999

Maximum Value: 999

Sequence

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "phoneType":{
            "type":"string",
            "maxLength":12,
            "description":"Phone Type"
        },
        "phoneTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "phone":{
            "type":"string",
            "maxLength":24,
            "description":"Phone Number"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}