Jump to

• Request
• Response

Update Severance Process

put

https://server:port/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}

Request

Path Parameters

• severanceProcessId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• amountStillOwing: string
  (amtStillOwing2)
• collectionAmount: number
  Arrears Amount
• comments: string
  Maximum Length: 254

  Enter any Comments about the severance process.
• createdBy: object createdBy
• creationDateTime: string (date-time)
  Create Date/Time defines the start date/time of the severance process.

  Example: 2007-07-02T07:40:37-04:00
• daysInArrears: number
  Minimum Value: -999

  Maximum Value: 999

  You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days.
• events: object events
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• isCancel: boolean
  Cancel button is used to cancel the severance process.

  Example: false
• premise: object premise
• serviceAgreement: object serviceAgreement
  Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.
• severanceAmountBaseDate: string (date)
  Arrears Date This is the date the event starts aging.
• severanceProcessId: string
  Maximum Length: 10

  Severance Process ID is the unique system-generated identifier for this severance process.

  Example: 1033333333
• severanceProcessTemplate: object severanceProcessTemplate
  Severance Process Template defines the severance events in the process.
• severanceStatus: string
  Allowed Values: [ "10 ", "20 " ]

  Severance Status defines the state of the severance process. * `10 ` - Active, * `20 ` - Inactive

  Example: 20
• severanceStatusReason: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Reason defines how a severance process became Inactive or why a severance process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by User

  Example: 10
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "severanceProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Severance Process ID is the unique system-generated identifier for this severance process.",
            "example":"1033333333"
        },
        "severanceStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"10"
        },
        "serviceAgreement":{
            "type":"object",
            "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "severanceProcessTemplate":{
            "type":"object",
            "description":"Severance Process Template defines the severance events in the process.",
            "properties":{
                "severanceProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Process Template defines the severance events in the process.",
                    "example":"NORMAL UTIL"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the severance process.",
            "example":"2007-07-02T07:40:37-04:00"
        },
        "severanceAmountBaseDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date This is the date the event starts aging."
        },
        "collectionAmount":{
            "type":"number",
            "description":"Arrears Amount"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the severance process."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "severanceEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"20"
                            },
                            "severanceEventType":{
                                "type":"object",
                                "properties":{
                                    "severanceEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Severance Event Type"
                                    }
                                }
                            },
                            "dependOnOtherEvents":{
                                "type":"boolean",
                                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                                "example":"false"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2007-07-02"
                            },
                            "daysAfterPreviousResponse":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                                "example":"0"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "severanceEvent":{
                                "type":"string",
                                "maxLength":150,
                                "description":"The Severance Events contains the severance events that comprise the severance process.",
                                "example":"The Severance Events contains the severance events that comprise the severance process."
                            },
                            "eventDependencies":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "eventSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence Number"
                                                },
                                                "dependentOnSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                                    "example":"20"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventFieldActivities":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "fieldActivity":{
                                                    "type":"object",
                                                    "properties":{
                                                        "fieldActivityId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Field Activity ID"
                                                        },
                                                        "fieldActivityInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"Field Activity Information"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "servicePoint":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "spInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"SP Info"
                                                        },
                                                        "servicePointId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Service Point ID"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventCustomerContacts":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "ccInfo":{
                                                    "type":"string",
                                                    "description":"(ccInfo)"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Premise ID is a system assigned random number that stays with a premise for life."
                }
            }
        },
        "amountStillOwing":{
            "type":"string",
            "description":"(amtStillOwing2)"
        },
        "daysInArrears":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."
        },
        "isCancel":{
            "type":"boolean",
            "description":"Cancel button is used to cancel the severance process.",
            "example":"false"
        },
        "createdBy":{
            "type":"object",
            "properties":{
                "collectionProcess":{
                    "type":"object",
                    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
                    "properties":{
                        "collectionProcessId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Collection Process ID"
                        }
                    }
                },
                "eventSequence":{
                    "type":"string",
                    "description":"(eventSequence)"
                },
                "severanceCriteriaSequence":{
                    "type":"string",
                    "description":"(severanceCriteriaSequence)"
                }
            }
        }
    },
    "xml":{
        "name":"C1SeveraProc"
    }
}

Nested Schema : createdBy

Type: object

Show Source

• collectionProcess: object collectionProcess
  Collection Process ID is the unique system-generated identifier for the collection process.
• eventSequence: string
  (eventSequence)
• severanceCriteriaSequence: string
  (severanceCriteriaSequence)

{
    "type":"object",
    "properties":{
        "collectionProcess":{
            "type":"object",
            "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
            "properties":{
                "collectionProcessId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Collection Process ID"
                }
            }
        },
        "eventSequence":{
            "type":"string",
            "description":"(eventSequence)"
        },
        "severanceCriteriaSequence":{
            "type":"string",
            "description":"(severanceCriteriaSequence)"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "severanceEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"20"
                    },
                    "severanceEventType":{
                        "type":"object",
                        "properties":{
                            "severanceEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Severance Event Type"
                            }
                        }
                    },
                    "dependOnOtherEvents":{
                        "type":"boolean",
                        "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                        "example":"false"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2007-07-02"
                    },
                    "daysAfterPreviousResponse":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                        "example":"0"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "severanceEvent":{
                        "type":"string",
                        "maxLength":150,
                        "description":"The Severance Events contains the severance events that comprise the severance process.",
                        "example":"The Severance Events contains the severance events that comprise the severance process."
                    },
                    "eventDependencies":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "eventSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence Number"
                                        },
                                        "dependentOnSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                            "example":"20"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventFieldActivities":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "fieldActivity":{
                                            "type":"object",
                                            "properties":{
                                                "fieldActivityId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Field Activity ID"
                                                },
                                                "fieldActivityInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Field Activity Information"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "servicePoint":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "spInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"SP Info"
                                                },
                                                "servicePointId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Point ID"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventCustomerContacts":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "ccInfo":{
                                            "type":"string",
                                            "description":"(ccInfo)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  The Premise ID is a system assigned random number that stays with a premise for life.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : severanceProcessTemplate

Type: object

Severance Process Template defines the severance events in the process.

Show Source

• severanceProcessTemplate: string
  Maximum Length: 12

  Severance Process Template defines the severance events in the process.

  Example: NORMAL UTIL

{
    "type":"object",
    "description":"Severance Process Template defines the severance events in the process.",
    "properties":{
        "severanceProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Process Template defines the severance events in the process.",
            "example":"NORMAL UTIL"
        }
    }
}

Nested Schema : collectionProcess

Type: object

Collection Process ID is the unique system-generated identifier for the collection process.

Show Source

• collectionProcessId: string
  Maximum Length: 10

  Collection Process ID

{
    "type":"object",
    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
    "properties":{
        "collectionProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Collection Process ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "severanceEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  "
                ],
                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"20"
            },
            "severanceEventType":{
                "type":"object",
                "properties":{
                    "severanceEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Severance Event Type"
                    }
                }
            },
            "dependOnOtherEvents":{
                "type":"boolean",
                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                "example":"false"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2007-07-02"
            },
            "daysAfterPreviousResponse":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                "example":"0"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "severanceEvent":{
                "type":"string",
                "maxLength":150,
                "description":"The Severance Events contains the severance events that comprise the severance process.",
                "example":"The Severance Events contains the severance events that comprise the severance process."
            },
            "eventDependencies":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "eventSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence Number"
                                },
                                "dependentOnSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                    "example":"20"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            },
            "eventFieldActivities":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "fieldActivity":{
                                    "type":"object",
                                    "properties":{
                                        "fieldActivityId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Field Activity ID"
                                        },
                                        "fieldActivityInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Field Activity Information"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "servicePoint":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "spInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"SP Info"
                                        },
                                        "servicePointId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "eventCustomerContacts":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "ccInfo":{
                                    "type":"string",
                                    "description":"(ccInfo)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• completionDate: string (date)
  If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event.
• daysAfterPreviousResponse: number
  Minimum Value: -999

  Maximum Value: 999

  Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.

  Example: 0
• dependOnOtherEvents: boolean
  If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.

  Example: false
• eventCustomerContacts: object eventCustomerContacts
• eventDependencies: object eventDependencies
• eventFieldActivities: object eventFieldActivities
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• severanceEvent: string
  Maximum Length: 150

  The Severance Events contains the severance events that comprise the severance process.

  Example: The Severance Events contains the severance events that comprise the severance process.
• severanceEventStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Severance Event Status defines the state of the event. * `10 ` - Pending, * `20 ` - Awaiting Field Activity, * `30 ` - Completed, * `40 ` - Canceled

  Example: 20
• severanceEventType: object severanceEventType
• triggerDate: string (date)
  The Trigger Date defines the date when the system completes (i.e., executes) the event.

  Example: 2007-07-02
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"20"
        },
        "severanceEventType":{
            "type":"object",
            "properties":{
                "severanceEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Event Type"
                }
            }
        },
        "dependOnOtherEvents":{
            "type":"boolean",
            "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
            "example":"false"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2007-07-02"
        },
        "daysAfterPreviousResponse":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
            "example":"0"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "severanceEvent":{
            "type":"string",
            "maxLength":150,
            "description":"The Severance Events contains the severance events that comprise the severance process.",
            "example":"The Severance Events contains the severance events that comprise the severance process."
        },
        "eventDependencies":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number"
                            },
                            "dependentOnSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                "example":"20"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "eventFieldActivities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "fieldActivity":{
                                "type":"object",
                                "properties":{
                                    "fieldActivityId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Field Activity ID"
                                    },
                                    "fieldActivityInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Field Activity Information"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "spInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"SP Info"
                                    },
                                    "servicePointId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Point ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "eventCustomerContacts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "ccInfo":{
                                "type":"string",
                                "description":"(ccInfo)"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContacts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "ccInfo":{
                        "type":"string",
                        "description":"(ccInfo)"
                    }
                }
            }
        }
    }
}

Nested Schema : eventDependencies

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence Number"
                    },
                    "dependentOnSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                        "example":"20"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : eventFieldActivities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "fieldActivity":{
                        "type":"object",
                        "properties":{
                            "fieldActivityId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Field Activity ID"
                            },
                            "fieldActivityInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Field Activity Information"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "spInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"SP Info"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : severanceEventType

Type: object

Show Source

• severanceEventType: string
  Maximum Length: 12

  Severance Event Type

{
    "type":"object",
    "properties":{
        "severanceEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "customerContact":{
                "type":"object",
                "properties":{
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "ccInfo":{
                "type":"string",
                "description":"(ccInfo)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ccInfo: string
  (ccInfo)
• customerContact: object customerContact
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "customerContact":{
            "type":"object",
            "properties":{
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "ccInfo":{
            "type":"string",
            "description":"(ccInfo)"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence Number"
            },
            "dependentOnSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                "example":"20"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dependentOnSequence: number
  Minimum Value: -999

  Maximum Value: 999

  When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.

  Example: 20
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number"
        },
        "dependentOnSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
            "example":"20"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "fieldActivity":{
                "type":"object",
                "properties":{
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID"
                    },
                    "fieldActivityInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Activity Information"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "servicePoint":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "spInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"SP Info"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldActivity: object fieldActivity
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• servicePoint: object servicePoint
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "fieldActivity":{
            "type":"object",
            "properties":{
                "fieldActivityId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Field Activity ID"
                },
                "fieldActivityInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Field Activity Information"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "servicePoint":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "spInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"SP Info"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID"
                }
            }
        }
    }
}

Nested Schema : fieldActivity

Type: object

Show Source

• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID
• fieldActivityInformation: string
  Maximum Length: 254

  Field Activity Information

{
    "type":"object",
    "properties":{
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID"
        },
        "fieldActivityInformation":{
            "type":"string",
            "maxLength":254,
            "description":"Field Activity Information"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• spInformation: string
  Maximum Length: 254

  SP Info

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "spInformation":{
            "type":"string",
            "maxLength":254,
            "description":"SP Info"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• amountStillOwing: string
  (amtStillOwing2)
• collectionAmount: number
  Arrears Amount
• comments: string
  Maximum Length: 254

  Enter any Comments about the severance process.
• createdBy: object createdBy
• creationDateTime: string (date-time)
  Create Date/Time defines the start date/time of the severance process.

  Example: 2007-07-02T07:40:37-04:00
• daysInArrears: number
  Minimum Value: -999

  Maximum Value: 999

  You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days.
• events: object events
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• isCancel: boolean
  Cancel button is used to cancel the severance process.

  Example: false
• premise: object premise
• serviceAgreement: object serviceAgreement
  Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.
• severanceAmountBaseDate: string (date)
  Arrears Date This is the date the event starts aging.
• severanceProcessId: string
  Maximum Length: 10

  Severance Process ID is the unique system-generated identifier for this severance process.

  Example: 1033333333
• severanceProcessTemplate: object severanceProcessTemplate
  Severance Process Template defines the severance events in the process.
• severanceStatus: string
  Allowed Values: [ "10 ", "20 " ]

  Severance Status defines the state of the severance process. * `10 ` - Active, * `20 ` - Inactive

  Example: 20
• severanceStatusReason: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Reason defines how a severance process became Inactive or why a severance process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by User

  Example: 10
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "severanceProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Severance Process ID is the unique system-generated identifier for this severance process.",
            "example":"1033333333"
        },
        "severanceStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"10"
        },
        "serviceAgreement":{
            "type":"object",
            "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "severanceProcessTemplate":{
            "type":"object",
            "description":"Severance Process Template defines the severance events in the process.",
            "properties":{
                "severanceProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Process Template defines the severance events in the process.",
                    "example":"NORMAL UTIL"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the severance process.",
            "example":"2007-07-02T07:40:37-04:00"
        },
        "severanceAmountBaseDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date This is the date the event starts aging."
        },
        "collectionAmount":{
            "type":"number",
            "description":"Arrears Amount"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the severance process."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "severanceEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"20"
                            },
                            "severanceEventType":{
                                "type":"object",
                                "properties":{
                                    "severanceEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Severance Event Type"
                                    }
                                }
                            },
                            "dependOnOtherEvents":{
                                "type":"boolean",
                                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                                "example":"false"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2007-07-02"
                            },
                            "daysAfterPreviousResponse":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                                "example":"0"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "severanceEvent":{
                                "type":"string",
                                "maxLength":150,
                                "description":"The Severance Events contains the severance events that comprise the severance process.",
                                "example":"The Severance Events contains the severance events that comprise the severance process."
                            },
                            "eventDependencies":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "eventSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence Number"
                                                },
                                                "dependentOnSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                                    "example":"20"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventFieldActivities":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "fieldActivity":{
                                                    "type":"object",
                                                    "properties":{
                                                        "fieldActivityId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Field Activity ID"
                                                        },
                                                        "fieldActivityInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"Field Activity Information"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "servicePoint":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "spInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"SP Info"
                                                        },
                                                        "servicePointId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Service Point ID"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventCustomerContacts":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "ccInfo":{
                                                    "type":"string",
                                                    "description":"(ccInfo)"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Premise ID is a system assigned random number that stays with a premise for life."
                }
            }
        },
        "amountStillOwing":{
            "type":"string",
            "description":"(amtStillOwing2)"
        },
        "daysInArrears":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."
        },
        "isCancel":{
            "type":"boolean",
            "description":"Cancel button is used to cancel the severance process.",
            "example":"false"
        },
        "createdBy":{
            "type":"object",
            "properties":{
                "collectionProcess":{
                    "type":"object",
                    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
                    "properties":{
                        "collectionProcessId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Collection Process ID"
                        }
                    }
                },
                "eventSequence":{
                    "type":"string",
                    "description":"(eventSequence)"
                },
                "severanceCriteriaSequence":{
                    "type":"string",
                    "description":"(severanceCriteriaSequence)"
                }
            }
        }
    },
    "xml":{
        "name":"C1SeveraProc"
    }
}

Nested Schema : createdBy

Type: object

Show Source

• collectionProcess: object collectionProcess
  Collection Process ID is the unique system-generated identifier for the collection process.
• eventSequence: string
  (eventSequence)
• severanceCriteriaSequence: string
  (severanceCriteriaSequence)

{
    "type":"object",
    "properties":{
        "collectionProcess":{
            "type":"object",
            "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
            "properties":{
                "collectionProcessId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Collection Process ID"
                }
            }
        },
        "eventSequence":{
            "type":"string",
            "description":"(eventSequence)"
        },
        "severanceCriteriaSequence":{
            "type":"string",
            "description":"(severanceCriteriaSequence)"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "severanceEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"20"
                    },
                    "severanceEventType":{
                        "type":"object",
                        "properties":{
                            "severanceEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Severance Event Type"
                            }
                        }
                    },
                    "dependOnOtherEvents":{
                        "type":"boolean",
                        "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                        "example":"false"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2007-07-02"
                    },
                    "daysAfterPreviousResponse":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                        "example":"0"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "severanceEvent":{
                        "type":"string",
                        "maxLength":150,
                        "description":"The Severance Events contains the severance events that comprise the severance process.",
                        "example":"The Severance Events contains the severance events that comprise the severance process."
                    },
                    "eventDependencies":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "eventSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence Number"
                                        },
                                        "dependentOnSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                            "example":"20"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventFieldActivities":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "fieldActivity":{
                                            "type":"object",
                                            "properties":{
                                                "fieldActivityId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Field Activity ID"
                                                },
                                                "fieldActivityInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Field Activity Information"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "servicePoint":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "spInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"SP Info"
                                                },
                                                "servicePointId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Point ID"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventCustomerContacts":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "ccInfo":{
                                            "type":"string",
                                            "description":"(ccInfo)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  The Premise ID is a system assigned random number that stays with a premise for life.

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : severanceProcessTemplate

Type: object

Severance Process Template defines the severance events in the process.

Show Source

• severanceProcessTemplate: string
  Maximum Length: 12

  Severance Process Template defines the severance events in the process.

  Example: NORMAL UTIL

{
    "type":"object",
    "description":"Severance Process Template defines the severance events in the process.",
    "properties":{
        "severanceProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Process Template defines the severance events in the process.",
            "example":"NORMAL UTIL"
        }
    }
}

Nested Schema : collectionProcess

Type: object

Collection Process ID is the unique system-generated identifier for the collection process.

Show Source

• collectionProcessId: string
  Maximum Length: 10

  Collection Process ID

{
    "type":"object",
    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
    "properties":{
        "collectionProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Collection Process ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "severanceEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  "
                ],
                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"20"
            },
            "severanceEventType":{
                "type":"object",
                "properties":{
                    "severanceEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Severance Event Type"
                    }
                }
            },
            "dependOnOtherEvents":{
                "type":"boolean",
                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                "example":"false"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2007-07-02"
            },
            "daysAfterPreviousResponse":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                "example":"0"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "severanceEvent":{
                "type":"string",
                "maxLength":150,
                "description":"The Severance Events contains the severance events that comprise the severance process.",
                "example":"The Severance Events contains the severance events that comprise the severance process."
            },
            "eventDependencies":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "eventSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence Number"
                                },
                                "dependentOnSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                    "example":"20"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            },
            "eventFieldActivities":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "fieldActivity":{
                                    "type":"object",
                                    "properties":{
                                        "fieldActivityId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Field Activity ID"
                                        },
                                        "fieldActivityInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Field Activity Information"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "servicePoint":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "spInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"SP Info"
                                        },
                                        "servicePointId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "eventCustomerContacts":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "ccInfo":{
                                    "type":"string",
                                    "description":"(ccInfo)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• completionDate: string (date)
  If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event.
• daysAfterPreviousResponse: number
  Minimum Value: -999

  Maximum Value: 999

  Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.

  Example: 0
• dependOnOtherEvents: boolean
  If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.

  Example: false
• eventCustomerContacts: object eventCustomerContacts
• eventDependencies: object eventDependencies
• eventFieldActivities: object eventFieldActivities
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• severanceEvent: string
  Maximum Length: 150

  The Severance Events contains the severance events that comprise the severance process.

  Example: The Severance Events contains the severance events that comprise the severance process.
• severanceEventStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Severance Event Status defines the state of the event. * `10 ` - Pending, * `20 ` - Awaiting Field Activity, * `30 ` - Completed, * `40 ` - Canceled

  Example: 20
• severanceEventType: object severanceEventType
• triggerDate: string (date)
  The Trigger Date defines the date when the system completes (i.e., executes) the event.

  Example: 2007-07-02
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"20"
        },
        "severanceEventType":{
            "type":"object",
            "properties":{
                "severanceEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Event Type"
                }
            }
        },
        "dependOnOtherEvents":{
            "type":"boolean",
            "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
            "example":"false"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2007-07-02"
        },
        "daysAfterPreviousResponse":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
            "example":"0"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "severanceEvent":{
            "type":"string",
            "maxLength":150,
            "description":"The Severance Events contains the severance events that comprise the severance process.",
            "example":"The Severance Events contains the severance events that comprise the severance process."
        },
        "eventDependencies":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number"
                            },
                            "dependentOnSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                "example":"20"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "eventFieldActivities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "fieldActivity":{
                                "type":"object",
                                "properties":{
                                    "fieldActivityId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Field Activity ID"
                                    },
                                    "fieldActivityInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Field Activity Information"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "spInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"SP Info"
                                    },
                                    "servicePointId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Point ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "eventCustomerContacts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "ccInfo":{
                                "type":"string",
                                "description":"(ccInfo)"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContacts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "ccInfo":{
                        "type":"string",
                        "description":"(ccInfo)"
                    }
                }
            }
        }
    }
}

Nested Schema : eventDependencies

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence Number"
                    },
                    "dependentOnSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                        "example":"20"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : eventFieldActivities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "fieldActivity":{
                        "type":"object",
                        "properties":{
                            "fieldActivityId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Field Activity ID"
                            },
                            "fieldActivityInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Field Activity Information"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "spInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"SP Info"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : severanceEventType

Type: object

Show Source

• severanceEventType: string
  Maximum Length: 12

  Severance Event Type

{
    "type":"object",
    "properties":{
        "severanceEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "customerContact":{
                "type":"object",
                "properties":{
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "ccInfo":{
                "type":"string",
                "description":"(ccInfo)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ccInfo: string
  (ccInfo)
• customerContact: object customerContact
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "customerContact":{
            "type":"object",
            "properties":{
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "ccInfo":{
            "type":"string",
            "description":"(ccInfo)"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence Number"
            },
            "dependentOnSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                "example":"20"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dependentOnSequence: number
  Minimum Value: -999

  Maximum Value: 999

  When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.

  Example: 20
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number"
        },
        "dependentOnSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
            "example":"20"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "fieldActivity":{
                "type":"object",
                "properties":{
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID"
                    },
                    "fieldActivityInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Activity Information"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "servicePoint":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "spInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"SP Info"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldActivity: object fieldActivity
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• servicePoint: object servicePoint
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "fieldActivity":{
            "type":"object",
            "properties":{
                "fieldActivityId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Field Activity ID"
                },
                "fieldActivityInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Field Activity Information"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "servicePoint":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "spInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"SP Info"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID"
                }
            }
        }
    }
}

Nested Schema : fieldActivity

Type: object

Show Source

• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID
• fieldActivityInformation: string
  Maximum Length: 254

  Field Activity Information

{
    "type":"object",
    "properties":{
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID"
        },
        "fieldActivityInformation":{
            "type":"string",
            "maxLength":254,
            "description":"Field Activity Information"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• spInformation: string
  Maximum Length: 254

  SP Info

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "spInformation":{
            "type":"string",
            "maxLength":254,
            "description":"SP Info"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1SeveraProc

Type: object

Show Source

• _self: string
  _self
• amountStillOwing: string
  (amtStillOwing2)
• collectionAmount: number
  Arrears Amount
• comments: string
  Maximum Length: 254

  Enter any Comments about the severance process.
• createdBy: object createdBy
• creationDateTime: string (date-time)
  Create Date/Time defines the start date/time of the severance process.

  Example: 2007-07-02T07:40:37-04:00
• daysInArrears: number
  Minimum Value: -999

  Maximum Value: 999

  You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days.
• events: object events
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• premise: object premise
• serviceAgreement: object serviceAgreement
  Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.
• severanceAmountBaseDate: string (date)
  Arrears Date This is the date the event starts aging.
• severanceProcessId: string
  Maximum Length: 10

  Severance Process ID is the unique system-generated identifier for this severance process.

  Example: 1033333333
• severanceProcessTemplate: object severanceProcessTemplate
  Severance Process Template defines the severance events in the process.
• severanceStatus: string
  Allowed Values: [ "10 ", "20 " ]

  Severance Status defines the state of the severance process. * `10 ` - Active, * `20 ` - Inactive

  Example: 20
• severanceStatusReason: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Reason defines how a severance process became Inactive or why a severance process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by User

  Example: 10
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "severanceProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Severance Process ID is the unique system-generated identifier for this severance process.",
            "example":"1033333333"
        },
        "severanceStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Severance Status defines the state of the severance process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a severance process became Inactive or why a severance process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"10"
        },
        "serviceAgreement":{
            "type":"object",
            "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "severanceProcessTemplate":{
            "type":"object",
            "description":"Severance Process Template defines the severance events in the process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "severanceProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Process Template defines the severance events in the process.",
                    "example":"NORMAL UTIL"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the severance process.",
            "example":"2007-07-02T07:40:37-04:00"
        },
        "severanceAmountBaseDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date This is the date the event starts aging."
        },
        "collectionAmount":{
            "type":"number",
            "description":"Arrears Amount"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the severance process."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "severanceEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"20"
                            },
                            "severanceEventType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "severanceEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Severance Event Type"
                                    }
                                }
                            },
                            "dependOnOtherEvents":{
                                "type":"boolean",
                                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                                "example":"false"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2007-07-02"
                            },
                            "daysAfterPreviousResponse":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                                "example":"0"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "severanceEvent":{
                                "type":"string",
                                "maxLength":150,
                                "description":"The Severance Events contains the severance events that comprise the severance process.",
                                "example":"The Severance Events contains the severance events that comprise the severance process."
                            },
                            "eventDependencies":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "eventSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence Number"
                                                },
                                                "dependentOnSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                                    "example":"20"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventFieldActivities":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "fieldActivity":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "fieldActivityId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Field Activity ID"
                                                        },
                                                        "fieldActivityInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"Field Activity Information"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "servicePoint":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "spInformation":{
                                                            "type":"string",
                                                            "maxLength":254,
                                                            "description":"SP Info"
                                                        },
                                                        "servicePointId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Service Point ID"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "eventCustomerContacts":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Event Sequence"
                                                },
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                },
                                                "ccInfo":{
                                                    "type":"string",
                                                    "description":"(ccInfo)"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The Premise ID is a system assigned random number that stays with a premise for life."
                }
            }
        },
        "amountStillOwing":{
            "type":"string",
            "description":"(amtStillOwing2)"
        },
        "daysInArrears":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"You can have the system calculate Severance Amount Base Date for you by providing the age of the arrears in the number of days."
        },
        "createdBy":{
            "type":"object",
            "properties":{
                "collectionProcess":{
                    "type":"object",
                    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "collectionProcessId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Collection Process ID"
                        }
                    }
                },
                "eventSequence":{
                    "type":"string",
                    "description":"(eventSequence)"
                },
                "severanceCriteriaSequence":{
                    "type":"string",
                    "description":"(severanceCriteriaSequence)"
                }
            }
        }
    },
    "xml":{
        "name":"C1SeveraProc"
    }
}

Nested Schema : createdBy

Type: object

Show Source

• collectionProcess: object collectionProcess
  Collection Process ID is the unique system-generated identifier for the collection process.
• eventSequence: string
  (eventSequence)
• severanceCriteriaSequence: string
  (severanceCriteriaSequence)

{
    "type":"object",
    "properties":{
        "collectionProcess":{
            "type":"object",
            "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "collectionProcessId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Collection Process ID"
                }
            }
        },
        "eventSequence":{
            "type":"string",
            "description":"(eventSequence)"
        },
        "severanceCriteriaSequence":{
            "type":"string",
            "description":"(severanceCriteriaSequence)"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "severanceEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"20"
                    },
                    "severanceEventType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "severanceEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Severance Event Type"
                            }
                        }
                    },
                    "dependOnOtherEvents":{
                        "type":"boolean",
                        "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                        "example":"false"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2007-07-02"
                    },
                    "daysAfterPreviousResponse":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                        "example":"0"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "severanceEvent":{
                        "type":"string",
                        "maxLength":150,
                        "description":"The Severance Events contains the severance events that comprise the severance process.",
                        "example":"The Severance Events contains the severance events that comprise the severance process."
                    },
                    "eventDependencies":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "eventSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence Number"
                                        },
                                        "dependentOnSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                            "example":"20"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventFieldActivities":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "fieldActivity":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "fieldActivityId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Field Activity ID"
                                                },
                                                "fieldActivityInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Field Activity Information"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "servicePoint":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "spInformation":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"SP Info"
                                                },
                                                "servicePointId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Service Point ID"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "eventCustomerContacts":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Event Sequence"
                                        },
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        },
                                        "ccInfo":{
                                            "type":"string",
                                            "description":"(ccInfo)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  The Premise ID is a system assigned random number that stays with a premise for life.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID is a system assigned random number that stays with a premise for life."
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "description":"Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Nested Schema : severanceProcessTemplate

Type: object

Severance Process Template defines the severance events in the process.

Show Source

• _link: string
  _link
• severanceProcessTemplate: string
  Maximum Length: 12

  Severance Process Template defines the severance events in the process.

  Example: NORMAL UTIL

{
    "type":"object",
    "description":"Severance Process Template defines the severance events in the process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "severanceProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Process Template defines the severance events in the process.",
            "example":"NORMAL UTIL"
        }
    }
}

Nested Schema : collectionProcess

Type: object

Collection Process ID is the unique system-generated identifier for the collection process.

Show Source

• _link: string
  _link
• collectionProcessId: string
  Maximum Length: 10

  Collection Process ID

{
    "type":"object",
    "description":"Collection Process ID is the unique system-generated identifier for the collection process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "collectionProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Collection Process ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "severanceEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  "
                ],
                "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"20"
            },
            "severanceEventType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "severanceEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Severance Event Type"
                    }
                }
            },
            "dependOnOtherEvents":{
                "type":"boolean",
                "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
                "example":"false"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2007-07-02"
            },
            "daysAfterPreviousResponse":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
                "example":"0"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "severanceEvent":{
                "type":"string",
                "maxLength":150,
                "description":"The Severance Events contains the severance events that comprise the severance process.",
                "example":"The Severance Events contains the severance events that comprise the severance process."
            },
            "eventDependencies":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "eventSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence Number"
                                },
                                "dependentOnSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                    "example":"20"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            },
            "eventFieldActivities":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "fieldActivity":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "fieldActivityId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Field Activity ID"
                                        },
                                        "fieldActivityInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Field Activity Information"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "servicePoint":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "spInformation":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"SP Info"
                                        },
                                        "servicePointId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Service Point ID"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "eventCustomerContacts":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Event Sequence"
                                },
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                },
                                "ccInfo":{
                                    "type":"string",
                                    "description":"(ccInfo)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• completionDate: string (date)
  If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event.
• daysAfterPreviousResponse: number
  Minimum Value: -999

  Maximum Value: 999

  Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.

  Example: 0
• dependOnOtherEvents: boolean
  If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.

  Example: false
• eventCustomerContacts: object eventCustomerContacts
• eventDependencies: object eventDependencies
• eventFieldActivities: object eventFieldActivities
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• severanceEvent: string
  Maximum Length: 150

  The Severance Events contains the severance events that comprise the severance process.

  Example: The Severance Events contains the severance events that comprise the severance process.
• severanceEventStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

  Severance Event Status defines the state of the event. * `10 ` - Pending, * `20 ` - Awaiting Field Activity, * `30 ` - Completed, * `40 ` - Canceled

  Example: 20
• severanceEventType: object severanceEventType
• triggerDate: string (date)
  The Trigger Date defines the date when the system completes (i.e., executes) the event.

  Example: 2007-07-02
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "severanceEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Severance Event Status defines the state of the event.\n* `10  ` - Pending,\n* `20  ` - Awaiting Field Activity,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"20"
        },
        "severanceEventType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "severanceEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Severance Event Type"
                }
            }
        },
        "dependOnOtherEvents":{
            "type":"boolean",
            "description":"If Dependent on Other Events is turned on, then the event's trigger date is only determined after the event(s) on which it depends are completed.",
            "example":"false"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2007-07-02"
        },
        "daysAfterPreviousResponse":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.",
            "example":"0"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "severanceEvent":{
            "type":"string",
            "maxLength":150,
            "description":"The Severance Events contains the severance events that comprise the severance process.",
            "example":"The Severance Events contains the severance events that comprise the severance process."
        },
        "eventDependencies":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number"
                            },
                            "dependentOnSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                                "example":"20"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "eventFieldActivities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "fieldActivity":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "fieldActivityId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Field Activity ID"
                                    },
                                    "fieldActivityInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Field Activity Information"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "servicePoint":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "spInformation":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"SP Info"
                                    },
                                    "servicePointId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Point ID"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "eventCustomerContacts":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "ccInfo":{
                                "type":"string",
                                "description":"(ccInfo)"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContacts

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "ccInfo":{
                        "type":"string",
                        "description":"(ccInfo)"
                    }
                }
            }
        }
    }
}

Nested Schema : eventDependencies

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence Number"
                    },
                    "dependentOnSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                        "example":"20"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : eventFieldActivities

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence"
                    },
                    "fieldActivity":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "fieldActivityId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Field Activity ID"
                            },
                            "fieldActivityInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Field Activity Information"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "servicePoint":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "spInformation":{
                                "type":"string",
                                "maxLength":254,
                                "description":"SP Info"
                            },
                            "servicePointId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Point ID"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : severanceEventType

Type: object

Show Source

• _link: string
  _link
• severanceEventType: string
  Maximum Length: 12

  Severance Event Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "severanceEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Severance Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "customerContact":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "ccInfo":{
                "type":"string",
                "description":"(ccInfo)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ccInfo: string
  (ccInfo)
• customerContact: object customerContact
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "customerContact":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "ccInfo":{
            "type":"string",
            "description":"(ccInfo)"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• _link: string
  _link
• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence Number"
            },
            "dependentOnSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
                "example":"20"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• dependentOnSequence: number
  Minimum Value: -999

  Maximum Value: 999

  When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.

  Example: 20
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number"
        },
        "dependentOnSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.",
            "example":"20"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence"
            },
            "fieldActivity":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "fieldActivityId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Field Activity ID"
                    },
                    "fieldActivityInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Field Activity Information"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "servicePoint":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "spInformation":{
                        "type":"string",
                        "maxLength":254,
                        "description":"SP Info"
                    },
                    "servicePointId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Point ID"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldActivity: object fieldActivity
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• servicePoint: object servicePoint
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "fieldActivity":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "fieldActivityId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Field Activity ID"
                },
                "fieldActivityInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Field Activity Information"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "servicePoint":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "spInformation":{
                    "type":"string",
                    "maxLength":254,
                    "description":"SP Info"
                },
                "servicePointId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Point ID"
                }
            }
        }
    }
}

Nested Schema : fieldActivity

Type: object

Show Source

• _link: string
  _link
• fieldActivityId: string
  Maximum Length: 10

  Field Activity ID
• fieldActivityInformation: string
  Maximum Length: 254

  Field Activity Information

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "fieldActivityId":{
            "type":"string",
            "maxLength":10,
            "description":"Field Activity ID"
        },
        "fieldActivityInformation":{
            "type":"string",
            "maxLength":254,
            "description":"Field Activity Information"
        }
    }
}

Nested Schema : servicePoint

Type: object

Show Source

• _link: string
  _link
• servicePointId: string
  Maximum Length: 10

  Service Point ID
• spInformation: string
  Maximum Length: 254

  SP Info

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "spInformation":{
            "type":"string",
            "maxLength":254,
            "description":"SP Info"
        },
        "servicePointId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        }
    }
}

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