How Can We Help?
Attachment API
| Attachment API |
| Attachment 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 |
| Attachment 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 Attachment 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 |
| Attachment 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 Attachment Json |
| JSON Fields | UX field | Description |
| State
List GetRestrictions additionalParams |
Attachment List details | Attachment information . |
| Priority
direction |
Attachment sort details | Attachment sort information. |
| Value
label |
Attachment select options | Attachment select information. |
| Type
selectOptions |
Attachment filter details | Attachment filter information. |
| Name | Columnn name | Column name. |
| filterHeaderTemplate | Filter header template | Gets or sets the filter header template. |
| displayName | Display name | Display name information. |
| Visible | Visible | Gets or sets a value indicating whether this flag is true or not. |
| cellTemplate | Cell template | Stores the cell template information. |
| width | Width | Defines and stores the width of the column. |
| minWidth | Minimum width | Defines and stores the minimum width of the column. |
| sort | Sort | Sort information. |
| type | Type | Type information. |
| enableHiding | Enable Hiding Flag | Gets or sets a value indicating whethefr this flag is true or not. |
| enableColumnMoving | Enable Column Moving | Gets or sets a value indicating whether this flag is true or not. |
| enableColumnResizing | Enable Column Resizing | Gets or sets a value indicating whether this flag is true or not. |
| filter | Filter | Defines the filter. |
| enableSorting | Enable Sorting | Enable Sorting flag to decide whether to enable sorting or not. |
| columns | Columns | Defines and store the column information. |
| FolderId
ParentId FolderName Children |
The New Folder details | Information required for the folder. |
| Id
UserName FirstName LastName |
The user details | Information required for the user. |
| IsFolder | Is folder flag | Gets or sets a value indicating whether this instance is folder. |
| Document_id | Document identifier | Defines and stores the document identifier. |
| Create_Date | Create date | The date attachment is created. |
| Document_Name
Document_Filename Document_subject Document_type iDocument_type Document_type_shortCode Notes User_ID Document_filepath |
Document details | Information regarding the document to be attached. |
| Folder_Id | Folder identifier | Represent the parent folder of Attachment |
| Keywords | Keywords | Keywords |
| Document_Class | Document Class | Document class information. |
| iDocument_Class | iDocument Class | iDocument Class information. |
| Document_class_shortCode | Document class shortCode | To store the Document class shortCode |
| Document_Category | Document Category | To store the document category. |
| iDocument_Category | iDocuement Category | To store the iDocument Category |
| Document_category_shortCode | Document category shortCode | To store the Document category shortCode |
| Doc_Internal_Type | Documnet Internal Type | To store the type of the document internal. |
| Upload_Status | Upload Status | To store the upload status information. |
| AttachTable | Attach table | To store the attach table information. |
| AttachRecordId
Title Subject Filesize Filesize ViewTemplates AttachTableName |
Attached record details | To store the attach record identifier. |
| ClaimID
ClaimantID ClaimNumber ClaimDate ClaimStatusDesc ClaimTypeCode LOB ClaimantName |
Claim details | Claim details of the attachment. |
| fileDescription | File Description | To store the document description. |
| Document_Pages | Document Pages | To store the number of the document pages. |
| EventNumber
EventID LOB NewRecord objClaimList SelectEvent |
Event details | To store the event information. |
| PolicyID | Policy identifier | Policy Identifier. |
| ImageUrl
PageNmber HtmlContent |
Image details | To store the information regarding image. |
