Jump to

• Request
• Response

Create Customer Contact

post

https://server:port/spl/rest/apis/customer/interactions/customerContacts/

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• account: object account
• 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
• 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
• 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.
• logs: object logs
• 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
• 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
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "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."
                }
            }
        },
        "customerContactType":{
            "type":"object",
            "properties":{
                "contactClass":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
                    "example":"ACCESS"
                }
            }
        },
        "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"
        },
        "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"
        },
        "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."
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User ID of the user who created the contact.",
                    "example":"SYSUSER"
                }
            }
        },
        "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"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "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."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "logs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                            },
                            "toDoRole":{
                                "type":"object",
                                "properties":{
                                    "toDoRoleId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"To Do Role"
                                    }
                                }
                            },
                            "assignedToUser":{
                                "type":"object",
                                "properties":{
                                    "assignedToUserId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "user":{
                                "type":"object",
                                "properties":{
                                    "userId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "logEntry":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Log Entry can be used to describe the reason for the log entry."
                            },
                            "triggerBusinessProcess":{
                                "type":"boolean",
                                "description":"Trigger Business Process is a true or false value for reminders."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-CustCntct"
    }
}

Nested Schema : account

Type: object

Show Source

• 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

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

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"
                            }
                        }
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : contactDetail

Type: object

Show Source

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

Nested Schema : customerContactType

Type: object

Show Source

• contactClass: string
  Maximum Length: 4

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

  Example: CSS
• contactType: string
  Maximum Length: 12

  Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class. The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.

  Example: ACCESS

{
    "type":"object",
    "properties":{
        "contactClass":{
            "type":"string",
            "maxLength":4,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactType":{
            "type":"string",
            "maxLength":12,
            "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
            "example":"ACCESS"
        }
    }
}

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

• 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.

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

Nested Schema : logs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                    },
                    "toDoRole":{
                        "type":"object",
                        "properties":{
                            "toDoRoleId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"To Do Role"
                            }
                        }
                    },
                    "assignedToUser":{
                        "type":"object",
                        "properties":{
                            "assignedToUserId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "user":{
                        "type":"object",
                        "properties":{
                            "userId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "logEntry":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Log Entry can be used to describe the reason for the log entry."
                    },
                    "triggerBusinessProcess":{
                        "type":"boolean",
                        "description":"Trigger Business Process is a true or false value for reminders."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : person

Type: object

Show Source

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

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

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

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

Nested Schema : user

Type: object

Show Source

• userId: string
  Maximum Length: 8

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

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"
                    }
                }
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

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

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
            },
            "toDoRole":{
                "type":"object",
                "properties":{
                    "toDoRoleId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"To Do Role"
                    }
                }
            },
            "assignedToUser":{
                "type":"object",
                "properties":{
                    "assignedToUserId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "user":{
                "type":"object",
                "properties":{
                    "userId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "logEntry":{
                "type":"string",
                "maxLength":2000,
                "description":"Log Entry can be used to describe the reason for the log entry."
            },
            "triggerBusinessProcess":{
                "type":"boolean",
                "description":"Trigger Business Process is a true or false value for reminders."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assignedToUser: object assignedToUser
• logEntry: string
  Maximum Length: 2000

  Log Entry can be used to describe the reason for the log entry.
• toDoRole: object toDoRole
• triggerBusinessProcess: boolean
  Trigger Business Process is a true or false value for reminders.
• triggerDate: string (date)
  Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact. This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created.
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
        },
        "toDoRole":{
            "type":"object",
            "properties":{
                "toDoRoleId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"To Do Role"
                }
            }
        },
        "assignedToUser":{
            "type":"object",
            "properties":{
                "assignedToUserId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "logEntry":{
            "type":"string",
            "maxLength":2000,
            "description":"Log Entry can be used to describe the reason for the log entry."
        },
        "triggerBusinessProcess":{
            "type":"boolean",
            "description":"Trigger Business Process is a true or false value for reminders."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : assignedToUser

Type: object

Show Source

• assignedToUserId: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "assignedToUserId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

Nested Schema : toDoRole

Type: object

Show Source

• toDoRoleId: string
  Maximum Length: 10

  To Do Role

{
    "type":"object",
    "properties":{
        "toDoRoleId":{
            "type":"string",
            "maxLength":10,
            "description":"To Do Role"
        }
    }
}

Nested Schema : user

Type: object

Show Source

• userId: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account: object account
• 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
• 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
• 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.
• logs: object logs
• 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
• 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
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "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."
                }
            }
        },
        "customerContactType":{
            "type":"object",
            "properties":{
                "contactClass":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
                    "example":"ACCESS"
                }
            }
        },
        "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"
        },
        "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"
        },
        "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."
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User ID of the user who created the contact.",
                    "example":"SYSUSER"
                }
            }
        },
        "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"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."
                }
            }
        },
        "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"
                }
            }
        },
        "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"
        },
        "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."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "logs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                            },
                            "toDoRole":{
                                "type":"object",
                                "properties":{
                                    "toDoRoleId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"To Do Role"
                                    }
                                }
                            },
                            "assignedToUser":{
                                "type":"object",
                                "properties":{
                                    "assignedToUserId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "user":{
                                "type":"object",
                                "properties":{
                                    "userId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "logEntry":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Log Entry can be used to describe the reason for the log entry."
                            },
                            "triggerBusinessProcess":{
                                "type":"boolean",
                                "description":"Trigger Business Process is a true or false value for reminders."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-CustCntct"
    }
}

Nested Schema : account

Type: object

Show Source

• 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

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

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"
                            }
                        }
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : contactDetail

Type: object

Show Source

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

Nested Schema : customerContactType

Type: object

Show Source

• contactClass: string
  Maximum Length: 4

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

  Example: CSS
• contactType: string
  Maximum Length: 12

  Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class. The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.

  Example: ACCESS

{
    "type":"object",
    "properties":{
        "contactClass":{
            "type":"string",
            "maxLength":4,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactType":{
            "type":"string",
            "maxLength":12,
            "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
            "example":"ACCESS"
        }
    }
}

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

• 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.

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

Nested Schema : logs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                    },
                    "toDoRole":{
                        "type":"object",
                        "properties":{
                            "toDoRoleId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"To Do Role"
                            }
                        }
                    },
                    "assignedToUser":{
                        "type":"object",
                        "properties":{
                            "assignedToUserId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "user":{
                        "type":"object",
                        "properties":{
                            "userId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "logEntry":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Log Entry can be used to describe the reason for the log entry."
                    },
                    "triggerBusinessProcess":{
                        "type":"boolean",
                        "description":"Trigger Business Process is a true or false value for reminders."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : person

Type: object

Show Source

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

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

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

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

Nested Schema : user

Type: object

Show Source

• userId: string
  Maximum Length: 8

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

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"
                    }
                }
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

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

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
            },
            "toDoRole":{
                "type":"object",
                "properties":{
                    "toDoRoleId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"To Do Role"
                    }
                }
            },
            "assignedToUser":{
                "type":"object",
                "properties":{
                    "assignedToUserId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "user":{
                "type":"object",
                "properties":{
                    "userId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "logEntry":{
                "type":"string",
                "maxLength":2000,
                "description":"Log Entry can be used to describe the reason for the log entry."
            },
            "triggerBusinessProcess":{
                "type":"boolean",
                "description":"Trigger Business Process is a true or false value for reminders."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assignedToUser: object assignedToUser
• logEntry: string
  Maximum Length: 2000

  Log Entry can be used to describe the reason for the log entry.
• toDoRole: object toDoRole
• triggerBusinessProcess: boolean
  Trigger Business Process is a true or false value for reminders.
• triggerDate: string (date)
  Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact. This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created.
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
        },
        "toDoRole":{
            "type":"object",
            "properties":{
                "toDoRoleId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"To Do Role"
                }
            }
        },
        "assignedToUser":{
            "type":"object",
            "properties":{
                "assignedToUserId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "logEntry":{
            "type":"string",
            "maxLength":2000,
            "description":"Log Entry can be used to describe the reason for the log entry."
        },
        "triggerBusinessProcess":{
            "type":"boolean",
            "description":"Trigger Business Process is a true or false value for reminders."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : assignedToUser

Type: object

Show Source

• assignedToUserId: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "assignedToUserId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

Nested Schema : toDoRole

Type: object

Show Source

• toDoRoleId: string
  Maximum Length: 10

  To Do Role

{
    "type":"object",
    "properties":{
        "toDoRoleId":{
            "type":"string",
            "maxLength":10,
            "description":"To Do Role"
        }
    }
}

Nested Schema : user

Type: object

Show Source

• userId: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-CustCntct

Type: object

Show Source

• _self: string
  _self
• account: object account
• 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
• customerContactId: string
  Maximum Length: 10

  System-assigned, unique identifier of the customer contact record

  Example: 5774836290
• 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
• 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.
• logs: object logs
• 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
• 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
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "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"
        },
        "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":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "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."
                }
            }
        },
        "customerContactType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "contactClass":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
                    "example":"CSS"
                },
                "contactType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
                    "example":"ACCESS"
                }
            }
        },
        "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"
        },
        "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"
        },
        "contactDetail":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "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."
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User ID of the user who created the contact.",
                    "example":"SYSUSER"
                }
            }
        },
        "person":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "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"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID field displays the associated premise's unique, system-generated ID. If the customer contact is Premise-based the Premise ID cannot be changed.  There should be no value if the Customer Contact Type indicates that a premise is not allowed on customer contacts of this type."
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "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"
                }
            }
        },
        "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"
        },
        "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."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Char Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        },
        "logs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "customerContactLogId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Customer Contact Log ID"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                            },
                            "toDoRole":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "toDoRoleId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"To Do Role"
                                    }
                                }
                            },
                            "assignedToUser":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "assignedToUserId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "user":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "userId":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"User"
                                    }
                                }
                            },
                            "creationDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Create Date/Time"
                            },
                            "logEntry":{
                                "type":"string",
                                "maxLength":2000,
                                "description":"Log Entry can be used to describe the reason for the log entry."
                            },
                            "triggerBusinessProcess":{
                                "type":"boolean",
                                "description":"Trigger Business Process is a true or false value for reminders."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-CustCntct"
    }
}

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

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "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"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Char Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

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":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "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."
        }
    }
}

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
• contactType: string
  Maximum Length: 12

  Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class. The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.

  Example: ACCESS

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "contactClass":{
            "type":"string",
            "maxLength":4,
            "description":"Contact Class categorizes customer contacts into larger groupings for reporting purposes.",
            "example":"CSS"
        },
        "contactType":{
            "type":"string",
            "maxLength":12,
            "description":"Every customer contact has a Contact Type that classifies the record for reporting purposes. Every contact type, in turn, references a Contact Class.  The customer contact type controls the relationship validation among person, account, and premise. You can set up a customer contact type to generate a form letter whenever a customer contact of this type is added. In fact, this is the only way to generate a letter in the system.",
            "example":"ACCESS"
        }
    }
}

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.

{
    "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":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "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."
        }
    }
}

Nested Schema : logs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "customerContactLogId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Customer Contact Log ID"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
                    },
                    "toDoRole":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "toDoRoleId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"To Do Role"
                            }
                        }
                    },
                    "assignedToUser":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "assignedToUserId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "user":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "userId":{
                                "type":"string",
                                "maxLength":8,
                                "description":"User"
                            }
                        }
                    },
                    "creationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Create Date/Time"
                    },
                    "logEntry":{
                        "type":"string",
                        "maxLength":2000,
                        "description":"Log Entry can be used to describe the reason for the log entry."
                    },
                    "triggerBusinessProcess":{
                        "type":"boolean",
                        "description":"Trigger Business Process is a true or false value for reminders."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : person

Type: object

Show Source

• _link: string
  _link
• 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":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "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"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• _link: string
  _link
• premiseId: string
  Maximum Length: 10

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

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

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

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

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Char Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Char Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Char Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

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

  Characteristic Type

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

Nested Schema : characteristicValue

Type: object

Show Source

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

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "customerContactLogId":{
                "type":"string",
                "maxLength":12,
                "description":"Customer Contact Log ID"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
            },
            "toDoRole":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "toDoRoleId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"To Do Role"
                    }
                }
            },
            "assignedToUser":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "assignedToUserId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "user":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "userId":{
                        "type":"string",
                        "maxLength":8,
                        "description":"User"
                    }
                }
            },
            "creationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Create Date/Time"
            },
            "logEntry":{
                "type":"string",
                "maxLength":2000,
                "description":"Log Entry can be used to describe the reason for the log entry."
            },
            "triggerBusinessProcess":{
                "type":"boolean",
                "description":"Trigger Business Process is a true or false value for reminders."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assignedToUser: object assignedToUser
• creationDateTime: string (date-time)
  Create Date/Time
• customerContactLogId: string
  Maximum Length: 12

  Customer Contact Log ID
• logEntry: string
  Maximum Length: 2000

  Log Entry can be used to describe the reason for the log entry.
• toDoRole: object toDoRole
• triggerBusinessProcess: boolean
  Trigger Business Process is a true or false value for reminders.
• triggerDate: string (date)
  Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact. This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created.
• user: object user
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "customerContactLogId":{
            "type":"string",
            "maxLength":12,
            "description":"Customer Contact Log ID"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"Trigger Date is only used if you want the system to remind a user about this customer contact on a future date. The system will create a To Do entry to remind the user about the customer contact.   This value defines the latest date on which the To Do entry should be created because the background process that's responsible for creating these To Do entries has a parameter called Lead Time that is used to define the number of days before the Trigger Date that the To Do entry should be created."
        },
        "toDoRole":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "toDoRoleId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"To Do Role"
                }
            }
        },
        "assignedToUser":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "assignedToUserId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "user":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "logEntry":{
            "type":"string",
            "maxLength":2000,
            "description":"Log Entry can be used to describe the reason for the log entry."
        },
        "triggerBusinessProcess":{
            "type":"boolean",
            "description":"Trigger Business Process is a true or false value for reminders."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : assignedToUser

Type: object

Show Source

• _link: string
  _link
• assignedToUserId: string
  Maximum Length: 8

  User

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "assignedToUserId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

Nested Schema : toDoRole

Type: object

Show Source

• _link: string
  _link
• toDoRoleId: string
  Maximum Length: 10

  To Do Role

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "toDoRoleId":{
            "type":"string",
            "maxLength":10,
            "description":"To Do Role"
        }
    }
}

Nested Schema : user

Type: object

Show Source

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

  User

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "userId":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        }
    }
}

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