Jump to

• Request
• Response

Update Case

put

https://server:port/spl/rest/apis/customer/interactions/cases/{caseId}

Request

Path Parameters

• caseId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• account: object account
• caseCondition: string
  Allowed Values: [ "CLSD", "OPEN" ]

  Case Condition * `CLSD` - Closed, * `OPEN` - Open

  Example: OPEN
• caseId: string
  Maximum Length: 10

  Case ID is the system-assigned unique identifier of the case.

  Example: 1118286467
• caseType: object caseType
  Case Type defines the type of case.
• characteristics: object characteristics
• comments: string
  Maximum Length: 2000

  Comments can be used to describe anything interesting or unusual about the case.

  Example: new Test
• contactDetail: string
  Maximum Length: 10

  System-assigned, unique identifier of the person contact record.
• contactInformation: object contactInformation
• isEligibleForArchiving: boolean
  ILM Archive Switch
• person: object person
• premise: object premise
• responsibleUser: object responsibleUser
• status: string
  Maximum Length: 12

  Status shows the current state of the case.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "caseId":{
            "type":"string",
            "maxLength":10,
            "description":"Case ID is the system-assigned unique identifier of the case.",
            "example":"1118286467"
        },
        "caseType":{
            "type":"object",
            "description":"Case Type defines the type of case.",
            "properties":{
                "caseType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Case Type defines the type of case.",
                    "example":"BANKRUPT"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status shows the current state of the case.",
            "example":"NEW"
        },
        "comments":{
            "type":"string",
            "maxLength":2000,
            "description":"Comments can be used to describe anything interesting or unusual about the case.",
            "example":"new Test"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID references the person associated with this case.",
                    "example":"0003339882"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID references the account associated with this case.",
                    "example":"0777774590"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID references the premise associated with this case.",
                    "example":"0005606666"
                }
            }
        },
        "responsibleUser":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "caseCondition":{
            "type":"string",
            "enum":[
                "CLSD",
                "OPEN"
            ],
            "description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open",
            "example":"OPEN"
        },
        "contactInformation":{
            "type":"object",
            "properties":{
                "contactPerson":{
                    "type":"object",
                    "description":"Contact Person references the person who should be contacted.",
                    "properties":{
                        "contactPersonId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Contact Person"
                        }
                    }
                },
                "preferredContactMethod":{
                    "type":"string",
                    "enum":[
                        "C1PC",
                        "EM  ",
                        "FAX ",
                        "N/A ",
                        "PH  ",
                        "POST",
                        "SMS "
                    ],
                    "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
                    "example":"FAX"
                },
                "contactInstructions":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
                    "example":"Only in Day"
                },
                "callBackPhoneType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Callback Phone Type indicate the actual phone type",
                    "example":"CAMP"
                },
                "callBackPhoneNumber":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Callback Phone Number indicate the actual phone number",
                    "example":"[phone]"
                },
                "extension":{
                    "type":"string",
                    "maxLength":6,
                    "description":"1234"
                }
            }
        },
        "isEligibleForArchiving":{
            "type":"boolean",
            "description":"ILM Archive Switch"
        },
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"System-assigned, unique identifier of the person contact record."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number",
                                "example":"10"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                                "example":"FKV"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-Case"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID references the account associated with this case.

  Example: 0777774590

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID references the account associated with this case.",
            "example":"0777774590"
        }
    }
}

Nested Schema : caseType

Type: object

Case Type defines the type of case.

Show Source

• caseType: string
  Maximum Length: 12

  Case Type defines the type of case.

  Example: BANKRUPT

{
    "type":"object",
    "description":"Case Type defines the type of case.",
    "properties":{
        "caseType":{
            "type":"string",
            "maxLength":12,
            "description":"Case Type defines the type of case.",
            "example":"BANKRUPT"
        }
    }
}

Nested Schema : characteristics

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":"Sequence Number",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                        "example":"FKV"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks."
                    }
                }
            }
        }
    }
}

Nested Schema : contactInformation

Type: object

Show Source

• callBackPhoneNumber: string
  Maximum Length: 24

  Callback Phone Number indicate the actual phone number

  Example: [phone]
• callBackPhoneType: string
  Maximum Length: 12

  Callback Phone Type indicate the actual phone type

  Example: CAMP
• contactInstructions: string
  Maximum Length: 2000

  Contact Instructions indicates any special instructions indicated for when or how to return a call.

  Example: Only in Day
• contactPerson: object contactPerson
  Contact Person references the person who should be contacted.
• extension: string
  Maximum Length: 6

  1234
• preferredContactMethod: string
  Allowed Values: [ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]

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

  Example: FAX

{
    "type":"object",
    "properties":{
        "contactPerson":{
            "type":"object",
            "description":"Contact Person references the person who should be contacted.",
            "properties":{
                "contactPersonId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Contact Person"
                }
            }
        },
        "preferredContactMethod":{
            "type":"string",
            "enum":[
                "C1PC",
                "EM  ",
                "FAX ",
                "N/A ",
                "PH  ",
                "POST",
                "SMS "
            ],
            "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
            "example":"FAX"
        },
        "contactInstructions":{
            "type":"string",
            "maxLength":2000,
            "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
            "example":"Only in Day"
        },
        "callBackPhoneType":{
            "type":"string",
            "maxLength":12,
            "description":"Callback Phone Type indicate the actual phone type",
            "example":"CAMP"
        },
        "callBackPhoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Callback Phone Number indicate the actual phone number",
            "example":"[phone]"
        },
        "extension":{
            "type":"string",
            "maxLength":6,
            "description":"1234"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

  Person ID references the person associated with this case.

  Example: 0003339882

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID references the person associated with this case.",
            "example":"0003339882"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID references the premise associated with this case.

  Example: 0005606666

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID references the premise associated with this case.",
            "example":"0005606666"
        }
    }
}

Nested Schema : responsibleUser

Type: object

Show Source

• userId: string
  Maximum Length: 8

  User

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

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":"Sequence Number",
                "example":"10"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                "example":"FKV"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number

  Example: 10
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number",
            "example":"10"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
            "example":"FKV"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

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

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : contactPerson

Type: object

Contact Person references the person who should be contacted.

Show Source

• contactPersonId: string
  Maximum Length: 10

  Contact Person

{
    "type":"object",
    "description":"Contact Person references the person who should be contacted.",
    "properties":{
        "contactPersonId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Person"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• account: object account
• caseCondition: string
  Allowed Values: [ "CLSD", "OPEN" ]

  Case Condition * `CLSD` - Closed, * `OPEN` - Open

  Example: OPEN
• caseId: string
  Maximum Length: 10

  Case ID is the system-assigned unique identifier of the case.

  Example: 1118286467
• caseType: object caseType
  Case Type defines the type of case.
• characteristics: object characteristics
• comments: string
  Maximum Length: 2000

  Comments can be used to describe anything interesting or unusual about the case.

  Example: new Test
• contactDetail: string
  Maximum Length: 10

  System-assigned, unique identifier of the person contact record.
• contactInformation: object contactInformation
• isEligibleForArchiving: boolean
  ILM Archive Switch
• person: object person
• premise: object premise
• responsibleUser: object responsibleUser
• status: string
  Maximum Length: 12

  Status shows the current state of the case.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "caseId":{
            "type":"string",
            "maxLength":10,
            "description":"Case ID is the system-assigned unique identifier of the case.",
            "example":"1118286467"
        },
        "caseType":{
            "type":"object",
            "description":"Case Type defines the type of case.",
            "properties":{
                "caseType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Case Type defines the type of case.",
                    "example":"BANKRUPT"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status shows the current state of the case.",
            "example":"NEW"
        },
        "comments":{
            "type":"string",
            "maxLength":2000,
            "description":"Comments can be used to describe anything interesting or unusual about the case.",
            "example":"new Test"
        },
        "person":{
            "type":"object",
            "properties":{
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID references the person associated with this case.",
                    "example":"0003339882"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID references the account associated with this case.",
                    "example":"0777774590"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID references the premise associated with this case.",
                    "example":"0005606666"
                }
            }
        },
        "responsibleUser":{
            "type":"object",
            "properties":{
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "caseCondition":{
            "type":"string",
            "enum":[
                "CLSD",
                "OPEN"
            ],
            "description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open",
            "example":"OPEN"
        },
        "contactInformation":{
            "type":"object",
            "properties":{
                "contactPerson":{
                    "type":"object",
                    "description":"Contact Person references the person who should be contacted.",
                    "properties":{
                        "contactPersonId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Contact Person"
                        }
                    }
                },
                "preferredContactMethod":{
                    "type":"string",
                    "enum":[
                        "C1PC",
                        "EM  ",
                        "FAX ",
                        "N/A ",
                        "PH  ",
                        "POST",
                        "SMS "
                    ],
                    "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
                    "example":"FAX"
                },
                "contactInstructions":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
                    "example":"Only in Day"
                },
                "callBackPhoneType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Callback Phone Type indicate the actual phone type",
                    "example":"CAMP"
                },
                "callBackPhoneNumber":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Callback Phone Number indicate the actual phone number",
                    "example":"[phone]"
                },
                "extension":{
                    "type":"string",
                    "maxLength":6,
                    "description":"1234"
                }
            }
        },
        "isEligibleForArchiving":{
            "type":"boolean",
            "description":"ILM Archive Switch"
        },
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"System-assigned, unique identifier of the person contact record."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number",
                                "example":"10"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                                "example":"FKV"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-Case"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID references the account associated with this case.

  Example: 0777774590

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID references the account associated with this case.",
            "example":"0777774590"
        }
    }
}

Nested Schema : caseType

Type: object

Case Type defines the type of case.

Show Source

• caseType: string
  Maximum Length: 12

  Case Type defines the type of case.

  Example: BANKRUPT

{
    "type":"object",
    "description":"Case Type defines the type of case.",
    "properties":{
        "caseType":{
            "type":"string",
            "maxLength":12,
            "description":"Case Type defines the type of case.",
            "example":"BANKRUPT"
        }
    }
}

Nested Schema : characteristics

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":"Sequence Number",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                        "example":"FKV"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks."
                    }
                }
            }
        }
    }
}

Nested Schema : contactInformation

Type: object

Show Source

• callBackPhoneNumber: string
  Maximum Length: 24

  Callback Phone Number indicate the actual phone number

  Example: [phone]
• callBackPhoneType: string
  Maximum Length: 12

  Callback Phone Type indicate the actual phone type

  Example: CAMP
• contactInstructions: string
  Maximum Length: 2000

  Contact Instructions indicates any special instructions indicated for when or how to return a call.

  Example: Only in Day
• contactPerson: object contactPerson
  Contact Person references the person who should be contacted.
• extension: string
  Maximum Length: 6

  1234
• preferredContactMethod: string
  Allowed Values: [ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]

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

  Example: FAX

{
    "type":"object",
    "properties":{
        "contactPerson":{
            "type":"object",
            "description":"Contact Person references the person who should be contacted.",
            "properties":{
                "contactPersonId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Contact Person"
                }
            }
        },
        "preferredContactMethod":{
            "type":"string",
            "enum":[
                "C1PC",
                "EM  ",
                "FAX ",
                "N/A ",
                "PH  ",
                "POST",
                "SMS "
            ],
            "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
            "example":"FAX"
        },
        "contactInstructions":{
            "type":"string",
            "maxLength":2000,
            "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
            "example":"Only in Day"
        },
        "callBackPhoneType":{
            "type":"string",
            "maxLength":12,
            "description":"Callback Phone Type indicate the actual phone type",
            "example":"CAMP"
        },
        "callBackPhoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Callback Phone Number indicate the actual phone number",
            "example":"[phone]"
        },
        "extension":{
            "type":"string",
            "maxLength":6,
            "description":"1234"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• personId: string
  Maximum Length: 10

  Person ID references the person associated with this case.

  Example: 0003339882

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID references the person associated with this case.",
            "example":"0003339882"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

• premiseId: string
  Maximum Length: 10

  Premise ID references the premise associated with this case.

  Example: 0005606666

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID references the premise associated with this case.",
            "example":"0005606666"
        }
    }
}

Nested Schema : responsibleUser

Type: object

Show Source

• userId: string
  Maximum Length: 8

  User

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

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":"Sequence Number",
                "example":"10"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                "example":"FKV"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number

  Example: 10
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number",
            "example":"10"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
            "example":"FKV"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

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

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : contactPerson

Type: object

Contact Person references the person who should be contacted.

Show Source

• contactPersonId: string
  Maximum Length: 10

  Contact Person

{
    "type":"object",
    "description":"Contact Person references the person who should be contacted.",
    "properties":{
        "contactPersonId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Person"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-Case

Type: object

Show Source

• _self: string
  _self
• account: object account
• caseCondition: string
  Allowed Values: [ "CLSD", "OPEN" ]

  Case Condition * `CLSD` - Closed, * `OPEN` - Open

  Example: OPEN
• caseId: string
  Maximum Length: 10

  Case ID is the system-assigned unique identifier of the case.

  Example: 1118286467
• caseType: object caseType
  Case Type defines the type of case.
• characteristics: object characteristics
• comments: string
  Maximum Length: 2000

  Comments can be used to describe anything interesting or unusual about the case.

  Example: new Test
• contactDetail: string
  Maximum Length: 10

  System-assigned, unique identifier of the person contact record.
• contactInformation: object contactInformation
• isEligibleForArchiving: boolean
  ILM Archive Switch
• person: object person
• premise: object premise
• responsibleUser: object responsibleUser
• status: string
  Maximum Length: 12

  Status shows the current state of the case.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "caseId":{
            "type":"string",
            "maxLength":10,
            "description":"Case ID is the system-assigned unique identifier of the case.",
            "example":"1118286467"
        },
        "caseType":{
            "type":"object",
            "description":"Case Type defines the type of case.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "caseType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Case Type defines the type of case.",
                    "example":"BANKRUPT"
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status shows the current state of the case.",
            "example":"NEW"
        },
        "comments":{
            "type":"string",
            "maxLength":2000,
            "description":"Comments can be used to describe anything interesting or unusual about the case.",
            "example":"new Test"
        },
        "person":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Person ID references the person associated with this case.",
                    "example":"0003339882"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID references the account associated with this case.",
                    "example":"0777774590"
                }
            }
        },
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID references the premise associated with this case.",
                    "example":"0005606666"
                }
            }
        },
        "responsibleUser":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "userId":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                }
            }
        },
        "caseCondition":{
            "type":"string",
            "enum":[
                "CLSD",
                "OPEN"
            ],
            "description":"Case Condition\n* `CLSD` - Closed,\n* `OPEN` - Open",
            "example":"OPEN"
        },
        "contactInformation":{
            "type":"object",
            "properties":{
                "contactPerson":{
                    "type":"object",
                    "description":"Contact Person references the person who should be contacted.",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "contactPersonId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Contact Person"
                        }
                    }
                },
                "preferredContactMethod":{
                    "type":"string",
                    "enum":[
                        "C1PC",
                        "EM  ",
                        "FAX ",
                        "N/A ",
                        "PH  ",
                        "POST",
                        "SMS "
                    ],
                    "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
                    "example":"FAX"
                },
                "contactInstructions":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
                    "example":"Only in Day"
                },
                "callBackPhoneType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Callback Phone Type indicate the actual phone type",
                    "example":"CAMP"
                },
                "callBackPhoneNumber":{
                    "type":"string",
                    "maxLength":24,
                    "description":"Callback Phone Number indicate the actual phone number",
                    "example":"[phone]"
                },
                "extension":{
                    "type":"string",
                    "maxLength":6,
                    "description":"1234"
                }
            }
        },
        "isEligibleForArchiving":{
            "type":"boolean",
            "description":"ILM Archive Switch"
        },
        "contactDetail":{
            "type":"string",
            "maxLength":10,
            "description":"System-assigned, unique identifier of the person contact record."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number",
                                "example":"10"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                                "example":"FKV"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks."
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-Case"
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID references the account associated with this case.

  Example: 0777774590

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID references the account associated with this case.",
            "example":"0777774590"
        }
    }
}

Nested Schema : caseType

Type: object

Case Type defines the type of case.

Show Source

• _link: string
  _link
• caseType: string
  Maximum Length: 12

  Case Type defines the type of case.

  Example: BANKRUPT

{
    "type":"object",
    "description":"Case Type defines the type of case.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "caseType":{
            "type":"string",
            "maxLength":12,
            "description":"Case Type defines the type of case.",
            "example":"BANKRUPT"
        }
    }
}

Nested Schema : characteristics

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":"Sequence Number",
                        "example":"10"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                        "example":"FKV"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks."
                    }
                }
            }
        }
    }
}

Nested Schema : contactInformation

Type: object

Show Source

• callBackPhoneNumber: string
  Maximum Length: 24

  Callback Phone Number indicate the actual phone number

  Example: [phone]
• callBackPhoneType: string
  Maximum Length: 12

  Callback Phone Type indicate the actual phone type

  Example: CAMP
• contactInstructions: string
  Maximum Length: 2000

  Contact Instructions indicates any special instructions indicated for when or how to return a call.

  Example: Only in Day
• contactPerson: object contactPerson
  Contact Person references the person who should be contacted.
• extension: string
  Maximum Length: 6

  1234
• preferredContactMethod: string
  Allowed Values: [ "C1PC", "EM ", "FAX ", "N/A ", "PH ", "POST", "SMS " ]

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

  Example: FAX

{
    "type":"object",
    "properties":{
        "contactPerson":{
            "type":"object",
            "description":"Contact Person references the person who should be contacted.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "contactPersonId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Contact Person"
                }
            }
        },
        "preferredContactMethod":{
            "type":"string",
            "enum":[
                "C1PC",
                "EM  ",
                "FAX ",
                "N/A ",
                "PH  ",
                "POST",
                "SMS "
            ],
            "description":"Preferred Contact Method indicates how the person prefers to be contacted.\n* `C1PC` - Person Contact,\n* `EM  ` - Email,\n* `FAX ` - Fax,\n* `N/A ` - Not Applicable,\n* `PH  ` - Phone,\n* `POST` - Postal,\n* `SMS ` - SMS",
            "example":"FAX"
        },
        "contactInstructions":{
            "type":"string",
            "maxLength":2000,
            "description":"Contact Instructions indicates any special instructions indicated for when or how to return a call.",
            "example":"Only in Day"
        },
        "callBackPhoneType":{
            "type":"string",
            "maxLength":12,
            "description":"Callback Phone Type indicate the actual phone type",
            "example":"CAMP"
        },
        "callBackPhoneNumber":{
            "type":"string",
            "maxLength":24,
            "description":"Callback Phone Number indicate the actual phone number",
            "example":"[phone]"
        },
        "extension":{
            "type":"string",
            "maxLength":6,
            "description":"1234"
        }
    }
}

Nested Schema : person

Type: object

Show Source

• _link: string
  _link
• personId: string
  Maximum Length: 10

  Person ID references the person associated with this case.

  Example: 0003339882

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID references the person associated with this case.",
            "example":"0003339882"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

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

  Premise ID references the premise associated with this case.

  Example: 0005606666

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID references the premise associated with this case.",
            "example":"0005606666"
        }
    }
}

Nested Schema : responsibleUser

Type: object

Show Source

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

  User

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

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":"Sequence Number",
                "example":"10"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
                "example":"FKV"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence Number

  Example: 10
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.

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

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number",
            "example":"10"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Type of Characteristic Value indicates whether the characteristic type value is Adhoc, Predefined, Foreign Key, or a File/URL Location.",
            "example":"FKV"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks."
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

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

  Characteristic Type

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

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : contactPerson

Type: object

Contact Person references the person who should be contacted.

Show Source

• _link: string
  _link
• contactPersonId: string
  Maximum Length: 10

  Contact Person

{
    "type":"object",
    "description":"Contact Person references the person who should be contacted.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "contactPersonId":{
            "type":"string",
            "maxLength":10,
            "description":"Contact Person"
        }
    }
}

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