Description
This AWS API allows you to create, edit, and delete a mapping of the Copart API Key to the Seller Code & Insurance Carrier. The Dynamo Table that is being used for this mapping in AWS is Named: IntegrationIdMapping.
| Service Name | integration-mapping |
| Service Type | REST |
| Method | POST, PUT, DELETE |
| UAT (Sandbox) URL | https://oe3bc3v1u0.execute-api.us-east-1.amazonaws.com/dev/integration-mapping |
| Production URL | https://ls6td4kv4l.execute-api.us-east-1.amazonaws.com/dev/integration-mapping |
Table of Contents
API Request
Flow
- Use Hi Marley API keys to execute the API.
- In the Hi Marley Customer Support Collection this is already set.
- POST, PUT, DELETE requests can be verified by checking the IntegrationIdMapping table in Dynamo.
Request Example
https://oe3bc3v1u0.execute-api.us-east-1.amazonaws.com/dev/integration-mapping
Request Body Breakdown
| Property | Values | Description |
Type |
Required | Example | Validation |
|
APIKey
|
The Copart API Key. | string |
true |
Static Copart API Key Value |
|
|
|
IntegrationId
|
The Copart Seller Code. | string |
true |
copart1 | ||
|
Adjuster
|
The Adjuster attached to the Copart Seller Code. They will be auto tagged on the Note & be added as a secondary Operator on the Total Loss Case. If the Copart Seller Code does not map to a single Adjuster then do not pass this property in the Mapping/POST request. |
false |
amy.tester@insurance.com | |||
|
Config
|
AssignmentStrategy |
This controls if the adjuster in the Copart payload is added as a Secondary Operator. Only value is 'DISABLED'. |
enum |
false |
"AssignmentStrategy": "DISABLED" |
|
| NoteMention |
This Controls if the Note Mention tags a User. Only value is 'DISABLED'. |
enum |
false |
"NoteMention": "DISABLED" |
||
| DataCaptureOnly |
Allows a Seller Code to be "on" and we can validate data/match rate without any system updates. Set to false if going from DataCaptureOnly to full integration. |
boolean |
false |
"DataCaptureOnly": true |
||
| BaseClaim |
Regex filtering on Base Claim number. Regex Notes:
|
string (regex) |
false |
"BaseClaim": "(/w+)" |
||
|
OrganizationId
|
The Carrier ID. | string |
true |
jdn572n-3995-4aa2-b9e2-673549kb |
||
|
OrganizationName
|
The Carrier Name. | string |
true |
America Insurance |
Customer wants to always add a specific user/email as a secondaryOperator:
{
"APIKey": "copartApiKey", //Always this Key.(Copart Key)
"IntegrationId": "{{SELLER_CODE}}", //Seller Code to Listen to for the Carrrier.
"Adjuster": "adjuster@email.com"
"OrganizationId": "ORG_ID", //ex:- Plymouth org Id
"OrganizationName": "ORG_NAME" //ex:- Plymouth org name
}
Customer wants to assign the tla adjuster as the secondaryOperator (role = assignment in copart payload):
{
"APIKey": "copartApiKey", //Always this Key.(Copart Key)
"IntegrationId": "{{SELLER_CODE}}", //Seller Code to Listen to for the Carrrier.
"OrganizationId": "ORG_ID", //ex:- Plymouth org Id
"OrganizationName": "ORG_NAME" //ex:- Plymouth org name
}
Customer wants nobody added as a secondaryOperator:
{
"APIKey": "copartApiKey", //Always this Key.(Copart Key)
"IntegrationId": "{{SELLER_CODE}}", //Seller Code to Listen to for the Carrrier.
"Config": { //Optional Property. Only added to disable; DISABLED is the only value for each.
"AssignmentStrategy": "DISABLED", //This controls if the Adjuster in the Copart payload is added as a Secondary Operator
},
"OrganizationId": "ORG_ID", //ex:- Plymouth org Id
"OrganizationName": "ORG_NAME" //ex:- Plymouth org name
}
Comments
0 comments
Please sign in to leave a comment.