Jump to

• Request
• Response

Get Collection Process

get

https://server:port/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}

Request

Path Parameters

• collectionProcessId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1CollProces

Type: object

Show Source

• _self: string
  _self
• account: object account
• calculationDateUsingDaysInArrears: number
  Minimum Value: -999

  Maximum Value: 999

  Defines the age of the arrears in number of days which can be used by the system to calculate the severance amount base date.
• collectionAmountBaseDate: string (date)
  Arrears Date is the date the event starts aging.
• collectionClassControl: object collectionClassControl
  Collection Class Control defines the debt class, which is the type of debt associated with the collection process.
• collectionConditionPriority: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]

  Collection Condition Priority * `10 ` - Priority 10 - Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 - Lowest

  Example: 10
• collectionProcessId: string
  Maximum Length: 10

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

  Example: 6799999999
• collectionProcessTemplate: object collectionProcessTemplate
  Collection Process Template defines the collection events in the process.
• collectionStatus: string
  Allowed Values: [ "10 ", "20 " ]

  Collection Status defines the state of the collection process. * `10 ` - Active, * `20 ` - Inactive

  Example: 10
• comments: string
  Maximum Length: 254

  Comments provide additional details about the collection process.
• creationDateTime: string (date-time)
  Creation Date/Time defines the start date/time of the collection process.

  Example: 2021-12-02T03:07:47-05:00
• currency: object currency
• events: object events
• priority: string
  Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "85 ", "90 " ]

  priority * `10 ` - Priority 10 -- Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `85 ` - Priority 85, * `90 ` - Priority 90 -- Lowest

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

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

  Example: 20
• SAs: object SAs
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "collectionProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Collection Process ID is the unique system-generated identifier for this collection process.",
            "example":"6799999999"
        },
        "collectionProcessTemplate":{
            "type":"object",
            "description":"Collection Process Template defines the collection events in the process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "collectionProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Collection Process Template defines the collection events in the process.",
                    "example":"NORMAL REGUL"
                }
            }
        },
        "collectionClassControl":{
            "type":"object",
            "description":"Collection Class Control defines the debt class, which is the type of debt associated with the collection process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "collectionClassControl":{
                    "type":"string",
                    "maxLength":20,
                    "description":"Collection Class Control defines the debt class, which is the type of debt associated with the collection process.",
                    "example":"RES - REGULATED"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "currency":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                }
            }
        },
        "collectionStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Collection Status defines the state of the collection process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"10"
        },
        "reason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Collection Status Reason defines how a collection process became Inactive or why a collection process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"20"
        },
        "collectionConditionPriority":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  ",
                "80  ",
                "90  "
            ],
            "description":"Collection Condition Priority\n* `10  ` - Priority 10 - Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `90  ` - Priority 90 - Lowest",
            "example":"10"
        },
        "priority":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  ",
                "80  ",
                "85  ",
                "90  "
            ],
            "description":"priority\n* `10  ` - Priority 10 -- Highest,\n* `20  ` - Priority 20,\n* `30  ` - Priority 30,\n* `40  ` - Priority 40,\n* `50  ` - Priority 50,\n* `60  ` - Priority 60,\n* `70  ` - Priority 70,\n* `80  ` - Priority 80,\n* `85  ` - Priority 85,\n* `90  ` - Priority 90 -- Lowest",
            "example":"10"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Creation Date/Time defines the start date/time of the collection process.",
            "example":"2021-12-02T03:07:47-05:00"
        },
        "collectionAmountBaseDate":{
            "type":"string",
            "format":"date",
            "description":"Arrears Date is the date the event starts aging."
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments provide additional details about the collection process."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "SAs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  "
                                ],
                                "description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "collectionAmount":{
                                "type":"number",
                                "description":"Total Bal"
                            }
                        }
                    }
                }
            }
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence"
                            },
                            "collectionEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"40"
                            },
                            "collectionEventType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "collectionEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Collection Event Type"
                                    }
                                }
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes the event.",
                                "example":"2022-01-01"
                            },
                            "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 completed the event.",
                                "example":"2021-12-02"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "eventCustomerContact":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "eventSequence":{
                                                    "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"
                                                },
                                                "customerContactInformation":{
                                                    "type":"string",
                                                    "maxLength":200,
                                                    "description":"Customer Contact Information"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "calculationDateUsingDaysInArrears":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Defines the age of the arrears in number of days which can be used by the system to calculate the severance amount base date."
        }
    },
    "xml":{
        "name":"C1CollProces"
    }
}

Nested Schema : account

Type: object

Show Source

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

  Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : collectionClassControl

Type: object

Collection Class Control defines the debt class, which is the type of debt associated with the collection process.

Show Source

• _link: string
  _link
• collectionClassControl: string
  Maximum Length: 20

  Collection Class Control defines the debt class, which is the type of debt associated with the collection process.

  Example: RES - REGULATED

{
    "type":"object",
    "description":"Collection Class Control defines the debt class, which is the type of debt associated with the collection process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "collectionClassControl":{
            "type":"string",
            "maxLength":20,
            "description":"Collection Class Control defines the debt class, which is the type of debt associated with the collection process.",
            "example":"RES - REGULATED"
        }
    }
}

Nested Schema : collectionProcessTemplate

Type: object

Collection Process Template defines the collection events in the process.

Show Source

• _link: string
  _link
• collectionProcessTemplate: string
  Maximum Length: 12

  Collection Process Template defines the collection events in the process.

  Example: NORMAL REGUL

{
    "type":"object",
    "description":"Collection Process Template defines the collection events in the process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "collectionProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Collection Process Template defines the collection events in the process.",
            "example":"NORMAL REGUL"
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        }
    }
}

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"
                    },
                    "collectionEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"40"
                    },
                    "collectionEventType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "collectionEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Collection Event Type"
                            }
                        }
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes the event.",
                        "example":"2022-01-01"
                    },
                    "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 completed the event.",
                        "example":"2021-12-02"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "eventCustomerContact":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "eventSequence":{
                                            "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"
                                        },
                                        "customerContactInformation":{
                                            "type":"string",
                                            "maxLength":200,
                                            "description":"Customer Contact Information"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : SAs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  "
                        ],
                        "description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "collectionAmount":{
                        "type":"number",
                        "description":"Total Bal"
                    }
                }
            }
        }
    }
}

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"
            },
            "collectionEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "30  ",
                    "40  "
                ],
                "description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"40"
            },
            "collectionEventType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "collectionEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Collection Event Type"
                    }
                }
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes the event.",
                "example":"2022-01-01"
            },
            "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 completed the event.",
                "example":"2021-12-02"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "eventCustomerContact":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "eventSequence":{
                                    "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"
                                },
                                "customerContactInformation":{
                                    "type":"string",
                                    "maxLength":200,
                                    "description":"Customer Contact Information"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• collectionEventStatus: string
  Allowed Values: [ "10 ", "30 ", "40 " ]

  Collection Event Status defines the state of the event. * `10 ` - Pending, * `30 ` - Completed, * `40 ` - Canceled

  Example: 40
• collectionEventType: object collectionEventType
• completionDate: string (date)
  If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.

  Example: 2021-12-02
• eventCustomerContact: object eventCustomerContact
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• triggerDate: string (date)
  The Trigger Date defines the date when the system completes the event.

  Example: 2022-01-01
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence"
        },
        "collectionEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "30  ",
                "40  "
            ],
            "description":"Collection Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"40"
        },
        "collectionEventType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "collectionEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Collection Event Type"
                }
            }
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes the event.",
            "example":"2022-01-01"
        },
        "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 completed the event.",
            "example":"2021-12-02"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "eventCustomerContact":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "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"
                            },
                            "customerContactInformation":{
                                "type":"string",
                                "maxLength":200,
                                "description":"Customer Contact Information"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : collectionEventType

Type: object

Show Source

• _link: string
  _link
• collectionEventType: string
  Maximum Length: 12

  Collection Event Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "collectionEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Collection Event Type"
        }
    }
}

Nested Schema : eventCustomerContact

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"
                    },
                    "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"
                    },
                    "customerContactInformation":{
                        "type":"string",
                        "maxLength":200,
                        "description":"Customer Contact Information"
                    }
                }
            }
        }
    }
}

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"
            },
            "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"
            },
            "customerContactInformation":{
                "type":"string",
                "maxLength":200,
                "description":"Customer Contact Information"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• customerContact: object customerContact
• customerContactInformation: string
  Maximum Length: 200

  Customer Contact Information
• eventSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Event Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "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"
        },
        "customerContactInformation":{
            "type":"string",
            "maxLength":200,
            "description":"Customer Contact Information"
        }
    }
}

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":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "status":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  "
                ],
                "description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "collectionAmount":{
                "type":"number",
                "description":"Total Bal"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• collectionAmount: number
  Total Bal
• serviceAgreement: object serviceAgreement
• status: string
  Allowed Values: [ "10 ", "20 " ]

  Status: * `10 ` - Active, * `20 ` - Inactive
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Status:\n* `10  ` - Active,\n* `20  ` - Inactive"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "collectionAmount":{
            "type":"number",
            "description":"Total Bal"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

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

  Service Agreement

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

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