Step 2 : Ornament ID (OID)
| POST | {URL}/getOID.aspx | ||||
| Parameters : | |||||
| Form Data in JSON format with the following values : | |||||
| Values In | JSON field | Field Name | Type | Field Description | Pairing/Sets |
| Single | token | Token | Aplhanumeric | The TOKEN (recd.) post Authentication | - |
| Single | id | Item Id | Aplhanumeric | Your Item Code/Bar Code - Unique to your system | - |
| Single | name | Item Name | Aplhanumeric | Description of the Item example "Necklace", "L. Ring" | - |
| Single | grosswt | Gros Wt | Numeric | Gross Wt. of the Jewellery | - |
| Multiples | wt | Metal Wt | Numeric | Metal Wt. of the Jewellery | metaldetails |
| Multiples | unitofwt | Unit of Metal Wt | Alphanumeric | Grams / Ct. | metaldetails |
| Multiples | type | Metal Type | Alphanumeric | Metal used for Jewellery | metaldetails |
| Multiples | purity | Purity | Alphanumeric | Metal Purity | metaldetails |
| Single | hallmarked | Hallmarked | Yes / No | Is the Jewellery Hallmarked | - |
| Multiples | name | Stone Name | Alphanumeric | Colour Stone Name | stonedetails |
| Multiples | properties | Stone Properties | Alphanumeric | Colour Stone Details, example for Diamonds : Cut, Colour, Clarity | stonedetails |
| Multiples | wt | Stone Wt | Numeric | Colour Stone Wt. | stonedetails |
| Multiples | unitofwt | Unit of Stone Wt. | Alphanumeric | Grams / Ct. | stonedetails |
| Multiples | stonecnt | Stone Count | Numeric | Colour Stone Count (Number) | stonedetails |
| Multiples | certified | Stone Certified | Yes / No | Is the Stone Certified | stonedetails |
| Multiples | cert_by | Stone Certified By | Alphanumeric | Certified By Authority name | stonedetails |
| Multiples | cert_no | Stone Certificate No | Alphanumeric | Certificate Number | stonedetails |
| Multiples | cert_dt | Stone Certificate Date | Date | Certificate Date (YYYY-MM-DD) | stonedetails |
| Multiples | name | Decorative Item Name | Alphanumeric | Description/Name of the Decorative Items used | decovativeitem |
| Multiples | wt | Decorative Item Wt | Numeric | Decorative Items Wt. | decovativeitem |
| Multiples | unitofwt | Unit of Decorative Item | Alphanumeric | Grams / Ct. | decovativeitem |
| Multiples | certified | Certified | Yes / No | Is the Jewellery Certified | jewellerycertificatedetails |
| Multiples | number | Certificate No | Alphanumeric | Certificate Number | jewellerycertificatedetails |
| Multiples | dt | Certificate Date | Date | Certificate Date (YYYY-MM-DD) | jewellerycertificatedetails |
| Multiples | by | Certified By | Alphanumeric | Certified By Authority name | jewellerycertificatedetails |
| Single | inv_no | Invoice No | Alphanumeric | Invoice No. of the Jeweller (Bill No.) | - |
| Single | inv_dt | Invoice Date | Date | Invoice Date of the Jeweller (Bill Date) (YYYY-MM-DD) | - |
| Single | inv_itemsrno | Invoice Item SrNo | Numeric | Item referred to on Invoice | - |
| Single | cust_name | Customer Name | Alphanumeric | Jewellery Insured for (name of the Customer) | - |
| Single | cust_email | Customer Email | Alphanumeric | Customer Contact Details : Email address | - |
| Single | cust_mobile | Customer Mobile | Alphanumeric | Customer Contact Details : Mobile number | - |
| Single | inv_amt | Jewellery Amount | Numeric | Value of the Jewellery | - |
| Single | insurance | Insured For Amount | Numeric | Amount of Insurance covering this Jewellery | - |
| Parameters : JSON format (example) POST {URL}/getOID.aspx Content-Type application/json | |||||
{
"token": "TOKEN_RECD_POST_AUTH",
"id": "NS0012",
"name": "Necklace",
"grosswt": "25.500",
"metaldetails": [
{
"wt": "21.000",
"unitofwt": "gms",
"type": "Gold",
"purity": "22k"
},
{
"wt": "2.000",
"unitofwt": "gms",
"type": "Gold",
"purity": "18k"
}
],
"hallmarked": "yes",
"stonedetails": [
{
"name": "Ruby",
"properties": "colour : red",
"wt": "2.000",
"unitofwt": "gms",
"stonecnt": "3",
"certified": "yes",
"cert_by": "IGI, Mumbai",
"cert_no": "STONE00001",
"cert_dt": "2016-03-16"
},
{
"name": "Diamonds",
"properties": "colour : white, cut : Excellent, clarity : vvs2",
"wt": "2.500",
"unitofwt": "cts",
"stonecnt": "0",
"certified": "no",
"cert_by": "",
"cert_no": "",
"cert_dt": ""
}
],
"decovativeitem": [
{
"name": "thread",
"wt": "2.000",
"unitofwt": "gms"
}
],
"jewellerycertificatedetails": [
{
"certified": "yes",
"number": "IGIM00001",
"dt": "2016-04-25",
"by": "IGI, Mumbai, IN"
}
],
"inv_no": "INV#12345",
"inv_dt": "2017-03-15",
"inv_itemsrno": "1",
"cust_name": "Customer Name here",
"cust_email": "customer@email.com",
"cust_mobile": "9876543210",
"inv_amt": "10000",
"insurance": "10000"
}
| |||||
| Returns : JSON format (example) RESPONSE | |||||
{
"result" : "0",
"OID" : "OID-Sample-"
}
| |||||
| Return Parameters (Success) : RESPONSE | |||||
| Field | Type | Description | |||
| result | String | Message. "0" = No Errors. | |||
| OID | String | OID value for usage in next steps | |||