How Can We Help?
Diaries API
| Diaries API |
| Diaries Get |
| Request | |
| URL | http{s}:// { server name }/riskmasterapi/{ Formname }/{clamid}/reserves/{rcrowid}/transactiontype/{paymenttype}/transaction/{transid} |
| Method | HTTPGET |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
 |
application/json Returns a response data with HATEOS |
 |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
 |
Forbidden Access |
| Description | Server name, the IP or machine name of rmA application server. Rcrowid, rc row id of the reserve selected on which payment is to be made Formname, claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid, claim id of claim record from CLAIM table. Paymenttype, if it is payment,collection or manual deductible |
| Diaries Create |
| Request | |
| URL | http{s}://{server name}/riskmasterapi/{formname}/{claimid}/transaction |
| Method | TPPOST |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name, the IP or machine name of rmA application server. Formname, claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid, claim id of claim record from CLAIM table. |
| Mandatory fields for Diaries Create |
| Fields in JSON | Description | Sample data |
| accountId | Bank account | 62 |
| lastName | Payee Last name | D&R Reporting And Video, Inc. |
| amount | Total of all split amounts in base currency | 2.0 |
| claimantEid | Claimant involved on financial key of payment | 3752 |
| claimCurrencyAmount | Total of split claim currency amount | 2.0 |
| dstrbnType | Distribution Type | “id”:45213,
“shortCode”:”RML”, “desc”:”Regular Mail”, “codeTable”:”DISTRIBUTION_TYPE” |
| payeeTypeCode | Payee Type | “id”:466,
“shortCode”:”C”, “desc”:”Claimant”, “codeTable”:”PAYEE_TYPE” |
| pmtCurrencyAmount | Total of split payment currency amount | 2.0 |
| pmtCurrencyType | Currency of the payment | “id”:44327,
“shortCode”:”USD”, “desc”:”United States|en-US”, “codeTable”:”CURRENCY_TYPE” |
| policyCurrencyAmount | Total of split policy currency amount | 2.0 |
| transDate | Transaction date | 10/16/2017 |
| splitRcRowID | Reserve id on which split is created. Used for carrier payment | 0 |
| claimId | Claim id | 6656 |
| splitCvgLossID | Loss type applied on coverage | 0 |
| splitResTypeCode | Reserve type applied on split | 368 |
| splitResSubTypeCode | Reserve sub type applied on split | 45919 |
| splitPolCvgID | Key of policy_X_cvg_type table applied on split | 0 |
| splitPolicyID | Policy applied on split | 0 |
| rcRowId | Reserve id on which split is created | 1927 |
| claimCurrencyAmount | Claim currency amount of split | 2.0 |
| sumAmount | Amount of split | 2.0 |
| cmbTransactionType | Transaction type of split | 5410 |
| isFirstFinal | True if first and final split | false |
| policyCurrencyAmount | Policy currency amount of split | 2.0 |
| Diaries Save |
| Request | |
| URL | http{s}://{server name}/riskmasterapi/{formname}/{claimid}/transaction |
| Method | HTTPPUT |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name: the IP or machine name of rmA application server. Formname: claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid: claim id of claim record from CLAIM table. |
| Data Dictionary for Diaries Json |
| JSON Fields | UX field | Description |
| Key
Count tasks |
Diary count identities | To store the diaries count. |
| recordId
attachRecord taskName entryId lob |
Diary task details | Information regarding fill up of the diaries tasks. |
| EntryID | Entry identifier | Diary details. |
| EntryName | Entry Name | Diary details. |
| State
List GetRestrictions Additionalparams Priority_text Code isBESEnabled dateformat |
Diary information | Diary details. |
| Date
LoginName PrintCalendarList |
Print diary calender information | Diary details. |
| Priority
TimeDue TimeEstimated TaskName Regarding |
Print diary calender list information | Diary details. |
| Message
Type ErrorCode |
API messages | API messages |
| List
AdditionalParams State UserPref |
Diary History information | Diary History
information |
| Name
displayName fieldType Selected defaultName |
Supplemental model | Supplemental model details. |
