API Docs - Info Lelang
API Information
|
Title |
Info Lelang |
|---|---|
|
Version |
v1.0 |
|
URL Sandbox |
|
|
URL Production |
https://sandbox.partner.api.bri.co.id/v1.0/info-lelang/set-booked |
Version Control
|
API Version |
Doc Version |
Date |
Link to document |
Description |
|---|---|---|---|---|
|
v1.0 |
v1.0.0 |
12 December 2023 |
This Page |
Baseline version. |
Product Description
Product Overview
The Auction Info API is a service that provides easy and quick access to the latest information about various auction assets in BRI. This API is designed to assist developers, companies in integrating auction data into their applications, websites or systems. With the Auction Info API, users can monitor, search, and get full details about available auctions, including date, location, type of item being auctioned, and auction status.
EndPoint
1. Detail Aset
Endpoint Description
Used to get information about auction asset details.
General Information
|
HTTP Method |
GET |
|---|---|
|
Path |
/v1.0/info-lelang/asset |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Query Param Request
|
Field |
Data Type |
Mandatory |
Length |
Description |
Example |
|---|---|---|---|---|---|
|
id |
Int |
M |
- | id asset |
|
Response Structure & Sample
|
Field |
Data Type |
Mandatory |
Length |
Description |
Example |
|---|---|---|---|---|---|
|
responseCode |
String |
M |
|
||
| responseMessage |
String |
M |
|
||
| responseData | Any | M | Object, NULL |
responseData -> DetailAsset
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the asset detail |
| formType |
String |
M |
Varchar | Type of the form |
| tagHotdealDesc | String | M | Varchar | Description of the hot deal tag |
| tagCleanDesc | String | M | Varchar | Description of the clean tag |
| tagHotdeal | int | M | Number | Hot deal tag value |
| tagClean | int | M | Number | Clean tag value |
| type | string | M | Varchar | Type of the asset |
| kpknlId | int64 | M | Number | ID of the KPKNL |
| auctionDate | string | M | Varchar | Date of the auction |
| auctionTime | string | M | Varchar | Time of the auction |
| auctionLink | string | M | Varchar | Link to the auction |
| categoryId | int64 | M | Number | ID of the category |
| subCategoryId | int64 | M | Number | ID of the subcategory |
| name | string | M | Varchar | Name of the asset |
| price | float64 | M | Double | Current price of the asset |
| priceBefore | float64 | M | Double | Price before any discounts |
| discountType | string | M | Varchar | Type of discount applied |
| discountNominal | float64 | M | Double | Nominal value of the discount |
| description | string | M | Varchar | Description of the asset |
| status | string | M | Varchar | Status of the asset |
| makerId | string | M | Varchar | ID of the maker |
| makerDesc | string | M | Varchar | Description of the maker |
| makerDate | string | M | Varchar | Date when the maker information was added |
| lastMakerId | string | M | Varchar | ID of the last maker |
| lastMakerDesc | string | M | Varchar | Description of the last maker |
| lastMakerDate | string | M | Varchar | Date when the last maker information was added |
| published | bool | M | Boolean | Whether the asset is published |
| deleted | bool | M | Boolean | Whether the asset is deleted |
| publishDate | *time.Time | M | Datetime | Date when the asset was published |
| expiredDate | *time.Time | M | Datetime | Expiry date of the asset |
| action | string | M | Varchar | Action taken on the asset |
| kpknlName | string | M | Varchar | Name of the KPKNL |
| categoryName | string | M | Varchar | Name of the category |
| subCategoryName | string | M | Varchar | Name of the subcategory |
| statusName | string | M | Varchar | Name of the status |
| addresses | AddressesResponse | M | Object | Addresses associated with the asset |
| buildingAssets | BuildingAssetsResponse | M | Object | Building assets details |
| vehicleAssets | VehicleAssetsResponse | M | Object | Vehicle assets details |
| facilities | []FacilitiesResponse | M | Array | List of facilities |
| accessPlaces | []AccessPlacesResponse | M | Array | List of access places |
| contacts | ContactsResponse | M | Object | Contact information |
| images | []ImagesResponses | M | Array | List of images |
| documentId | string | M | Varchar | ID of the document |
| updatedAt | *time.Time | M | Datetime | Last updated timestamp |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| sharedCount | int64 | M | Number | Number of times the asset was shared |
| views | int64 | M | Number | Number of views |
| soldAt | *time.Time | M | Datetime | Timestamp when the asset was sold |
| isSoldOut | bool | M | Boolean | Whether the asset is sold out |
| bookedStatus | bool | M | Boolean | Whether the asset is booked |
| bookedAt | *time.Time | M | Datetime | Timestamp when the asset was booked |
responseData -> DetailAsset ->AddressesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the asset detail |
| assetId | int64 |
M |
Number | ID of the asset |
| address | string | M | Varchar | Address text |
| longitude | string | M | Varchar | Longitude value |
| langitude | string | M | Varchar | Langitude value |
| latitude | string | M | Varchar | Latitude value |
| longLat | string | M | Varchar | Combined long and lat |
| postalcodeId | int64 | M | Number | ID of postal code |
| postalCode | string | M | Varchar | Postal Code |
| region | string | M | Varchar | Region name |
| district | string | M | Varchar | District name |
| city | string | M | Varchar | District name |
| city | string | M | Varchar | City name |
| province | string | M | Varchar | Province name |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
| longlati | string | M | Varchar | Optional longlati |
responseData -> DetailAsset ->Building Assets Response
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| buildYear | int64 | M | Number | Year the building was constructed |
| surfaceArea | int64 | M | Number | Surface area of the building |
| buildingArea | int64 | M | Number | Building area |
| direction | string | M | Varchar | Direction the building faces |
| numberOfFloors | int64 | M | Number | Number of floors in the building |
| numberOfBedrooms | int64 | M | Number | Number of bedrooms |
| numberOfBathrooms | int64 | M | Number | Number of bathrooms |
| electricalPower | int64 | M | Number | Electrical power capacity |
| carport | int64 | M | Number | Carport capacity |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
responseData -> DetailData ->VehicleAssetsResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| vehicleTypeId | int64 | M | Number | ID of the vehicle type |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| series | string | M | Varchar | Series of the vehicle |
| brandId | int64 | M | Number | ID of the brand |
| type | string | M | Varchar | Type of the vehicle |
| productionYear | string | M | Varchar | Production year of the vehicle |
| transmissionId | int64 | M | Number | ID of the transmission type |
| machineCapacityId | int64 | M | Number | ID of the machine capacity |
| colorId | int64 | M | Number | ID of the color |
| numberOfSeat | int64 | M | Number | Number of seats in the vehicle |
| numberOfUsage | string | M | Varchar | Usage count or details |
| machineNumber | string | M | Varchar | Number of the machine |
| bodyNumber | string | M | Varchar | Number of the body |
| licenceDate | string | M | Varchar | Date of the license |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| brandName | string | M | Varchar | Name of the brand |
| transmissionName | string | M | Varchar | Name of the transmission type |
| machineCapacityName | string | M | Varchar | Name of the machine capacity |
| colorName | string | M | Varchar | Name of the color |
| createdAt | string | M | Datetime | Created timestamp |
| updatedAt | string | M | Datetime | Updated timestamp |
responseData -> DetailAsset ->FacilitiesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the facility |
| name | string |
M |
Varchar | Name of the facility |
| icon | string | M | Varchar | Icon representing facility |
| status | string | M | Varchar | Status of the facility |
| description | string | M | Varchar | Description of the facility |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> DetailAsset ->AccessPlacesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the access place |
| name | string |
M |
Varchar | Name of the access place |
| icon | string | M | Varchar | Icon representing access place |
| description | string | M | Varchar | Description of the access place |
| status | string | M | Varchar | Status of the access place |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> DetailAsset ->ContactResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the contact |
| picName | string |
M |
Varchar | Name of the person in charge (PIC) |
| picPhone | string | M | Varchar | Phone number of the PIC |
responseData -> DetailAsset ->ImagesResponses
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the image |
| filename | string |
M |
Varchar | Name of the image file |
| path | string | M | Varchar | Path to the image file |
| extension | string | M | Varchar | File extension of the image |
| size | int64 | M | Number | Size of the image file |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
Request & Response Payload Sample
Request
{
"status": {
"code": "0601",
"desc": "Invalid token"
}
}
Normal Response :
{
"responseCode": "0000",
"responseMessage": "Success",
"responseData": {
"id": 1461,
"formType": "form-b1",
"tagHotdealDesc": "",
"tagCleanDesc": "Clean & Clear",
"tagHotdeal": 0,
"tagClean": 1,
"type": "Non-Lelang",
"kpknlId": 0,
"auctionDate": "",
"auctionTime": "",
"auctionLink": "",
"categoryId": 1,
"subCategoryId": 2,
"name": "Mollit distinctio Voluptates esse enim est",
"price": 1000000000,
"priceBefore": 1000000000,
"discountType": "",
"discountNominal": 0,
"description": "Qui sit quia iste obcaecati quia fugiat quia",
"status": "",
"makerId": "",
"makerDesc": "",
"makerDate": "",
"lastMakerId": "",
"lastMakerDesc": "",
"lastMakerDate": "",
"published": true,
"deleted": false,
"publishDate": "2023-11-09T14:35:49+07:00",
"expiredDate": "2024-05-09T15:09:15+07:00",
"action": "Create",
"kpknlName": "",
"categoryName": "Bangunan",
"subCategoryName": "Ruko",
"statusName": "Published",
"addresses": {
"id": 1284,
"assetId": 1461,
"address": "Est consequuntur sit modi debitis odio cumque aperiam
cupidatat cillum nihil sit nemo quis",
"longitude": "-6.204945679780837",
"langitude": "106.82151779599825",
"latitude": "",
"longLat": "-6.204945679780837,106.82151779599825",
"postalcodeId": 0,
"postalCode": "15155",
"region": "CIPADU JAYA KEL",
"district": "LARANGAN",
"city": "TANGERANG KOT.",
"province": "BANTEN",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
"buildingAssets": {
"id": 1248,
"assetId": 1461,
"certificateTypeId": 1,
"certificateTypeName": "SHM",
"certificateNumber": "102402349953534543",
"buildYear": 2020,
"surfaceArea": 100,
"buildingArea": 100,
"direction": "barat",
"numberOfFloors": 3,
"numberOfBedrooms": 2,
"numberOfBathrooms": 2,
"electricalPower": 100,
"carport": 2,
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
"vehicleAssets": {
"id": 0,
"assetId": 0,
"vehicleTypeId": 0,
"certificateTypeId": 0,
"certificateNumber": "",
"series": "",
"brandId": 0,
"type": "",
"productionYear": "",
"transmissionId": 0,
"machineCapacityId": 0,
"colorId": 0,
"numberOfSeat": 0,
"numberOfUsage": "",
"machineNumber": "",
"bodyNumber": "",
"licenceDate": "",
"certificateTypeName": "",
"brandName": "",
"transmissionName": "",
"machineCapacityName": "",
"colorName": ""
},
"facilities": [
{
"id": 1,
"name": "Furnished",
"icon": "icon-furnised",
"status": "Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 2,
"name": "Sambungan telepon",
"icon": "icon-sambungan-telepon",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 3,
"name": "Kolam renang",
"icon": "icon-swim",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 4,
"name": "Keamanan",
"icon": "icon-cctv",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 5,
"name": "Lift",
"icon": "icon-lift",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 6,
"name": "Garasi",
"icon": "icon-garage",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 7,
"name": "Gym",
"icon": "icon-gym",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 8,
"name": "Taman",
"icon": "icon-taman",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 9,
"name": "Parkir/Carport",
"icon": "icon-parking",
"status": "Tidak Ada",
"description": "",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
}
],
"accessPlaces": [
{
"id": 1,
"name": "Rumah Sakit",
"icon": "icon-first-aid",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 2,
"name": "Jalan Tol",
"icon": "icon-street-toll",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 3,
"name": "Sekolah",
"icon": "icon-backpack",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 4,
"name": "Mall",
"icon": "icon-mall",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 5,
"name": "Bank/ATM",
"icon": "icon-bank-atm",
"description": "",
"status": "Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 6,
"name": "Taman",
"icon": "icon-taman",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 7,
"name": "Pasar",
"icon": "icon-pasar",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 8,
"name": "Farmasi",
"icon": "icon-farmasi",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 9,
"name": "Rumah Ibadah",
"icon": "icon-rumah-ibadah",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 10,
"name": "Restoran",
"icon": "icon-restoran",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 11,
"name": "Bioskop",
"icon": "icon-bioskop",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 12,
"name": "Bar",
"icon": "icon-bar",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 13,
"name": "Halte",
"icon": "icon-halte",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 14,
"name": "Stasiun",
"icon": "icon-stasiun",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 15,
"name": "Bandara",
"icon": "icon-bandara",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 16,
"name": "SPBU",
"icon": "icon-spbu",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
},
{
"id": 17,
"name": "GYM",
"icon": "icon-gym",
"description": "",
"status": "Tidak Ada",
"createdAt": "2023-10-30T16:21:00+07:00",
"updatedAt": null
}
],
"contacts": {
"id": 0,
"assetId": 1461,
"debiturName": "",
"picName": "",
"picPhone": "",
"picEmail": "",
"cif": "",
"createdAt": null,
"updatedAt": null
},
"images": [
{
"id": 3983,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F10%2F31%2F2023-10-
31_11%3A21%3A23_rumah.webp&filename=2023-10-
31_11%3A21%3A23_rumah.webp",
"path": "asset/Non-Lelang/2023/10/31/2023-10-
31_11:21:23_rumah.webp",
"extension": "image/jpeg",
"size": 9966
},
{
"id": 3984,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F10%2F31%2F2023-10-
31_11%3A21%3A31_rumah_2.webp&filename=2023-10-
31_11%3A21%3A31_rumah_2.webp",
"path": "asset/Non-Lelang/2023/10/31/2023-10-
31_11:21:31_rumah_2.webp",
"extension": "image/jpeg",
"size": 8174
},
{
"id": 3985,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F10%2F31%2F2023-10-
31_11%3A21%3A38_rumah_3.webp&filename=2023-10-
31_11%3A21%3A38_rumah_3.webp",
"path": "asset/Non-Lelang/2023/10/31/2023-10-
31_11:21:38_rumah_3.webp",
"extension": "image/jpeg",
"size": 9970
},
{
"id": 3986,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F10%2F31%2F2023-10-
31_11%3A21%3A44_rumah_4.webp&filename=2023-10-
31_11%3A21%3A44_rumah_4.webp",
"path": "asset/Non-Lelang/2023/10/31/2023-10-
31_11:21:44_rumah_4.webp",
"extension": "image/jpeg",
"size": 12281
}
],
"documentId": "",
"updatedAt": "2023-10-30T16:21:00+07:00",
"createdAt": "2023-11-09T14:35:49+07:00",
"sharedCount": 0,
"views": 0
}
}
Error Response :
{
"responseCode":"0104",
"responseMessage":"Asset tidak ditemukan",
"responseData":null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
2. List Clean and Clear
Endpoint Description
Used to display a list of clean and clear auction Asset data.
General Information
|
HTTP Method |
POST |
|---|---|
|
Path |
/v1.0/info-lelang/clean-and-clear |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Request Structure & Sample
|
No |
Field Name |
Type |
Length |
Format |
Status |
Description |
|---|---|---|---|---|---|---|
|
1 |
categories |
Array |
- | Varchar |
O |
|
| 2 | subCategories | Array | - | Varchar | O | |
| 3 | from | Numeric | 19850 | Integer | O | |
| 4 | size | Numeric | 150 | Integer | M | |
| 5 | latlon | Object | M | |||
| 6 | distance | String | - | Varchar | M | |
| 7 | latitude | Float | 90 | Double | M | |
| 8 | longitude | Float | 180 | Double | M |
Object latlon
|
Field |
Data Type |
Mandatory |
Length |
Description |
Example |
|---|---|---|---|---|---|
|
distance |
String |
M |
30km |
||
| latitude |
Float |
M |
-6.123456 |
||
| longitude | Float | M | 106.789012 |
Response Structure & Sample
|
No |
Field Name |
Type |
Data Type |
Mandatory |
Example |
|---|---|---|---|---|---|
|
1 |
responseCode |
String |
Varchar | M |
|
| 2 | responseMessage |
String |
Varchar | M |
|
| 3 | responseData | Any | Object | M | Object, NULL |
| 4 | list | Array | []List | M | |
| 5 | page | int | Number | M | |
| 6 | limit | int | Number | M | |
| 7 | totalPage | int | Number | M | |
| 8 | totalData | int | Number | M |
responseData -> List
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | |
| formType |
string |
M |
Varchar | |
| type | string | M | Varchar | |
| tagAuction | string | M | Varchar | |
| tagCleanDesc | string | M | Varchar | |
| tagHotdealDesc | string | M | Varchar | |
| priceBefore | float64 | M | Double | |
| discountType | string | M | Varchar | |
| discountNominal | float64 | M | Double | |
| kpknlId | int64 | M | Number | |
| auctionDate | string | M | Varchar | |
| auctionTime | string | M | Varchar | |
| auctionLink | string | M | Varchar | |
| categoryId | int64 | M | Number | |
| subCategoryId | int64 | M | Number | |
| name | string | M | Varchar | |
| price | float64 | M | Double | |
| description | string | M | Varchar | |
| status | string | M | Varchar | |
| published | bool | M | Boolean | |
| kpknlName | string | M | Varchar | |
| categoryName | string | M | Varchar | |
| subCategoryName | string | M | Varchar | |
| statusName | string | M | Varchar | |
| documentId | string | M | Varchar | |
| addresses | AddressesResponse | M | Object | |
| buildingAssets | BuildingAssetsResponse | M | Object | |
| vehicleAssets | VehicleAssetsResponseElastic | M | Object | |
| facilities | []FacilitiesResponse | M | Array | |
| accessPlaces | []AccessPlacesResponse | M | Array | |
| images | []ImagesResponses | M | Array | |
| sharedCount | int64 | M | Number | |
| views | int64 | M | Number | |
| auctionDateTime | string | M | Varchar | |
| soldAt | *time.Time | M | Datetime | |
| isSoldOut | bool | M | Boolean | |
| bookedStatus | bool | M | Boolean | |
| bookedAt | *time.Time | M | Datetime |
responseData List AddressesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the asset detail |
| assetId | int64 |
M |
Number | ID of the asset |
| address | string | M | Varchar | Address text |
| longitude | string | M | Varchar | Longitude value |
| langitude | string | M | Varchar | Langitude value |
| latitude | string | M | Varchar | Latitude value |
| longLat | string | M | Varchar | Combined long and lat |
| postalcodeId | int64 | M | Number | ID of postal code |
| postalCode | string | M | Varchar | Postal Code |
| region | string | M | Varchar | Region name |
| district | string | M | Varchar | District name |
| city | string | M | Varchar | City name |
| province | string | M | Varchar | Province name |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
| longlati | string | M | Varchar | Optional longlati |
responseData List Building Assets Response
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| buildYear | int64 | M | Number | Year the building was constructed |
| surfaceArea | int64 | M | Number | Surface area of the building |
| buildingArea | int64 | M | Number | Building area |
| direction | string | M | Varchar | Direction the building faces |
| numberOfFloors | int64 | M | Number | Number of floors in the building |
| numberOfBedrooms | int64 | M | Number | Number of bedrooms |
| numberOfBathrooms | int64 | M | Number | Number of bathrooms |
| electricalPower | int64 | M | Number | Electrical power capacity |
| carport | int64 | M | Number | Carport capacity |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
responseData List VehicleAssetsResponseElastic
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| vehicleTypeId | int64 | M | Number | ID of the vehicle type |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| series | string | M | Varchar | Series of the vehicle |
| brandId | int64 | M | Number | ID of the brand |
| type | string | M | Varchar | Type of the vehicle |
| productionYear | string | M | Varchar | Production year of the vehicle |
| transmissionId | int64 | M | Number | ID of the transmission type |
| machineCapacityId | int64 | M | Number | ID of the machine capacity |
| colorId | int64 | M | Number | ID of the color |
| numberOfSeat | int64 | M | Number | Number of seats in the vehicle |
| numberOfUsage | string | M | Varchar | Usage count or details |
| machineNumber | string | M | Varchar | Number of the machine |
| bodyNumber | string | M | Varchar | Number of the body |
| licenceDate | string | M | Varchar | Date of the license |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| brandName | string | M | Varchar | Name of the brand |
| transmissionName | string | M | Varchar | Name of the transmission type |
| machineCapacityName | string | M | Varchar | Name of the machine capacity |
| colorName | string | M | Varchar | Name of the color |
| createdAt | string | M | Datetime | Created timestamp |
| updatedAt | string | M | Datetime | Updated timestamp |
responseData List FacilitiesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the facility |
| name | string |
M |
Varchar | Name of the facility |
| icon | string | M | Varchar | Icon representing facility |
| status | string | M | Varchar | Status of the facility |
| description | string | M | Varchar | Description of the facility |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData List AccessPlacesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the access place |
| name | string |
M |
Varchar | Name of the access place |
| icon | string | M | Varchar | Icon representing access place |
| description | string | M | Varchar | Description of the access place |
| status | string | M | Varchar | Status of the access place |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData List ImagesResponses
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the image |
| filename | string |
M |
Varchar | Name of the image file |
| path | string | M | Varchar | Path to the image file |
| extension | string | M | Varchar | File extension of the image |
| size | int64 | M | Number | Size of the image file |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
Request & Response Payload Sample
Request
{
"categories": [
"1",
"2"
],
"subCategories": [
"1",
"2",
"3",
"5",
"26"
],
"from": 0,
"size": 1,
"latlon": {
"distance": "30km",
"latitude": -6.123456,
"longitude": 106.789012
}
}
Normal Response :
{
"responseCode": "0000",
"responseMessage": "success",
"responseData": {
"list": [
{
"id": 1450,
"formType": "form-b1",
"type": "Lelang",
"tagAuction": "",
"tagCleanDesc": "Clean & Clear",
"tagHotdealDesc": "Hot Deals",
"priceBefore": 891030900,
"discountType": "persen",
"discountNominal": 4,
"kpknlId": 76,
"auctionDate": "2023-12-15",
"auctionTime": "12:30:00",
"auctionLink": "https://lelang.go.id/lot-lelang/detail/123/abcaaaa",
"categoryId": 1,
"subCategoryId": 1,
"name": "Rumah Haji Nawi Approved Signer Lelang",
"price": 855389700,
"description": "Rumah di haji nawi",
"status": "01e",
"published": false,
"kpknlName": "KPKNL Balikpapan",
"categoryName": "Bangunan",
"subCategoryName": "Rumah",
"statusName": "Pending Signer",
"documentId": "5f0229dac9824a3f9e695f69fdf1877c",
"addresses": {
"id": 1213,
"assetId": 1450,
"address": "Jalan Haji Nawi No. 150",
"longitude": "-6.140554782450295",
"langitude": "106.77612304687501",
"latitude": "",
"longLat": "-6.140554782450295,106.77612304687501",
"postalcodeId": 14,
"postalCode": "10210",
"region": "BENDUNGAN HILIR KEL",
"district": "TANAH ABANG",
"city": "JAKARTA PUSAT",
"province": "DKI JAKARTA",
"createdAt": null,
"updatedAt": null,
"longlati": "-6.140554782450295,106.77612304687501"
},
"buildingAssets": {
"id": 0,
"assetId": 1450,
"certificateTypeId": 1,
"certificateTypeName": "SHM",
"certificateNumber": "0374020402",
"buildYear": 2021,
"surfaceArea": 300,
"buildingArea": 250,
"direction": "barat",
"numberOfFloors": 2,
"numberOfBedrooms": 4,
"numberOfBathrooms": 3,
"electricalPower": 80000,
"carport": 1,
"createdAt": null,
"updatedAt": null
},
"vehicleAssets": {
"id": 0,
"assetId": 0,
"vehicleTypeId": 0,
"certificateTypeId": 0,
"certificateNumber": "",
"series": "",
"brandId": 0,
"type": "",
"productionYear": "",
"transmissionId": 0,
"machineCapacityId": 0,
"colorId": 0,
"numberOfSeat": 0,
"numberOfUsage": "",
"machineNumber": "",
"bodyNumber": "",
"licenceDate": "",
"certificateTypeName": "",
"brandName": "",
"transmissionName": "",
"machineCapacityName": "",
"colorName": "",
"createdAt": "",
"updatedAt": ""
},
"facilities": [
{
"id": 1,
"name": "Furnished",
"icon": "icon-furnised",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Sambungan telepon",
"icon": "icon-sambungan-telepon",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Kolam renang",
"icon": "icon-swim",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Keamanan",
"icon": "icon-cctv",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Lift",
"icon": "icon-lift",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Garasi",
"icon": "icon-garage",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Gym",
"icon": "icon-gym",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Taman",
"icon": "icon-taman",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Parkir/Carport",
"icon": "icon-parking",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
}
],
"accessPlaces": [
{
"id": 1,
"name": "Rumah Sakit",
"icon": "icon-first-aid",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Jalan Tol",
"icon": "icon-street-toll",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Sekolah",
"icon": "icon-backpack",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Mall",
"icon": "icon-mall",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Bank/ATM",
"icon": "icon-bank-atm",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Taman",
"icon": "icon-taman",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Pasar",
"icon": "icon-pasar",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Farmasi",
"icon": "icon-farmasi",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Rumah Ibadah",
"icon": "icon-rumah-ibadah",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 10,
"name": "Restoran",
"icon": "icon-restoran",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 11,
"name": "Bioskop",
"icon": "icon-bioskop",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 12,
"name": "Bar",
"icon": "icon-bar",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 13,
"name": "Halte",
"icon": "icon-halte",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 14,
"name": "Stasiun",
"icon": "icon-stasiun",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 15,
"name": "Bandara",
"icon": "icon-bandara",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 16,
"name": "SPBU",
"icon": "icon-spbu",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 17,
"name": "GYM",
"icon": "icon-gym",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
}
],
"contacts": {
"id": 0,
"assetId": 0,
"picName": "Alifia",
"picPhone": "0812183081",
"picEmail": "alifia@gmail.com",
"createdAt": null,
"updatedAt": null
},
"images": [
{
"id": 3939,
"filename": "/v1/file?subdir=asset%2FLelang%2F2023%2F10%2F26%2F2023-10-26_16%3A06%
3A47_3d473d5c-harga-rumah-seken-02-finansialku.webp&filename=2023-10-26_16%3A06%3A47_3d473d5c-harga-rumah-seken02-finansialku.webp",
"path": "asset/Lelang/2023/10/26/2023-10-26_16:06:47_3d473d5c-harga-rumah-seken-02-
finansialku.webp",
"extension": "image/jpeg",
"size": 30071
},
{
"id": 3940,
"filename": "/v1/file?subdir=asset%2FLelang%2F2023%2F10%2F26%2F2023-10-26_16%3A07%
3A03_ruko_dijual_di_wanasari_brebes__927392-ab770.webp&filename=2023-10-26_16%3A07%
3A03_ruko_dijual_di_wanasari_brebes__927392-ab770.webp",
"path": "asset/Lelang/2023/10/26/2023-10-26_16:07:
03_ruko_dijual_di_wanasari_brebes__927392-ab770.webp",
"extension": "image/jpeg",
"size": 321442
},
{
"id": 3941,
"filename": "/v1/file?subdir=asset%2FLelang%2F2023%2F10%2F26%2F2023-10-26_16%3A07%
3A17_rumah-kontainer-juga-bisa-berdesain-estetik-lihat-yuk-210910c.webp&filename=2023-10-26_16%3A07%3A17_rumahkontainer-juga-bisa-berdesain-estetik-lihat-yuk-210910c.webp",
"path": "asset/Lelang/2023/10/26/2023-10-26_16:07:17_rumah-kontainer-juga-bisaberdesain-estetik-lihat-yuk-210910c.webp",
"extension": "image/jpeg",
"size": 57449
},
{
"id": 3942,
"filename": "/v1/file?subdir=asset%2FLelang%2F2023%2F10%2F26%2F2023-10-26_16%3A07%
3A27_download.webp&filename=2023-10-26_16%3A07%3A27_download.webp",
"path": "asset/Lelang/2023/10/26/2023-10-26_16:07:27_download.webp",
"extension": "image/jpeg",
"size": 12796
}
],
"sharedCount": 0,
"views": 18,
"auctionDateTime": "2023-12-15T00:00:00Z",
"soldAt": "0001-01-01T00:00:00Z",
"isSoldOut": false,
"bookedStatus": false,
"bookedBy": "",
"bookedAt": ""
}
],
"page": 0,
"limit": 1,
"totalPage": 12,
"totalData": 12
}
}
Error Response :
{
"responseCode": "0100",
"responseMessage": "Validasi tidak valid: latlon (distance harus diisi, latitude harus diisi, longitude harus diisi.), size harus diisi.",
"responseData": null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
3. List Non Lelang Terdekat
Endpoint Description
Used to display the list of Nearby Non-Auction Assets.
General Information
|
HTTP Method |
POST |
|---|---|
|
Path |
/v1.0/info-lelang/non-auction-nearest |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Request Structure & Sample
|
No |
Field Name |
Type |
Length |
Format |
Status |
Description |
|---|---|---|---|---|---|---|
|
1 |
categories |
Array |
- | Varchar |
O |
|
| 2 | sub_categories | Array | - | Varchar | O | |
| 3 | from | Numeric | 19850 | Integer | O | |
| 4 | size | Numeric | 150 | Integer | M | |
| 5 | latlon | Object | M | |||
| 6 | distance | String | - | Varchar | M | |
| 7 | latitude | Float | 90 | Double | M | |
| 8 | longitude | Float | 180 | Double | M |
Object latlon
|
Field |
Data Type |
Mandatory |
Length |
Description |
Example |
|---|---|---|---|---|---|
|
distance |
String |
M |
|
||
| latitude |
Float |
M |
|
||
| longitude | Float | M |
Response Structure & Sample
|
No |
Field Name |
Type |
Data Type |
Mandatory |
Example |
|---|---|---|---|---|---|
|
1 |
responseCode |
String |
Varchar | M |
|
| 2 | responseMessage |
String |
Varchar | M |
|
| 3 | responseData | Any | Object | M | Object, NULL |
| 4 | list | Array | []List | M | |
| 5 | page | int | Number | M | |
| 6 | limit | int | Number | M | |
| 7 | totalPage | int | Number | M | |
| 8 | totalData | int | Number | M |
responseData -> List
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | |
| formType |
string |
M |
Varchar | |
| type | string | M | Varchar | |
| tagAuction | string | M | Varchar | |
| tagCleanDesc | string | M | Varchar | |
| tagHotdealDesc | string | M | Varchar | |
| priceBefore | float64 | M | Double | |
| discountType | string | M | Varchar | |
| discountNominal | float64 | M | Double | |
| kpknlId | int64 | M | Number | |
| auctionDate | string | M | Varchar | |
| auctionTime | string | M | Varchar | |
| auctionLink | string | M | Varchar | |
| categoryId | int64 | M | Number | |
| subCategoryId | int64 | M | Number | |
| name | string | M | Varchar | |
| price | float64 | M | Double | |
| description | string | M | Varchar | |
| status | string | M | Varchar | |
| published | bool | M | Boolean | |
| kpknlName | string | M | Varchar | |
| categoryName | string | M | Varchar | |
| subCategoryName | string | M | Varchar | |
| statusName | string | M | Varchar | |
| documentId | string | M | Varchar | |
| addresses | AddressesResponse | M | Object | |
| buildingAssets | BuildingAssetsResponse | M | Object | |
| vehicleAssets | VehicleAssetsResponseElastic | M | Object | |
| facilities | []FacilitiesResponse | M | Array | |
| accessPlaces | []AccessPlacesResponse | M | Array | |
| images | []ImagesResponses | M | Array | |
| sharedCount | int64 | M | Number | |
| views | int64 | M | Number | |
| auctionDateTime | string | M | Varchar | |
| soldAt | *time.Time | M | Datetime | |
| isSoldOut | bool | M | Boolean | |
| bookedStatus | bool | M | Boolean | |
| bookedAt | *time.Time | M | Datetime |
responseData -> List->AddressesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the asset detail |
| assetId | int64 |
M |
Number | ID of the asset |
| address | string | M | Varchar | Address text |
| longitude | string | M | Varchar | Longitude value |
| langitude | string | M | Varchar | Langitude value |
| latitude | string | M | Varchar | Latitude value |
| longLat | string | M | Varchar | Combined long and lat |
| postalcodeId | int64 | M | Number | ID of postal code |
| postalCode | string | M | Varchar | Postal Code |
| region | string | M | Varchar | Region name |
| district | string | M | Varchar | District name |
| city | string | M | Varchar | District name |
| city | string | M | Varchar | City name |
| province | string | M | Varchar | Province name |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
| longlati | string | M | Varchar | Optional longlati |
responseData -> List->Building Assets Response
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| buildYear | int64 | M | Number | Year the building was constructed |
| surfaceArea | int64 | M | Number | Surface area of the building |
| buildingArea | int64 | M | Number | Building area |
| direction | string | M | Varchar | Direction the building faces |
| numberOfFloors | int64 | M | Number | Number of floors in the building |
| numberOfBedrooms | int64 | M | Number | Number of bedrooms |
| numberOfBathrooms | int64 | M | Number | Number of bathrooms |
| electricalPower | int64 | M | Number | Electrical power capacity |
| carport | int64 | M | Number | Carport capacity |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
responseData -> List->VehicleAssetsResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| vehicleTypeId | int64 | M | Number | ID of the vehicle type |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| series | string | M | Varchar | Series of the vehicle |
| brandId | int64 | M | Number | ID of the brand |
| type | string | M | Varchar | Type of the vehicle |
| productionYear | string | M | Varchar | Production year of the vehicle |
| transmissionId | int64 | M | Number | ID of the transmission type |
| machineCapacityId | int64 | M | Number | ID of the machine capacity |
| colorId | int64 | M | Number | ID of the color |
| numberOfSeat | int64 | M | Number | Number of seats in the vehicle |
| numberOfUsage | string | M | Varchar | Usage count or details |
| machineNumber | string | M | Varchar | Number of the machine |
| bodyNumber | string | M | Varchar | Number of the body |
| licenceDate | string | M | Varchar | Date of the license |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| brandName | string | M | Varchar | Name of the brand |
| transmissionName | string | M | Varchar | Name of the transmission type |
| machineCapacityName | string | M | Varchar | Name of the machine capacity |
| colorName | string | M | Varchar | Name of the color |
| createdAt | string | M | Datetime | Created timestamp |
| updatedAt | string | M | Datetime | Updated timestamp |
responseData -> List->FacilitiesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the facility |
| name | string |
M |
Varchar | Name of the facility |
| icon | string | M | Varchar | Icon representing facility |
| status | string | M | Varchar | Status of the facility |
| description | string | M | Varchar | Description of the facility |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> List->AccessPlacesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the access place |
| name | string |
M |
Varchar | Name of the access place |
| icon | string | M | Varchar | Icon representing access place |
| description | string | M | Varchar | Description of the access place |
| status | string | M | Varchar | Status of the access place |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> List->ImagesResponses
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the image |
| filename | string |
M |
Varchar | Name of the image file |
| path | string | M | Varchar | Path to the image file |
| extension | string | M | Varchar | File extension of the image |
| size | int64 | M | Number | Size of the image file |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
Request & Response Payload Sample
Request
{
"categories": [
"1",
"2",
"3"
],
"subCategories": [
"1",
"2",
"3",
"5",
"26"
],
"from": 0,
"size": 1,
"latlon": {
"distance": "100km",
"latitude": -6.3127543,
"longitude": 107.3724673
}
}
Normal Response :
{
"responseCode": "0000",
"responseMessage": "success",
"responseData": {
"list": [
{
"id": 1551,
"formType": "form-b1",
"type": "Non-Lelang",
"tagAuction": "",
"tagCleanDesc": "Clean & Clear",
"tagHotdealDesc": "",
"priceBefore": 670000000,
"discountType": "",
"discountNominal": 0,
"kpknlId": 0,
"auctionDate": "",
"auctionTime": "",
"auctionLink": "",
"categoryId": 1,
"subCategoryId": 1,
"name": "coba rumah ceretad",
"price": 670000000,
"description": "blaa hhh",
"status": "02c",
"published": false,
"kpknlName": "",
"categoryName": "Bangunan",
"subCategoryName": "Rumah",
"statusName": "Soldout",
"documentId": "38e2de72d40440e0aab2da4f2c915d77",
"addresses": {
"id": 1471,
"assetId": 1551,
"address": "jl sudirman",
"longitude": "-6.2313844",
"langitude": "106.9854147",
"latitude": "",
"longLat": "-6.2313844,106.9854147",
"postalcodeId": 18,
"postalCode": "10250",
"region": "KAMPUNG BALI KEL",
"district": "TANAH ABANG",
"city": "JAKARTA PUSAT",
"province": "DKI JAKARTA",
"createdAt": null,
"updatedAt": null,
"longlati": "-6.2313844,106.9854147"
},
"buildingAssets": {
"id": 0,
"assetId": 1551,
"certificateTypeId": 1,
"certificateTypeName": "SHM",
"certificateNumber": "53454353345",
"buildYear": 2022,
"surfaceArea": 100,
"buildingArea": 800,
"direction": "utara",
"numberOfFloors": 1,
"numberOfBedrooms": 2,
"numberOfBathrooms": 2,
"electricalPower": 800,
"carport": 0,
"createdAt": null,
"updatedAt": null
},
"vehicleAssets": {
"id": 0,
"assetId": 0,
"vehicleTypeId": 0,
"certificateTypeId": 0,
"certificateNumber": "",
"series": "",
"brandId": 0,
"type": "",
"productionYear": "",
"transmissionId": 0,
"machineCapacityId": 0,
"colorId": 0,
"numberOfSeat": 0,
"numberOfUsage": "",
"machineNumber": "",
"bodyNumber": "",
"licenceDate": "",
"certificateTypeName": "",
"brandName": "",
"transmissionName": "",
"machineCapacityName": "",
"colorName": "",
"createdAt": "",
"updatedAt": ""
},
"facilities": [
{
"id": 1,
"name": "Furnished",
"icon": "icon-furnised",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Sambungan telepon",
"icon": "icon-sambungan-telepon",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Kolam renang",
"icon": "icon-swim",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Keamanan",
"icon": "icon-cctv",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Lift",
"icon": "icon-lift",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Garasi",
"icon": "icon-garage",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Gym",
"icon": "icon-gym",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Taman",
"icon": "icon-taman",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Parkir/Carport",
"icon": "icon-parking",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
}
],
"accessPlaces": [
{
"id": 1,
"name": "Rumah Sakit",
"icon": "icon-first-aid",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Jalan Tol",
"icon": "icon-street-toll",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Sekolah",
"icon": "icon-backpack",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Mall",
"icon": "icon-mall",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Bank/ATM",
"icon": "icon-bank-atm",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Taman",
"icon": "icon-taman",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Pasar",
"icon": "icon-pasar",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Farmasi",
"icon": "icon-farmasi",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Rumah Ibadah",
"icon": "icon-rumah-ibadah",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 10,
"name": "Restoran",
"icon": "icon-restoran",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 11,
"name": "Bioskop",
"icon": "icon-bioskop",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 12,
"name": "Bar",
"icon": "icon-bar",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 13,
"name": "Halte",
"icon": "icon-halte",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 14,
"name": "Stasiun",
"icon": "icon-stasiun",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 15,
"name": "Bandara",
"icon": "icon-bandara",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 16,
"name": "SPBU",
"icon": "icon-spbu",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 17,
"name": "GYM",
"icon": "icon-gym",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
}
],
"contacts": {
"id": 0,
"assetId": 0,
"picName": "alohdr",
"picPhone": "085644353",
"picEmail": "alohdr@gmail.com",
"createdAt": null,
"updatedAt": null
},
"images": [
{
"id": 4459,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F12%2F1%2F2023-12-
01_15%3A38%3A45_getFile_%281%29.webp&filename=2023-12-
01_15%3A38%3A45_getFile_%281%29.webp",
"path": "asset/Non-Lelang/2023/12/1/2023-
12-01_15:38:45_getFile_(1).webp",
"extension": "image/webp",
"size": 50794
},
{
"id": 4460,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F12%2F1%2F2023-12-
01_15%3A39%3A00_getFile1_%281%29.webp&filename=2023-12-
01_15%3A39%3A00_getFile1_%281%29.webp",
"path": "asset/Non-Lelang/2023/12/1/2023-
12-01_15:39:00_getFile1_(1).webp",
"extension": "image/jpeg",
"size": 81096
},
{
"id": 4461,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F12%2F1%2F2023-12-
01_15%3A39%3A10_getFile2.webp&filename=2023-12-
01_15%3A39%3A10_getFile2.webp",
"path": "asset/Non-Lelang/2023/12/1/2023-
12-01_15:39:10_getFile2.webp",
"extension": "image/jpeg",
"size": 68611
},
{
"id": 4462,
"filename": "/v1/file?subdir=asset%2FNonLelang%2F2023%2F12%2F1%2F2023-12-
01_15%3A39%3A23_getFile2.webp&filename=2023-12-
01_15%3A39%3A23_getFile2.webp",
"path": "asset/Non-Lelang/2023/12/1/2023-
12-01_15:39:23_getFile2.webp",
"extension": "image/webp",
"size": 7338
}
],
"sharedCount": 0,
"views": 0,
"auctionDateTime": "",
"soldAt": "2023-12-13T09:15:47+07:00",
"isSoldOut": true,
"bookedStatus": false,
"bookedBy": "",
"bookedAt": ""
}
],
"page": 0,
"limit": 1,
"totalPage": 22,
"totalData": 22
}
}
Error Response :
{
"responseCode": "0100",
"responseMessage": "Format request not valid: map[fromThe value must be
`int`]",
"responseData": null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
4. Search Asset
Endpoint Description
Used to search for auction assets by category, sub-category, type and so on.
General Information
|
HTTP Method |
POST |
|---|---|
|
Path |
/v1.0/info-lelang/search |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Request Structure & Sample
|
No |
Field Name |
Type |
Length |
Format |
Status |
Description |
|---|---|---|---|---|---|---|
|
1 |
categories |
Array |
- | Varchar |
O |
|
| 2 | sub_categories | Array | - | Varchar | O | |
| 3 | tags | Array | - | Varchar | O | ex: Clean & Clear,Hot Deals |
| 4 | from | Numeric | 19850 | Integer | O | |
| 5 | size | Numeric | 150 | integer | M | |
| 6 | types | Array | - | Varchar | O | ex: Lelang,Non-Lelang |
| 7 | price_filter | Object | O | |||
| 8 | price_start | Numeric | 14 digit | Integer | ||
| 9 | price_end | Numeric | 14 digit | Integer | ||
| 10 | provincies | Array | - | Array | O | ex: DKI JAKARTA |
| 11 | search | String | 50 | Varchar | O | |
| 12 | sort_by | String | - | Varchar | M | ex: id,view,price,location |
| 13 | order_by | String | - | Varchar | M | ex: asc,desc |
PriceFilter Object
|
Field |
Data Type |
Mandatory |
Length |
Description |
Example |
|---|---|---|---|---|---|
|
priceStart |
Array String |
O |
|
||
| priceEnd |
Array String |
O |
|
Response Structure & Sample
|
No |
Field Name |
Type |
Data Type |
Mandatory |
Example |
|---|---|---|---|---|---|
|
1 |
responseCode |
String |
Varchar | M |
|
| 2 | responseMessage |
String |
Varchar | M |
|
| 3 | responseData | Any | Object | M | Object, NULL |
| 4 | list | Array | []List | M | |
| 5 | page | int | Number | M | |
| 6 | limit | int | Number | M | |
| 7 | totalPage | int | Number | M | |
| 8 | totalData | int | Number | M |
responseData -> List
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | |
| formType |
string |
M |
Varchar | |
| type | string | M | Varchar | |
| tagAuction | string | M | Varchar | |
| tagCleanDesc | string | M | Varchar | |
| tagHotdealDesc | string | M | Varchar | |
| priceBefore | float64 | M | Double | |
| discountType | string | M | Varchar | |
| discountNominal | float64 | M | Double | |
| kpknlId | int64 | M | Number | |
| auctionDate | string | M | Varchar | |
| auctionTime | string | M | Varchar | |
| auctionLink | string | M | Varchar | |
| categoryId | int64 | M | Number | |
| subCategoryId | int64 | M | Number | |
| name | string | M | Varchar | |
| price | float64 | M | Double | |
| description | string | M | Varchar | |
| status | string | M | Varchar | |
| published | bool | M | Boolean | |
| kpknlName | string | M | Varchar | |
| categoryName | string | M | Varchar | |
| subCategoryName | string | M | Varchar | |
| statusName | string | M | Varchar | |
| documentId | string | M | Varchar | |
| addresses | AddressesResponse | M | Object | |
| buildingAssets | BuildingAssetsResponse | M | Object | |
| vehicleAssets | VehicleAssetsResponseElastic | M | Object | |
| facilities | []FacilitiesResponse | M | Array | |
| accessPlaces | []AccessPlacesResponse | M | Array | |
| images | []ImagesResponses | M | Array | |
| sharedCount | int64 | M | Number | |
| views | int64 | M | Number | |
| auctionDateTime | string | M | Varchar | |
| soldAt | *time.Time | M | Datetime | |
| isSoldOut | bool | M | Boolean | |
| bookedStatus | bool | M | Boolean | |
| bookedAt | *time.Time | M | Datetime |
responseData -> List->AddressesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the asset detail |
| assetId | int64 |
M |
Number | ID of the asset |
| address | string | M | Varchar | Address text |
| longitude | string | M | Varchar | Longitude value |
| langitude | string | M | Varchar | Langitude value |
| latitude | string | M | Varchar | Latitude value |
| longLat | string | M | Varchar | Combined long and lat |
| postalcodeId | int64 | M | Number | ID of postal code |
| postalCode | string | M | Varchar | Postal Code |
| region | string | M | Varchar | Region name |
| district | string | M | Varchar | District name |
| city | string | M | Varchar | District name |
| city | string | M | Varchar | City name |
| province | string | M | Varchar | Province name |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
| longlati | string | M | Varchar | Optional longlati |
responseData -> List->Building Assets Response
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| buildYear | int64 | M | Number | Year the building was constructed |
| surfaceArea | int64 | M | Number | Surface area of the building |
| buildingArea | int64 | M | Number | Building area |
| direction | string | M | Varchar | Direction the building faces |
| numberOfFloors | int64 | M | Number | Number of floors in the building |
| numberOfBedrooms | int64 | M | Number | Number of bedrooms |
| numberOfBathrooms | int64 | M | Number | Number of bathrooms |
| electricalPower | int64 | M | Number | Electrical power capacity |
| carport | int64 | M | Number | Carport capacity |
| createdAt | *time.Time | M | Datetime | Created timestamp |
| updatedAt | *time.Time | M | Datetime | Updated timestamp |
responseData -> List->VehicleAssetsResponseElastic
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the building asset |
| assetId | int64 |
M |
Number | ID of the asset |
| vehicleTypeId | int64 | M | Number | ID of the vehicle type |
| certificateTypeId | int64 | M | Number | ID of the certificate type |
| certificateNumber | string | M | Varchar | Number of the certificate |
| series | string | M | Varchar | Series of the vehicle |
| brandId | int64 | M | Number | ID of the brand |
| type | string | M | Varchar | Type of the vehicle |
| productionYear | string | M | Varchar | Production year of the vehicle |
| transmissionId | int64 | M | Number | ID of the transmission type |
| machineCapacityId | int64 | M | Number | ID of the machine capacity |
| colorId | int64 | M | Number | ID of the color |
| numberOfSeat | int64 | M | Number | Number of seats in the vehicle |
| numberOfUsage | string | M | Varchar | Usage count or details |
| machineNumber | string | M | Varchar | Number of the machine |
| bodyNumber | string | M | Varchar | Number of the body |
| licenceDate | string | M | Varchar | Date of the license |
| certificateTypeName | string | M | Varchar | Name of the certificate type |
| brandName | string | M | Varchar | Name of the brand |
| transmissionName | string | M | Varchar | Name of the transmission type |
| machineCapacityName | string | M | Varchar | Name of the machine capacity |
| colorName | string | M | Varchar | Name of the color |
| createdAt | string | M | Datetime | Created timestamp |
| updatedAt | string | M | Datetime | Updated timestamp |
responseData -> List->FacilitiesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the facility |
| name | string |
M |
Varchar | Name of the facility |
| icon | string | M | Varchar | Icon representing facility |
| status | string | M | Varchar | Status of the facility |
| description | string | M | Varchar | Description of the facility |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> List->AccessPlacesResponse
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the access place |
| name | string |
M |
Varchar | Name of the access place |
| icon | string | M | Varchar | Icon representing access place |
| description | string | M | Varchar | Description of the access place |
| status | string | M | Varchar | Status of the access place |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
responseData -> List->ImagesResponses
|
Field Name |
Type |
Mandatory |
Data Type |
Description |
|---|---|---|---|---|
|
id |
int64 |
M |
Number | ID of the image |
| filename | string |
M |
Varchar | Name of the image file |
| path | string | M | Varchar | Path to the image file |
| extension | string | M | Varchar | File extension of the image |
| size | int64 | M | Number | Size of the image file |
| createdAt | *string | M | Datetime | Created timestamp |
| updatedAt | *string | M | Datetime | Updated timestamp |
Request & Response Payload Sample
Request
{
"from": 0,
"size": 1,
"categories": [
"1",
"2",
"3"
],
"subCategories": [
"1",
"2",
"3",
"5",
"26"
],
"types": [
"Lelang",
"Non-Lelang"
],
"tags": [
"Clean & Clear",
"Hot Deals"
],
"priceFilter": {
"priceStart":100000000,
"priceEnd":1000000000000
},
"provincies": [],
"search": "rum",
"orderBy": "desc",
"sortBy": "price"
}
Normal Response:
{
"responseCode": "0000",
"responseMessage": "success",
"responseData": {
"list": [
{
"id": 1240,
"formType": "form-b1",
"type": "Non-Lelang",
"tagAuction": "",
"tagCleanDesc": "Clean & Clear",
"tagHotdealDesc": "Hot Deals",
"priceBefore": 4568094000,
"discountType": "persen",
"discountNominal": 27,
"kpknlId": 0,
"auctionDate": "",
"auctionTime": "",
"
Normal Response :
{
"responseCode": "0000",
"responseMessage": "success",
"responseData": {
"list": [
{
"id": 1240,
"formType": "form-b1",
"type": "Non-Lelang",
"tagAuction": "",
"tagCleanDesc": "Clean & Clear",
"tagHotdealDesc": "Hot Deals",
"priceBefore": 4568094000,
"discountType": "persen",
"discountNominal": 27,
"kpknlId": 0,
"auctionDate": "",
"auctionTime": "",
"auctionLink": "",
"categoryId": 1,
"subCategoryId": 1,
"name": "Rumah Bapak Arinal Haq Update By Maker
Biasa",
"price": 3334708700,
"description": "Rumah bapak arinal haq berlokasi
strategis",
"status": "02c",
"published": false,
"kpknlName": "",
"categoryName": "Bangunan",
"subCategoryName": "Rumah",
"statusName": "Soldout",
"documentId": "0dfc9cf11f6548eb86ac5239ec08662b",
"addresses": {
"id": 769,
"assetId": 1240,
"address": "Jalan Bendungan Hilir Nomer 19",
"longitude": "-6.197412541400231",
"langitude": "106.80632371776669",
"latitude": "",
"longLat": "-
6.197412541400231,106.80632371776669",
"postalcodeId": 14,
"postalCode": "10210",
"region": "BENDUNGAN HILIR KEL",
"district": "TANAH ABANG",
"city": "JAKARTA PUSAT",
"province": "DKI JAKARTA",
"createdAt": null,
"updatedAt": null,
"longlati": "-
6.197412541400231,106.80632371776669"
},
"buildingAssets": {
"id": 0,
"assetId": 1240,
"certificateTypeId": 3,
"certificateTypeName": "SHMRS",
"certificateNumber": "01839718738146",
"buildYear": 2010,
"surfaceArea": 300,
"buildingArea": 375,
"direction": "barat",
"numberOfFloors": 1,
"numberOfBedrooms": 6,
"numberOfBathrooms": 5,
"electricalPower": 16000,
"carport": 1,
"createdAt": null,
"updatedAt": null
},
"vehicleAssets": {
"id": 0,
"assetId": 0,
"vehicleTypeId": 0,
"certificateTypeId": 0,
"certificateNumber": "",
"series": "",
"brandId": 0,
"type": "",
"productionYear": "",
"transmissionId": 0,
"machineCapacityId": 0,
"colorId": 0,
"numberOfSeat": 0,
"numberOfUsage": "",
"machineNumber": "",
"bodyNumber": "",
"licenceDate": "",
"certificateTypeName": "",
"brandName": "",
"transmissionName": "",
"machineCapacityName": "",
"colorName": "",
"createdAt": "",
"updatedAt": ""
},
"facilities": [
{
"id": 1,
"name": "Furnished",
"icon": "icon-furnised",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Sambungan telepon",
"icon": "icon-sambungan-telepon",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Kolam renang",
"icon": "icon-swim",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Keamanan",
"icon": "icon-cctv",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Lift",
"icon": "icon-lift",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Garasi",
"icon": "icon-garage",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Gym",
"icon": "icon-gym",
"status": "Tidak Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Taman",
"icon": "icon-taman",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Parkir/Carport",
"icon": "icon-parking",
"status": "Ada",
"description": "",
"createdAt": null,
"updatedAt": null
}
],
"accessPlaces": [
{
"id": 1,
"name": "Rumah Sakit",
"icon": "icon-first-aid",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 2,
"name": "Jalan Tol",
"icon": "icon-street-toll",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 3,
"name": "Sekolah",
"icon": "icon-backpack",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 4,
"name": "Mall",
"icon": "icon-mall",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 5,
"name": "Bank/ATM",
"icon": "icon-bank-atm",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 6,
"name": "Taman",
"icon": "icon-taman",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 7,
"name": "Pasar",
"icon": "icon-pasar",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 8,
"name": "Farmasi",
"icon": "icon-farmasi",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 9,
"name": "Rumah Ibadah",
"icon": "icon-rumah-ibadah",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 10,
"name": "Restoran",
"icon": "icon-restoran",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 11,
"name": "Bioskop",
"icon": "icon-bioskop",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 12,
"name": "Bar",
"icon": "icon-bar",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 13,
"name": "Halte",
"icon": "icon-halte",
"description": "",
"status": "Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 14,
"name": "Stasiun",
"icon": "icon-stasiun",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 15,
"name": "Bandara",
"icon": "icon-bandara",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 16,
"name": "SPBU",
"icon": "icon-spbu",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
},
{
"id": 17,
"name": "GYM",
"icon": "icon-gym",
"description": "",
"status": "Tidak Ada",
"createdAt": null,
"updatedAt": null
}
],
"contacts": {
"id": 0,
"assetId": 0,
"picName": "Destiari",
"picPhone": "0812349480",
"picEmail": "estiari@gmail.com",
"createdAt": null,
"updatedAt": null
},
"images": [
{
"id": 3117,
"filename":
"/v1/file?subdir=asset%2FLelang%2F2023%2F6%2F15%2F2023-06-15-
3d473d5c-harga-rumah-seken-02-finansialku.webp&filename=2023-06-
15-3d473d5c-harga-rumah-seken-02-finansialku.webp",
"path": "asset/Lelang/2023/6/15/2023-06-
15-3d473d5c-harga-rumah-seken-02-finansialku.webp",
"extension": "image/jpg",
"size": 30071
},
{
"id": 3118,
"filename":
"/v1/file?subdir=asset%2FLelang%2F2023%2F6%2F15%2F2023-06-15-
rumah-kontainer-juga-bisa-berdesain-estetik-lihat-yuk210910c.webp&filename=2023-06-15-rumah-kontainer-juga-bisaberdesain-estetik-lihat-yuk-210910c.webp",
"path": "asset/Lelang/2023/6/15/2023-06-
15-rumah-kontainer-juga-bisa-berdesain-estetik-lihat-yuk210910c.webp",
"extension": "image/jpg",
"size": 57449
},
{
"id": 3119,
"filename":
"/v1/file?subdir=asset%2FLelang%2F2023%2F6%2F15%2F2023-06-15-
0304aha_Belanja_Ruko_diNgresep_Ngemplak_Byl.webp&filename=2023-06-
15-0304aha_Belanja_Ruko_diNgresep_Ngemplak_Byl.webp",
"path": "asset/Lelang/2023/6/15/2023-06-
15-0304aha_Belanja_Ruko_diNgresep_Ngemplak_Byl.webp",
"extension": "image/jpg",
"size": 39602
},
{
"id": 3120,
"filename":
"/v1/file?subdir=asset%2FLelang%2F2023%2F6%2F15%2F2023-06-15-
3d473d5c-harga-rumah-seken-02-finansialku.webp&filename=2023-06-
15-3d473d5c-harga-rumah-seken-02-finansialku.webp",
"path": "asset/Lelang/2023/6/15/2023-06-
15-3d473d5c-harga-rumah-seken-02-finansialku.webp",
"extension": "image/jpg",
"size": 30071
}
],
"sharedCount": 0,
"views": 0,
"auctionDateTime": "",
"soldAt": "2023-12-11T16:40:29+07:00",
"isSoldOut": true,
"bookedStatus": false,
"bookedBy": "",
"bookedAt": ""
}
],
"page": 0,
"limit": 1,
"totalPage": 7,
"totalData": 7
}
}
Error Response :
{
"responseCode": "0100",
"responseMessage": "Format request not valid: map[sizeThe value must be
`int`]",
"responseData": null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
5. Booking / Unbooking Asset Lelang
Endpoint Description
Used to update the status of the Auction Asset to booked/cancel booking.
General Information
|
HTTP Method |
POST |
|---|---|
|
Path |
/v1.0/info-lelang/set-booked |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Request Structure & Sample
|
No |
Field Name |
Type |
Length |
Format |
Status |
Description |
|---|---|---|---|---|---|---|
|
1 |
assetId |
Numeric |
100000000 | Integer |
M |
ex: 1098 |
| 2 | statusBooked | Boolean | - | Boolean | M | ex: true,false |
| 3 | bookedAt | Datetime | - | Datetime | M | ex: 2023-10-26T16:23:55Z |
Response Structure & Sample
|
No |
Field Name |
Type |
Data Type |
Mandatory |
Example |
|---|---|---|---|---|---|
|
1 |
responseCode |
String |
Varchar | M |
|
| 2 | responseMessage |
String |
Varchar | M |
|
| 3 | responseData | Any | Object | M | Object, NULL |
Request & Response Payload Sample
Request
{
"assetId": 1461,
"statusBooked": false,
"bookedAt": "2023-10-27T10:20:00Z"
}
Normal Response :
{
"responseCode": "0000",
"responseMessage": "Berhasil mengubah status booking asset",
"responseData": null
}
Error Response :
{
"responseCode": "0100",
"responseMessage": "Update status booking lelang gagal, asset telah laku",
"responseData": null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
6. Set Souldout
Endpoint Description
Used to update the status of the Auction Asset to already sold.
General Information
|
HTTP Method |
POST |
|---|---|
|
Path |
/v1.0/info-lelang/set-soldout |
|
Tipe Format |
JSON |
|
Authentication |
OAuth 2.0 |
Header Structure & Sample
|
Key |
Value |
Mandatory |
Lenght |
Description |
|---|---|---|---|---|
|
Authorization |
Bearer {token} |
M |
N/A |
Access Token |
| BRI-Timestamp | timestamp | M | - | ISO 8601 format |
| BRI-Signature | signature | M | 64 | - |
| Content-Type | application/json | M | - | - |
Request Structure & Sample
|
No |
Field Name |
Type |
Length |
Format |
Status |
Description |
|---|---|---|---|---|---|---|
|
1 |
assetId |
Numeric |
100000000 | Integer |
M |
ex: 1098 |
| 2 | customerName | String | 100 | Varchar | M | |
| 3 | customerEmail | String | - | Varchar | M | |
| 4 | customerPhone | Numeric | 15 | Varchar | M | |
| 5 | soldPrice | Numeric | 14 digit | Integer | M | |
| 6 | soldNote | String | 255 | Varchar | M | |
| 7 | soldAt | String | - | Datetime | M | ex: 2023-10-26T16:23:55Z |
Response Structure & Sample
|
No |
Field Name |
Type |
Data Type |
Mandatory |
Example |
|---|---|---|---|---|---|
|
1 |
responseCode |
String |
Varchar | M |
|
| 2 | responseMessage |
String |
Varchar | M |
|
| 3 | responseData | Any | Object | M | Object, NULL |
Request & Response Payload Sample
Request
{
"assetId": 1461,
"customerName": "John",
"customerEmail": "doe@john.com",
"customerPhone": "087627234567",
"soldPrice": 300000000,
"soldNotes": "Note sold out",
"soldAt": "2023-10-26T17:57:10Z"
}
Normal Response :
{
"responseCode": "0000",
"responseMessage": "Berhasil mengubah asset menjadi soldout",
"responseData": null
}
Error Response :
{
"responseCode": "0100",
"responseMessage": "Update status soldout lelang gagal, asset telah laku",
"responseData": null
}
List of Error/Response Code
|
HTTP Status |
Error Code | Response Code | Response Message |
|---|---|---|---|
| 200 | 0000 | 0000 | Success |
| 400 | 0100 | 0100 | Validation Invalid |
| 400 | 0101 | 0101 | Authorization invalid |
List Category & Subcategory
|
id |
category_id | name |
|---|---|---|
| 1 | 1 | Rumah |
| 2 | 1 | Ruko |
| 3 | 1 | Apartemen |
| 4 | 1 | Condotel |
| 5 | 1 | Kos atau Kontrakan |
| 6 | 1 | Toko |
| 7 | 1 | Vila |
| 8 | 1 | Kios |
| 9 | 1 | Gudang |
| 10 | 1 | Hotel |
| 11 | 1 | Perkantoran |
| 12 | 1 | Mall |
| 13 | 1 | Pabrik |
| 14 | 3 | Kapal |
| 15 | 3 | Pesawat |
| 16 | 3 | Alat Berat |
| 17 | 3 | Mobil |
| 18 | 3 | Sepeda Motor |
| 19 | 3 | Truk |
| 20 | 3 | Bus |
| 21 | 4 | Mesin Cetak |
| 22 | 4 | Mesin Lainnya |
| 23 | 2 | Sawah |
| 24 | 2 | Tanah |
| 25 | 2 | Tanah Kebun |
| 26 | 2 | Kavling siap bangun |
| 27 | 5 | SPBU/SPBG |
