API: Tender-Offer
GET /api/v3/tender-offer
Request parameter:
Filtering parameters:
Parameter | Type | IN | Example | Description |
---|---|---|---|---|
tender | integer | QUERY | filters[tender]=34 | Filtering by tender id = value |
accepted | boolean | QUERY | filters[accepted]=1 | Filtering by offer is accepted (0=no, 1=yes) |
valid_to_date | string | QUERY | filters[valid_to_date]=2022-06-09 | Filtering by date = value |
valid_to_date | array[from] | QUERY | filters[valid_to_date][from]=2022-06-09 | Filtering by date >= from |
valid_to_date | array[to] | QUERY | filters[valid_to_date][to]=2022-06-09 | Filtering by date <= to |
valid_to_date | array[from,to] | QUERY | filters[valid_to_date][from]=2022-06-09&filters[valid_to_date][to]=2022-06-09 | Filtering by date between from and to |
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 | Offer id |
nr | string|null | Offer nr |
valid_to_date | string(date)|null | Offer valid to date |
netto_amount | string(float)|null | Offer netto amount |
brutto_amount | string(float)|null | Offer brutto amount |
remarks | string|null | Offer remarks |
is_accepted | boolean | Is offer accepted |
contact | array | Offer insured person 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 |
insurance | array | Offer insurant API: Contact data |
insurance[id] | integer|null | Contact id |
insurance[name] | string|null | Contact name |
insurance[name_1] | string|null | Contact first name |
insurance[name_2] | string|null | Contact last name |
policies | array | /wiki/spaces/BROK/pages/693051 related to offer |
policies[id] | integer|null | Policy id |
tender | array | Related /wiki/spaces/BROK/pages/693747 |
tender[id] | integer|null | Status id |
attachment | array | Offer related attachment API: File |
attachment[id] | string|null | File id |
attachment[name] | string|null | File name |
attachment[size] | string|null | File size in bytes |
attachment[created_at] | string(date) | File creation date |
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} |
/wiki/spaces/BROK/pages/693181 #Authentication defaults
Request
curl -X GET https://public.brokerstar.biz/api/v3/tender-offer --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "count": "1", "data": [ { "valid_to_date": "2022-12-30T00:00:00+01:00", "netto_amount": "12312.00", "brutto_amount": "3213.00", "remarks": null, "is_accepted": true, "policies": { "id": 5 }, "tender": { "id": 2 }, "contact": { "name": "Allianz Suisse Versicherungs-Gesellschaft AG", "name_1": "Allianz Suisse", "name_2": "Versicherungs-Gesellschaft AG", "id": 4 }, "insurance": { "name": "Allianz Suisse Versicherungs-Gesellschaft AG", "name_1": "Basler", "name_2": "Versicherung AG", "id": 7 }, "attachment": { "created_at": null, "id": null, "name": null, "size": null }, "id": 5, "nr": "33" } ], "status": 200 }
Or one of
- /wiki/spaces/BROK/pages/693181 #Authentication defaults
- /wiki/spaces/BROK/pages/693181 #List defaults
GET /api/v3/tender-offer/{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 offers + | ||
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-offer/16448 --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "data": { "valid_to_date": null, "netto_amount": "123.00", "brutto_amount": "123.00", "remarks": "123", "is_accepted": false, "policies": { "id": null }, "tender": { "id": 2 }, "contact": { "name": "Allianz Suisse Versicherungs-Gesellschaft AG", "name_1": "Allianz Suisse", "name_2": "Versicherungs-Gesellschaft AG", "id": 4 }, "insurance": { "name": "Allianz Suisse Versicherungs-Gesellschaft AG", "name_1": "Basler", "name_2": "Versicherung AG", "id": 7 }, "attachment": { "created_at": "2022-11-29T14:24:10+01:00", "id": 90, "name": "logo-file.png", "size": 8973 }, "id": 4, "nr": "12" }, "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
- /wiki/spaces/BROK/pages/693181 #Authentication defaults
POST /api/v3/tender-offer/{id}/accept
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) |
message | string | Additional info |
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-offer/16448/accept --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "status": 200, "message": "Status changed to accepted" }
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
- /wiki/spaces/BROK/pages/693181 #Authentication defaults
POST /api/v3/tender-offer/{id}/reject
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) |
message | string | Additional info |
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-offer/16448/reject --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "status": 200, "message": "Status changed to rejected" }
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
- /wiki/spaces/BROK/pages/693181 #Authentication defaults