API: Branch

Owned by Shaon Karim (Unlicensed)

Jan. 20, 2023

3 min read

GET /api/v3/branch

Request parameter:

No Request parameter

This list has no filtering options

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	int	Policy-Branch ID
name	string	Policy-Branch name in language DE
name_e	string\|null	Policy-Branch name in language EN
name_i	string\|null	Policy-Branch name in language IT
name_f	string\|null	Policy-Branch name in language FR
short_name	string	Policy-Branch short name in language DE
short_name_e	string\|null	Policy-Branch short name in language EN
short_name_i	string\|null	Policy-Branch short name in language IT
short_name_f	string\|null	Policy-Branch short name in language FR

Response (Error):

/wiki/spaces/BROK/pages/693181 #List defaults

/wiki/spaces/BROK/pages/693181 #Authentication defaults

Request

curl -X GET https://public.brokerstar.biz/api/v3/branch --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'

Response (Success)

200 OK   
{
    "count": "71",
    "data": [
        {
            "name_e": "General technical equipment insurance",
            "name_f": "Assurance des installations techniques",
            "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"
        },
        [...]
	]
    "status": 200
}

Or one of

/wiki/spaces/BROK/pages/693181 #Authentication defaults
/wiki/spaces/BROK/pages/693181 #List defaults

GET /api/v3/branch/{id}

Request parameter:

No Request parameter

This list has no filtering options

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
All from branch list +
type	array	Policy branch type info
type[id]	id	Type id
type[name]	string	Type name in DE language
type[name_e]	string\|null	Type name in EN language
type[name_i]	string\|null	Type name in IT language
type[name_f]	string\|null	Type name in FR language
type[short_name]	string	Type short name - used to define eg. Claim type
bw_type	array	Policy branch type info
bw_type[id]	id	BrokerWeb Type id
bw_type[name]	string	BrokerWeb Type name in DE language
bw_type[name_e]	string\|null	BrokerWeb Type name in EN language
bw_type[name_i]	string\|null	BrokerWeb Type name in IT language
bw_type[name_f]	string\|null	BrokerWeb Type name in FR language
bw_type[short_name]	string	BrokerWeb Type short name in DE language
bw_type[short_name_e]	string	BrokerWeb Type short name in EN language
bw_type[short_name_i]	string	BrokerWeb Type short name in IT language
bw_type[short_name_f]	string	BrokerWeb Type short name in FR language

Response (Error):

/wiki/spaces/BROK/pages/693181 #Item defaults

Request

curl -X GET https://public.brokerstar.biz/api/v3/branch/1 --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'

Response (Success)

200 OK  {
    "data": {
        "name": "Allg. Technische Anlagen",
        "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",
        "type": {
            "name_e": "Personal Liability",
            "name_f": "Assurance Responsabilité civile privée",
            "name_i": "Assicurazione di responsabilità civile",
            "short_name": "PH",
            "id": 3,
            "name": "Privathaftpflicht"
        },
        "bw_type": {
            "name_e": null,
            "name_f": null,
            "name_i": null,
            "short_name": null,
            "short_name_e": null,
            "short_name_f": null,
            "short_name_i": null,
            "id": null,
            "name": null
        },
        "id": 1
    },
    "status": 200
}

Response (Error)

404 Not found
{
	"error": "Entity not found",
	"code": 404
}

Or one of

/wiki/spaces/BROK/pages/693181 #Authentication defaults