API: Tender
- Shaon Karim (Unlicensed)
- Maciej Szewczyk
Owned by Shaon Karim (Unlicensed)
GET /api/v3/tender
Request parameter:
Filtering parameters:
| Parameter | Type | IN | Example | Description |
|---|---|---|---|---|
| branch | integer | QUERY | filters[branch]=34 | Filtering by branch id = value |
| contact | integer | QUERY | filters[contact]=123 | Filtering by tender insured contact id = value |
| policy | integer | QUERY | filters[policy]=334 | Filtering by policy id = value |
| status | integer | QUERY | filters[status]=2 | Filtering tender status id = value |
API: _ Default behavior #List defaults
Response data:
Metadata: object.
| Parameter | Type | Description |
|---|---|---|
| count | int | Number of all results marching criteria |
| status | int | Response status (same as in http code) |
Data: object.data[array]
| Parameter | Type | Description |
|---|---|---|
| id | integer | Tender id |
| contact | array | Tender API: Contact data |
| contact[id] | integer|null | Contact id |
| contact[name] | string|null | Contact name |
| contact[name_1] | string|null | Contact first name |
| contact[name_2] | string|null | Contact last name |
| branch | array | API: Branch |
| branch[id] | integer|null | Branch id |
| branch[name] | string|null | Branch name in DE language |
| branch[name_e] | string|null | Branch name in EN language |
| branch[name_i] | string|null | Branch name in IT language |
| branch[name_f] | string|null | Branch name in FR language |
| branch[short_name] | string|null | Branch short-name in DE language |
| branch[short_name_e] | string|null | Branch short-name in EN language |
| branch[short_name_i] | string|null | Branch short-name in IT language |
| branch[short_name_f] | string|null | Branch short-name in FR language |
| status | array | Tender status |
| status[id] | integer|null | Status id |
| status[name] | string|null | Status name in DE language |
| status[name_e] | string|null | Status name in EN language |
| status[name_i] | string|null | Status name in IT language |
| status[name_f] | string|null | Status name in FR language |
Response (Error):
| Parameter | Type | Description |
|---|---|---|
| code | integer | An error code |
| error | string | A message containing some information about the error |
| errors | array | List of errors devided by field in associative array {field_name:error message} |
API: _ Default behavior #Authentication defaults
Request
curl -X GET https://public.brokerstar.biz/api/v3/tender --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK
{
"count": "1",
"data": [
{
"contact": {
"name": "Allianz Suisse Versicherungs-Gesellschaft AG",
"name_1": "Allianz Suisse",
"name_2": "Versicherungs-Gesellschaft AG",
"id": 4
},
"status": {
"name_e": "open",
"name_f": "ouvert",
"name_i": "aperto",
"id": 1,
"name": "offen"
},
"branch": {
"name_e": "General technical equipment insurance",
"name_f": "Assurance des installations techniques (IT)",
"name_i": "Assicurazione di impianti tecnici",
"short_name": "ATA",
"short_name_e": "ATA",
"short_name_f": "ATA",
"short_name_i": "ATA",
"id": 1,
"name": "Allg. Technische Anlagen"
},
"id": 2
}
],
"status": 200
}
Or one of
- API: _ Default behavior #Authentication defaults
- API: _ Default behavior #List defaults
GET /api/v3/tender/{id}
Request parameter:
| Parameter | Type | In | Description |
|---|---|---|---|
| id | int | url | id of requested policy |
Response data:
Metadata: object.
| Parameter | Type | Description |
|---|---|---|
| status | int | Response status (same as in http code) |
Data: object.data
| Parameter | Type | Description |
|---|---|---|
| All columns from all tenders + | ||
Response (Error):
| Parameter | Type | Description |
|---|---|---|
| code | integer | An error code |
| error | string | A message containing some information about the error |
| errors | array | List of errors devided by field in associative array {field_name:error message} |
Request
curl -X GET https://public.brokerstar.biz/api/v3/tender/16448 --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK
{
"data": { {
"contact": {
"name": "Allianz Suisse Versicherungs-Gesellschaft AG",
"name_1": "Allianz Suisse",
"name_2": "Versicherungs-Gesellschaft AG",
"id": 4
},
"status": {
"name_e": "open",
"name_f": "ouvert",
"name_i": "aperto",
"id": 1,
"name": "offen"
},
"branch": {
"name_e": "General technical equipment insurance",
"name_f": "Assurance des installations techniques (IT)",
"name_i": "Assicurazione di impianti tecnici",
"short_name": "ATA",
"short_name_e": "ATA",
"short_name_f": "ATA",
"short_name_i": "ATA",
"id": 1,
"name": "Allg. Technische Anlagen"
},
"id": 2
},
"status": 200
}
Response (Error)
404 Not found
{
"error": "Entity not found",
"code": 404
}
Response (Error)
403 Forbidden
{
"error": "You have no access to contact id:123",
"code": 403
}
Or one of
- API: _ Default behavior #Authentication defaults