Jump to

• Request
• Response

Create Update Customer Contact

put

/rest/apis/customer/v-model/customerContact/{externalCCId}

Request

Path Parameters

• externalCCId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is the account used on the customer contact.

  Example: 1589809012
• ccId: string
  Maximum Length: 10

  Customer Contact ID
• contactId: string
  Maximum Length: 10

  Person Contact
• customerContactIdentifier: array customerContactIdentifier
• deliveryChannel: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  Delivery Type: * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS
• deliveryValue: string
  Maximum Length: 254

  Contact Information
• emailSubject: string
  Maximum Length: 256

  Subject
• eventCapturedDateTime: string (date-time)
  Event Date/Time
• externalCCId: string
  Maximum Length: 120

  Customer Contact External Reference
• notificationInstanceId: string
  Maximum Length: 32

  Notification Instance
• notificationPreferenceId: string
  Maximum Length: 14

  Communication Preference
• notificationType: string
  Maximum Length: 30

  Notification Type
• origin: string
  Allowed Values: [ "C1CB", "NMS " ]

  A list of valid systems that can originate a notification. * `C1CB` - Customer Care and Billing, * `NMS ` - Network Management System

  Example: CCB
• personId: string
  Maximum Length: 10

  Person ID is the person used on the customer contact.

  Example: 0023939882
• reason: string
  Maximum Length: 500

  Status Reason
• status: string
  Allowed Values: [ "C1AP", "C1BN", "C1CK", "C1DV", "C1ES", "C1FL", "C1NS", "C1OP", "C1PN", "C1SK", "C1ST" ]

  Integration Status: * `C1AP` - Auto Opened, * `C1BN` - Bounced, * `C1CK` - Clicked, * `C1DV` - Delivered, * `C1ES` - Error Sending, * `C1FL` - Failed, * `C1NS` - Not Sent, * `C1OP` - Opened, * `C1PN` - Pending, * `C1SK` - Skipped, * `C1ST` - Sent
• templateData: object templateData

{
    "type":"object",
    "properties":{
        "externalCCId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "notificationInstanceId":{
            "type":"string",
            "maxLength":"32",
            "description":"Notification Instance"
        },
        "ccId":{
            "type":"string",
            "maxLength":"10",
            "description":"Customer Contact ID"
        },
        "origin":{
            "type":"string",
            "enum":[
                "C1CB",
                "NMS "
            ],
            "description":"A list of valid systems that can originate a notification.\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System",
            "example":"CCB"
        },
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID is the account used on the customer contact.",
            "example":"1589809012"
        },
        "contactId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person Contact"
        },
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the person used on the customer contact.",
            "example":"0023939882"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":"14",
            "description":"Communication Preference"
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery Type:\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS"
        },
        "deliveryValue":{
            "type":"string",
            "maxLength":"254",
            "description":"Contact Information"
        },
        "notificationType":{
            "type":"string",
            "maxLength":"30",
            "description":"Notification Type"
        },
        "status":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1BN",
                "C1CK",
                "C1DV",
                "C1ES",
                "C1FL",
                "C1NS",
                "C1OP",
                "C1PN",
                "C1SK",
                "C1ST"
            ],
            "description":"Integration Status:\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent"
        },
        "reason":{
            "type":"string",
            "maxLength":"500",
            "description":"Status Reason"
        },
        "emailSubject":{
            "type":"string",
            "maxLength":"256",
            "description":"Subject"
        },
        "eventCapturedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event Date/Time"
        },
        "customerContactIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalRefId":{
                        "type":"string",
                        "maxLength":"120",
                        "description":"Customer Contact External Reference"
                    },
                    "identifierType":{
                        "type":"string",
                        "enum":[
                            "C1EX",
                            "C1NS",
                            "C1OS"
                        ],
                        "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
                    }
                }
            }
        },
        "templateData":{
            "type":"object",
            "properties":{
                "templateParm":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Key"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CreUpdCC"
    }
}

Nested Schema : customerContactIdentifier

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalRefId":{
                "type":"string",
                "maxLength":"120",
                "description":"Customer Contact External Reference"
            },
            "identifierType":{
                "type":"string",
                "enum":[
                    "C1EX",
                    "C1NS",
                    "C1OS"
                ],
                "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
            }
        }
    }
}

Nested Schema : templateData

Type: object

Show Source

• templateParm: array templateParm

{
    "type":"object",
    "properties":{
        "templateParm":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Key"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalRefId: string
  Maximum Length: 120

  Customer Contact External Reference
• identifierType: string
  Allowed Values: [ "C1EX", "C1NS", "C1OS" ]

  Identifier Type: * `C1EX` - External Identifier, * `C1NS` - Notification System Identifier, * `C1OS` - Originating System Identifier

{
    "type":"object",
    "properties":{
        "externalRefId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "identifierType":{
            "type":"string",
            "enum":[
                "C1EX",
                "C1NS",
                "C1OS"
            ],
            "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
        }
    }
}

Nested Schema : templateParm

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Key"
            },
            "value":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key: string
  Maximum Length: 254

  Template Parameter Key
• value: string
  Maximum Length: 254

  Template Parameter Value

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Key"
        },
        "value":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is the account used on the customer contact.

  Example: 1589809012
• ccId: string
  Maximum Length: 10

  Customer Contact ID
• contactId: string
  Maximum Length: 10

  Person Contact
• customerContactIdentifier: array customerContactIdentifier
• deliveryChannel: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  Delivery Type: * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS
• deliveryValue: string
  Maximum Length: 254

  Contact Information
• emailSubject: string
  Maximum Length: 256

  Subject
• eventCapturedDateTime: string (date-time)
  Event Date/Time
• externalCCId: string
  Maximum Length: 120

  Customer Contact External Reference
• notificationInstanceId: string
  Maximum Length: 32

  Notification Instance
• notificationPreferenceId: string
  Maximum Length: 14

  Communication Preference
• notificationType: string
  Maximum Length: 30

  Notification Type
• origin: string
  Allowed Values: [ "C1CB", "NMS " ]

  A list of valid systems that can originate a notification. * `C1CB` - Customer Care and Billing, * `NMS ` - Network Management System

  Example: CCB
• personId: string
  Maximum Length: 10

  Person ID is the person used on the customer contact.

  Example: 0023939882
• reason: string
  Maximum Length: 500

  Status Reason
• status: string
  Allowed Values: [ "C1AP", "C1BN", "C1CK", "C1DV", "C1ES", "C1FL", "C1NS", "C1OP", "C1PN", "C1SK", "C1ST" ]

  Integration Status: * `C1AP` - Auto Opened, * `C1BN` - Bounced, * `C1CK` - Clicked, * `C1DV` - Delivered, * `C1ES` - Error Sending, * `C1FL` - Failed, * `C1NS` - Not Sent, * `C1OP` - Opened, * `C1PN` - Pending, * `C1SK` - Skipped, * `C1ST` - Sent
• templateData: object templateData

{
    "type":"object",
    "properties":{
        "externalCCId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "notificationInstanceId":{
            "type":"string",
            "maxLength":"32",
            "description":"Notification Instance"
        },
        "ccId":{
            "type":"string",
            "maxLength":"10",
            "description":"Customer Contact ID"
        },
        "origin":{
            "type":"string",
            "enum":[
                "C1CB",
                "NMS "
            ],
            "description":"A list of valid systems that can originate a notification.\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System",
            "example":"CCB"
        },
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID is the account used on the customer contact.",
            "example":"1589809012"
        },
        "contactId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person Contact"
        },
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the person used on the customer contact.",
            "example":"0023939882"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":"14",
            "description":"Communication Preference"
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery Type:\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS"
        },
        "deliveryValue":{
            "type":"string",
            "maxLength":"254",
            "description":"Contact Information"
        },
        "notificationType":{
            "type":"string",
            "maxLength":"30",
            "description":"Notification Type"
        },
        "status":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1BN",
                "C1CK",
                "C1DV",
                "C1ES",
                "C1FL",
                "C1NS",
                "C1OP",
                "C1PN",
                "C1SK",
                "C1ST"
            ],
            "description":"Integration Status:\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent"
        },
        "reason":{
            "type":"string",
            "maxLength":"500",
            "description":"Status Reason"
        },
        "emailSubject":{
            "type":"string",
            "maxLength":"256",
            "description":"Subject"
        },
        "eventCapturedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event Date/Time"
        },
        "customerContactIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalRefId":{
                        "type":"string",
                        "maxLength":"120",
                        "description":"Customer Contact External Reference"
                    },
                    "identifierType":{
                        "type":"string",
                        "enum":[
                            "C1EX",
                            "C1NS",
                            "C1OS"
                        ],
                        "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
                    }
                }
            }
        },
        "templateData":{
            "type":"object",
            "properties":{
                "templateParm":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Key"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CreUpdCC"
    }
}

Nested Schema : customerContactIdentifier

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalRefId":{
                "type":"string",
                "maxLength":"120",
                "description":"Customer Contact External Reference"
            },
            "identifierType":{
                "type":"string",
                "enum":[
                    "C1EX",
                    "C1NS",
                    "C1OS"
                ],
                "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
            }
        }
    }
}

Nested Schema : templateData

Type: object

Show Source

• templateParm: array templateParm

{
    "type":"object",
    "properties":{
        "templateParm":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Key"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalRefId: string
  Maximum Length: 120

  Customer Contact External Reference
• identifierType: string
  Allowed Values: [ "C1EX", "C1NS", "C1OS" ]

  Identifier Type: * `C1EX` - External Identifier, * `C1NS` - Notification System Identifier, * `C1OS` - Originating System Identifier

{
    "type":"object",
    "properties":{
        "externalRefId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "identifierType":{
            "type":"string",
            "enum":[
                "C1EX",
                "C1NS",
                "C1OS"
            ],
            "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
        }
    }
}

Nested Schema : templateParm

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Key"
            },
            "value":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key: string
  Maximum Length: 254

  Template Parameter Key
• value: string
  Maximum Length: 254

  Template Parameter Value

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Key"
        },
        "value":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1CreUpdCC

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID is the account used on the customer contact.

  Example: 1589809012
• ccId: string
  Maximum Length: 10

  Customer Contact ID
• contactId: string
  Maximum Length: 10

  Person Contact
• customerContactIdentifier: array customerContactIdentifier
• deliveryChannel: string
  Allowed Values: [ "EMAI", "FAX ", "IVR ", "SMS " ]

  Delivery Type: * `EMAI` - Email, * `FAX ` - Fax, * `IVR ` - IVR, * `SMS ` - SMS
• deliveryValue: string
  Maximum Length: 254

  Contact Information
• emailSubject: string
  Maximum Length: 256

  Subject
• eventCapturedDateTime: string (date-time)
  Event Date/Time
• externalCCId: string
  Maximum Length: 120

  Customer Contact External Reference
• notificationInstanceId: string
  Maximum Length: 32

  Notification Instance
• notificationPreferenceId: string
  Maximum Length: 14

  Communication Preference
• notificationType: string
  Maximum Length: 30

  Notification Type
• origin: string
  Allowed Values: [ "C1CB", "NMS " ]

  A list of valid systems that can originate a notification. * `C1CB` - Customer Care and Billing, * `NMS ` - Network Management System

  Example: CCB
• personId: string
  Maximum Length: 10

  Person ID is the person used on the customer contact.

  Example: 0023939882
• reason: string
  Maximum Length: 500

  Status Reason
• status: string
  Allowed Values: [ "C1AP", "C1BN", "C1CK", "C1DV", "C1ES", "C1FL", "C1NS", "C1OP", "C1PN", "C1SK", "C1ST" ]

  Integration Status: * `C1AP` - Auto Opened, * `C1BN` - Bounced, * `C1CK` - Clicked, * `C1DV` - Delivered, * `C1ES` - Error Sending, * `C1FL` - Failed, * `C1NS` - Not Sent, * `C1OP` - Opened, * `C1PN` - Pending, * `C1SK` - Skipped, * `C1ST` - Sent
• templateData: object templateData

{
    "type":"object",
    "properties":{
        "externalCCId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "notificationInstanceId":{
            "type":"string",
            "maxLength":"32",
            "description":"Notification Instance"
        },
        "ccId":{
            "type":"string",
            "maxLength":"10",
            "description":"Customer Contact ID"
        },
        "origin":{
            "type":"string",
            "enum":[
                "C1CB",
                "NMS "
            ],
            "description":"A list of valid systems that can originate a notification.\n* `C1CB` - Customer Care and Billing,\n* `NMS ` - Network Management System",
            "example":"CCB"
        },
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID is the account used on the customer contact.",
            "example":"1589809012"
        },
        "contactId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person Contact"
        },
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the person used on the customer contact.",
            "example":"0023939882"
        },
        "notificationPreferenceId":{
            "type":"string",
            "maxLength":"14",
            "description":"Communication Preference"
        },
        "deliveryChannel":{
            "type":"string",
            "enum":[
                "EMAI",
                "FAX ",
                "IVR ",
                "SMS "
            ],
            "description":"Delivery Type:\n* `EMAI` - Email,\n* `FAX ` - Fax,\n* `IVR ` - IVR,\n* `SMS ` - SMS"
        },
        "deliveryValue":{
            "type":"string",
            "maxLength":"254",
            "description":"Contact Information"
        },
        "notificationType":{
            "type":"string",
            "maxLength":"30",
            "description":"Notification Type"
        },
        "status":{
            "type":"string",
            "enum":[
                "C1AP",
                "C1BN",
                "C1CK",
                "C1DV",
                "C1ES",
                "C1FL",
                "C1NS",
                "C1OP",
                "C1PN",
                "C1SK",
                "C1ST"
            ],
            "description":"Integration Status:\n* `C1AP` - Auto Opened,\n* `C1BN` - Bounced,\n* `C1CK` - Clicked,\n* `C1DV` - Delivered,\n* `C1ES` - Error Sending,\n* `C1FL` - Failed,\n* `C1NS` - Not Sent,\n* `C1OP` - Opened,\n* `C1PN` - Pending,\n* `C1SK` - Skipped,\n* `C1ST` - Sent"
        },
        "reason":{
            "type":"string",
            "maxLength":"500",
            "description":"Status Reason"
        },
        "emailSubject":{
            "type":"string",
            "maxLength":"256",
            "description":"Subject"
        },
        "eventCapturedDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event Date/Time"
        },
        "customerContactIdentifier":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalRefId":{
                        "type":"string",
                        "maxLength":"120",
                        "description":"Customer Contact External Reference"
                    },
                    "identifierType":{
                        "type":"string",
                        "enum":[
                            "C1EX",
                            "C1NS",
                            "C1OS"
                        ],
                        "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
                    }
                }
            }
        },
        "templateData":{
            "type":"object",
            "properties":{
                "templateParm":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Key"
                            },
                            "value":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Template Parameter Value"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CreUpdCC"
    }
}

Nested Schema : customerContactIdentifier

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalRefId":{
                "type":"string",
                "maxLength":"120",
                "description":"Customer Contact External Reference"
            },
            "identifierType":{
                "type":"string",
                "enum":[
                    "C1EX",
                    "C1NS",
                    "C1OS"
                ],
                "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
            }
        }
    }
}

Nested Schema : templateData

Type: object

Show Source

• templateParm: array templateParm

{
    "type":"object",
    "properties":{
        "templateParm":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Key"
                    },
                    "value":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Template Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalRefId: string
  Maximum Length: 120

  Customer Contact External Reference
• identifierType: string
  Allowed Values: [ "C1EX", "C1NS", "C1OS" ]

  Identifier Type: * `C1EX` - External Identifier, * `C1NS` - Notification System Identifier, * `C1OS` - Originating System Identifier

{
    "type":"object",
    "properties":{
        "externalRefId":{
            "type":"string",
            "maxLength":"120",
            "description":"Customer Contact External Reference"
        },
        "identifierType":{
            "type":"string",
            "enum":[
                "C1EX",
                "C1NS",
                "C1OS"
            ],
            "description":"Identifier Type:\n* `C1EX` - External Identifier,\n* `C1NS` - Notification System Identifier,\n* `C1OS` - Originating System Identifier"
        }
    }
}

Nested Schema : templateParm

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Key"
            },
            "value":{
                "type":"string",
                "maxLength":"254",
                "description":"Template Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key: string
  Maximum Length: 254

  Template Parameter Key
• value: string
  Maximum Length: 254

  Template Parameter Value

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Key"
        },
        "value":{
            "type":"string",
            "maxLength":"254",
            "description":"Template Parameter Value"
        }
    }
}

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