Jump to

• Request
• Response

Get Customer Contact Summary

get

/rest/apis/customer/interactions/customerContacts/{customerContactId}/summary

Request

Path Parameters

• customerContactId(required): string
  System-assigned, unique identifier of the customer contact record

  Example:

  5774836290

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

Type: object

Show Source

• _self: string
  _self
• account: object account
• businessObject: string
  Maximum Length: 30

  Business object code associated with the customer contact.

  Example: C1-CustomerContact
• businessObjectDescription: string
  Maximum Length: 60

  Description of the business object referenced in the customer contact.

  Example: Customer Contact Business Object
• characteristics: object characteristics
• contactDateTime: string (date-time)
  Contact Date/Time displays the date and time that the contact was saved into the system..

  Example: 2017-04-05T14:25:43-04:00
• contactDetail: object contactDetail
• customerContactEntity: string
  Allowed Values: [ "PER ", "PREM" ]

  Indicates if customer contact is related to the customer as person-based or to a service location as premise-based. * `PER ` - Person, * `PREM` - Premise

  Example: PER
• customerContactEntityDescription: string
  Maximum Length: 60

  Description of the entity associated with the customer contact (such as person, account, or premise).

  Example: Person
• customerContactId: string
  Maximum Length: 10

  System-assigned, unique identifier of the customer contact record

  Example: 5774836290
• customerContactSource: string
  Allowed Values: [ "C1ST" ]

  Source code identifying how the customer contact was initiated or reported. * `C1ST` - Service Guide Assistant

  Example: C1ST
• customerContactSourceDescription: string
  Maximum Length: 60

  Description of the source associated with the customer contact.

  Example: Call Center Service Guide Assistant
• customerContactStatus: string
  Allowed Values: [ "10 " ]

  Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log. * `10 ` - Open
• customerContactStatusDescription: string
  Maximum Length: 60

  The customer contact Status, when set to Open, designates that the event or issue associated to the contact has not been resolved.

  Example: Open
• customerContactType: object customerContactType
• letterPrintDateTime: string (date-time)
  The letter extract batch process will update the date and time that the letter was produced for sending.
• letterTemplate: object letterTemplate
  If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.
• longDescription: string
  Maximum Length: 4000

  Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes.
• person: object person
• preferredContactMethod: string
  Allowed Values: [ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]

  Preferred Contact Method indicates how the person prefers to be contacted. * `C1PC` - Person Contact, * `EM ` - Email, * `FAX ` - Fax, * `N/A ` - Not Applicable, * `PH ` - Phone, * `POST` - Postal, * `SMS ` - SMS

  Example: N/A
• preferredContactMethodDescription: string
  Maximum Length: 60

  If a follow-up with the customer is needed, the Preferred Contact Method indicates how the person prefers to be contacted.

  Example: Email
• premise: object premise
• shouldPrintLetter: boolean
  Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.

  Example: false
• summary: string
  Maximum Length: 4000

  Summary of the customer contact interaction if recorded by advanced call center intelligence features.

  Example: Customer John Smith called to dispute a recent bill, expressing concern that the total amount was unusually high. The agent, Emily, reviewed the bill with the customer and explained the charges, including a $99.13 consumption charge and a $20 late fee. Emily opened up a meter test investigation request. The customer was also advised on energy-saving tips.
• user: object user

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"System-assigned, unique identifier of the customer contact record",
            "example":"5774836290"
        },
        "businessObject":{
            "type":"string",
            "maxLength":30,
            "description":"Business object code associated with the customer contact.",
            "example":"C1-CustomerContact"
        },
        "businessObjectDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description of the business object referenced in the customer contact.",
            "example":"Customer Contact Business Object"
        },
        "contactDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Contact Date/Time displays the date and time that the contact was saved into the system..",
            "example":"2017-04-05T14:25:43-04:00"
        },
        "shouldPrintLetter":{
            "type":"boolean",
            "description":"Adding a customer contact may cause a letter to be generated. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added.  If the letter is going to be printed in the next batch run, the Print Letter switch is on. Turning the switch off removes the letter from being printed in the next batch run. This applies to letters that have never been printed and those that have been set to reprint.",
            "example":"false"
        },
        "letterPrintDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The letter extract batch process will update the date and time that the letter was produced for sending."
        },
        "letterTemplate":{
            "type":"object",
            "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.",
            "properties":{
                "letterTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."
                },
                "letterTemplateDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "customerContactType":{
            "type":"object",
            "properties":{
                "contactClass":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactClassDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "customerContactStatus":{
            "type":"string",
            "enum":[
                "10  "
            ],
            "description":"Open designates that the event or issue associated to the contact has not been resolved. For example, if a customer calls with a high bill complaint that can't be resolved immediately, you would turn on the Open switch and enter an appropriate entry in the Log.\n* `10  ` - Open"
        },
        "customerContactStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The customer contact Status, when set to Open, designates that the event or issue associated to the contact has not been resolved.",
            "example":"Open"
        },
        "preferredContactMethod":{
            "type":"string",
            "enum":[
                "C1PC",
                "EM  ",
                "FAX ",
                "N/A ",
                "PH  ",
                "POST",
                "SMS "
            ],
            "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
            "example":"N/A"
        },
        "preferredContactMethodDescription":{
            "type":"string",
            "maxLength":60,
            "description":"If a follow-up with the customer is needed, the Preferred Contact Method indicates how the person prefers to be contacted.",
            "example":"Email"
        },
        "contactDetail":{
            "type":"object",
            "properties":{
                "contactDetailId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User ID of the user who created the contact.",
                    "example":"SYSUSER"
                },
                "userName":{
                    "type":"string",
                    "maxLength":50,
                    "description":"User ID of the user who created the contact.",
                    "example":"SYSUSER"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.",
                    "example":"5775933103"
                },
                "entityName":{
                    "type":"string",
                    "maxLength":64,
                    "description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.",
                    "example":"5775933103"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Address of the premise associated with the customer contact.",
                    "example":"123 Main St, San Francisco, CA 94105"
                },
                "premiseAddress":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Address of the premise associated with the customer contact.",
                    "example":"123 Main St, San Francisco, CA 94105"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.",
                    "example":"5922116763"
                },
                "accountName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.",
                    "example":"5922116763"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "customerContactEntity":{
            "type":"string",
            "enum":[
                "PER ",
                "PREM"
            ],
            "description":"Indicates if customer contact is related to the customer as person-based or to a service location as premise-based.\n* `PER ` - Person,\n* `PREM` - Premise",
            "example":"PER"
        },
        "customerContactEntityDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description of the entity associated with the customer contact (such as person, account, or premise).",
            "example":"Person"
        },
        "longDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Stores comments that can provide initial information about why the record was created and any other relevant text for historical reference purposes."
        },
        "summary":{
            "type":"string",
            "maxLength":4000,
            "description":"Summary of the customer contact interaction if recorded by advanced call center intelligence features.",
            "example":"Customer John Smith called to dispute a recent bill, expressing concern that the total amount was unusually high. The agent, Emily, reviewed the bill with the customer and explained the charges, including a $99.13 consumption charge and a $20 late fee. Emily opened up a meter test investigation request. The customer was also advised on energy-saving tips."
        },
        "customerContactSource":{
            "type":"string",
            "enum":[
                "C1ST"
            ],
            "description":"Source code identifying how the customer contact was initiated or reported.\n* `C1ST` - Service Guide Assistant",
            "example":"C1ST"
        },
        "customerContactSourceDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description of the source associated with the customer contact.",
            "example":"Call Center Service Guide Assistant"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    },
                                    "characteristicTypeDescription":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Value associated with a characteristic or attribute of the customer contact.",
                                        "example":"Spanish"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Additional value or attribute associated with the customer contact."
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Additional value or attribute associated with the customer contact."
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Additional value or attribute associated with the customer contact."
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Additional value or attribute associated with the customer contact."
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CCSummary"
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated. There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.

  Example: 5922116763
• accountName: string
  Maximum Length: 254

  Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated. There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.

  Example: 5922116763

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.",
            "example":"5922116763"
        },
        "accountName":{
            "type":"string",
            "maxLength":254,
            "description":"Account ID displays the account's unique, system-generated ID. The account must be associated to the person when the contact is created or updated.  There should be no value if the Customer Contact Type indicates that an account is not allowed on customer contacts of this type.",
            "example":"5922116763"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "characteristicTypeDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Value associated with a characteristic or attribute of the customer contact.",
                                "example":"Spanish"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Additional value or attribute associated with the customer contact."
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Additional value or attribute associated with the customer contact."
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Additional value or attribute associated with the customer contact."
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Additional value or attribute associated with the customer contact."
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : contactDetail

Type: object

Show Source

• _link: string
  _link
• contactDetailId: string
  Maximum Length: 10

  Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method.

{
    "type":"object",
    "properties":{
        "contactDetailId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Detail ID is a system-assigned, unique identifier of the person contact associated with the customers preferred contact method."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : customerContactType

Type: object

Show Source

• _link: string
  _link
• contactClass: string
  Maximum Length: 4

  Contact Class categorizes customer contacts into larger groupings for reporting purposes.

  Example: CSS
• contactClassDescription: string
  Maximum Length: 60

  Contact Class categorizes customer contacts into larger groupings for reporting purposes.

  Example: CSS
• contactType: string
  Maximum Length: 12

  Contact Class categorizes customer contacts into larger groupings for reporting purposes.

  Example: CSS
• contactTypeDescription: string
  Maximum Length: 60

  Contact Class categorizes customer contacts into larger groupings for reporting purposes.

  Example: CSS

{
    "type":"object",
    "properties":{
        "contactClass":{
            "type":"string",
            "maxLength":4,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactClassDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactType":{
            "type":"string",
            "maxLength":12,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : letterTemplate

Type: object

If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.

Show Source

• _link: string
  _link
• letterTemplate: string
  Maximum Length: 12

  If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.
• letterTemplateDescription: string
  Maximum Length: 60

  If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.

{
    "type":"object",
    "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced.",
    "properties":{
        "letterTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."
        },
        "letterTemplateDescription":{
            "type":"string",
            "maxLength":60,
            "description":"If the customer contact references a customer contact type that, in turn, references a letter template, the template controls the type of information that is merged into the 'form letter' and how the letter is physically produced."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• _link: string
  _link
• entityName: string
  Maximum Length: 64

  Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.

  Example: 5775933103
• personId: string
  Maximum Length: 10

  Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.

  Example: 5775933103

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.",
            "example":"5775933103"
        },
        "entityName":{
            "type":"string",
            "maxLength":64,
            "description":"Person ID displays the associated person's unique, system-generated ID. If the customer contact is Person-based the Person ID cannot be changed. There should be no value if the Customer Contact Type indicates that a person is not allowed on customer contacts of this type.",
            "example":"5775933103"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseAddress: string
  Maximum Length: 254

  Address of the premise associated with the customer contact.

  Example: 123 Main St, San Francisco, CA 94105
• premiseId: string
  Maximum Length: 10

  Address of the premise associated with the customer contact.

  Example: 123 Main St, San Francisco, CA 94105

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Address of the premise associated with the customer contact.",
            "example":"123 Main St, San Francisco, CA 94105"
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Address of the premise associated with the customer contact.",
            "example":"123 Main St, San Francisco, CA 94105"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : user

Type: object

Show Source

• _link: string
  _link
• userId: string
  Maximum Length: 8

  User ID of the user who created the contact.

  Example: SYSUSER
• userName: string
  Maximum Length: 50

  User ID of the user who created the contact.

  Example: SYSUSER

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "maxLength":8,
            "description":"User ID of the user who created the contact.",
            "example":"SYSUSER"
        },
        "userName":{
            "type":"string",
            "maxLength":50,
            "description":"User ID of the user who created the contact.",
            "example":"SYSUSER"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "characteristicTypeDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Value associated with a characteristic or attribute of the customer contact.",
                        "example":"Spanish"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Additional value or attribute associated with the customer contact."
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Additional value or attribute associated with the customer contact."
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Additional value or attribute associated with the customer contact."
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Additional value or attribute associated with the customer contact."
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "characteristicTypeDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Value associated with a characteristic or attribute of the customer contact.",
                    "example":"Spanish"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Additional value or attribute associated with the customer contact."
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Additional value or attribute associated with the customer contact."
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Additional value or attribute associated with the customer contact."
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Additional value or attribute associated with the customer contact."
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type
• characteristicTypeDescription: string
  Maximum Length: 60

  Description

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "characteristicTypeDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  Maximum Length: 254

  Value associated with a characteristic or attribute of the customer contact.

  Example: Spanish
• value2: string
  Maximum Length: 50

  Additional value or attribute associated with the customer contact.
• value3: string
  Maximum Length: 50

  Additional value or attribute associated with the customer contact.
• value4: string
  Maximum Length: 50

  Additional value or attribute associated with the customer contact.
• value5: string
  Maximum Length: 50

  Additional value or attribute associated with the customer contact.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Value associated with a characteristic or attribute of the customer contact.",
            "example":"Spanish"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Additional value or attribute associated with the customer contact."
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Additional value or attribute associated with the customer contact."
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Additional value or attribute associated with the customer contact."
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Additional value or attribute associated with the customer contact."
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top