---
# System prepended metadata

title: Arkana V1.0.0

---

# Arkana V1.0.0

## Create Case

* Description:
  - This API is used to login, create a case, and create a URL that redirects to DE-Asia case information page.
* URL:
  - `/claim/shortcut`
* Method:
  - `POST`
* Headers:
  | Field | Require | Description |
  |-------|---------|-------------|
  | Content-Type | True | application/json |
  | Authorization | True | Basic Authentication RFC 7617 with username and password |
  | AppCode | True | DE provided application code |

* Payload: The payload is a json object with the following fields:

```
{ 
  /**
    * uuid from ZA Tech/Arkana
    * @type string
    * @required yes 
    */ 
  "ExternalId": "456",

  /**
    * vehicle information
    * @type object
    * @required yes
    */ 
  "Vehicle": { 
    /**
      * vehicle brand
      * @type string
      * @required yes\
      */ 
    "Brand": "Audi",

    /**
      * vehicle model. If series information is required for display purpose, please concatenate series with model information. 
      * @type string
      * @required yes
    */ 
    "Model": "A6 2011 On Sportback TFSI 122Bhp",

    /** 
      * License plate 
      * @type string 
      * @required yes
      */
    "LicensePlate": "456"
  }, 
  
  /**
    * Customer information
    * @type object
    * @required yes
    */ 
  "Customer": { 
    /**
      * Customer name
      * @type string
      * @required yes
      */ 
    "Name": "123",

    /** 
      * Customer phone number 
      * @type string 
      * @required yes
      */ 
    "PhoneNumber": "0612345678" 
  },

  /**
    * When customer completes damage assessment, use the callback information to report back the result
    * @type object
    * @required yes\
    */
  "Callback": { 
    /** 
      * Callback Url. Assume it is POST 
      * @type string 
      * @required yes
      */ 
    "Url": "123",

    /** 
      * Headers to include in the callback. It can include tokens and other information to pass back to ZA Tech/Arkana 
      * @type map[string]string 
      * @required yes
      */ 
      "Headers": { "SAMPLE-HEADER": "SAMPLE VALUE" }
  } 
}
```

* Response

```
  { 
    /** 
      * Case URL
      * @type string 
      * @required yes
      */
    "CaseUrl": "[https://domain/path](https://domain/path)" 
  } 
```

* Return Code:
  - 200: Success
  - 400: if provide wrong app_code
  - 403: if account & password is incorrect

---

## Write Back Damage Information

* Description:
  - DE-Asia will write back damage information to the end point of ZA Tech/Arkana provide (callback URL from `POST /claim/shortcut` ).
* Payload

```
{
  /**
    * uuid from ZA Tech/Arkana
    * @type object
    * @required yes
    */ 
  "ExternalId": "",

  "Vehicle": { 
    /**
      * vehicle brand
      * @type string
      * @required yes\
      */ 
    "Brand": "Audi",

    /**
      * vehicle model. If series information is required for display purpose, please concatenate series with model information. 
      * @type string
      *  @required yes
    */ 
    "Model": "A6 2011 On Sportback TFSI 122Bhp",

    /** 
      * License plate 
      * @type string 
      * @required yes
      */
    "LicensePlate": "456",

    /** 
      * Results of the damage analysis 
      * @type array of PartInfo object
      * @required yes
      */

    "Parts": [     
      {
        /** 
          * Internal part instance id 
          * @type int
          * @required yes
          */
        "Id": 990,

        /** 
          * Part type, please refer to the mapping table provided 
          * @type enumeration
          * @required yes
          */
        "PartType": 2,

        /** 
          * Part outline: polygon 
          * @type array of points 
          * @required yes
          */
        "Outline": [
          /** 
            * A point coordinate. Z is not used as we are in a 2D plane. 
            * @type object
            * @required yes
            */
          {
            "X": 396,
            "Y": 291,
            "Z": 0
          }
        ],

        /** 
          * Damage information 
          * @type array of DamageInfo
          * @required yes
          */

        "Damage": {
          /** 
            * Internal damage instance id 
            * @type int
            * @required yes
            */
          "Id": 990,
  
          /** 
            * Damage type, please refer to the mapping table provided 
            * @type enumeration
            * @required yes
            */
          "Type": 8,

          /** 
            * Damage outline: polygon 
            * @type array of points 
            * @required yes
            */
          "Outline": [
          /** 
            * A point coordinate. Z is not used as we are in a 2D plane. 
            * @type object
            * @required yes
            */
            {
              "X": 1080,
              "Y": 1781,
              "Z": 0
            }
          ],

          /** 
            * Image where the part and damage is found
            * @type object
            * @required yes
            */

          "Image": {
            /** 
              * Internal image instance id 
              * @type int
              * @required yes
              */
            "Id": 261,
            /** 
              * Image URL
              * @type string
              * @required yes
              */
            "URL": "https://zath-dea.dataenlighten.com/image/e5f80b4be408aa59e3f58b4c4f122166",

            /** 
              * Image Thumbnail URL
              * @type string
              * @required yes
              */
            "ThumbnailURL": "https://zath-dea.dataenlighten.com/image/1e867d7729f0d45d62bd0e66fe016228.jpg",

            /** 
              * Camera Angle. 
              * @type int
              * @required yes
              */
            "Angle": 6
          }
        }
      }
    ]
  }
  /** 
    * Status of the analysis. Please refer to the mapping table
    * @type enumeration. 
    * @required yes
    */
  "Status": 5,

  /** 
    * Status of the analysis. Please refer to the mapping table
    * @type enumeration. 
    * @required yes
    */
  "StatusAnalysis": 1,

  /**
    * Customer information
    * @type object
    * @required yes
    */ 
  "Customer": { 
    /**
      * Customer name
      * @type string
      * @required yes
      */ 
    "Name": "123",

    /** 
      * Customer phone number 
      * @type string 
      *  @required yes
      */ 
    "PhoneNumber": "0612345678" 
  },
  "Documents": []
}
```