Skip to main content
POST
/
view-specific
/
{brokerageFirmId}
/
derogations
List brokerage firm derogations
curl --request POST \
  --url https://api.example.com/view-specific/{brokerageFirmId}/derogations \
  --header 'Content-Type: application/json' \
  --data '
{
  "statuses": [],
  "brokerageFirmName": "<string>",
  "queryString": "<string>",
  "productIds": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/view-specific/{brokerageFirmId}/derogations"

payload = {
"statuses": [],
"brokerageFirmName": "<string>",
"queryString": "<string>",
"productIds": ["<string>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
statuses: [],
brokerageFirmName: '<string>',
queryString: '<string>',
productIds: ['<string>']
})
};

fetch('https://api.example.com/view-specific/{brokerageFirmId}/derogations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/view-specific/{brokerageFirmId}/derogations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'statuses' => [

],
'brokerageFirmName' => '<string>',
'queryString' => '<string>',
'productIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/view-specific/{brokerageFirmId}/derogations"

payload := strings.NewReader("{\n \"statuses\": [],\n \"brokerageFirmName\": \"<string>\",\n \"queryString\": \"<string>\",\n \"productIds\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/view-specific/{brokerageFirmId}/derogations")
.header("Content-Type", "application/json")
.body("{\n \"statuses\": [],\n \"brokerageFirmName\": \"<string>\",\n \"queryString\": \"<string>\",\n \"productIds\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/view-specific/{brokerageFirmId}/derogations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"statuses\": [],\n \"brokerageFirmName\": \"<string>\",\n \"queryString\": \"<string>\",\n \"productIds\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "customers": [
        {
          "type": "<string>",
          "id": "<string>",
          "createdAt": "<string>",
          "lastModifiedAt": "<string>",
          "policies": [
            "<string>"
          ],
          "invoices": [
            "<string>"
          ],
          "role": "<string>",
          "customFields": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "name": "<string>",
          "preferredPaymentMethodId": "<string>"
        }
      ],
      "policy": {
        "claimsHistory": [
          {
            "year": 123,
            "claimsNumber": 123,
            "fleetSize": 123
          }
        ],
        "owners": [
          {
            "userId": "<string>",
            "email": "<string>",
            "roles": [
              {
                "productId": "<string>",
                "roleId": "<string>"
              }
            ]
          }
        ],
        "type": "<string>",
        "id": "<string>",
        "productId": "<string>",
        "createdAt": "<string>",
        "lastModifiedAt": "<string>",
        "assets": [
          "<string>"
        ],
        "customers": [
          "<string>"
        ],
        "periodDuration": {
          "amount": 123
        },
        "invoicingConfig": {
          "earlyPayment": {
            "amount": 123
          }
        },
        "customFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "name": "<string>",
        "parent": "<string>",
        "brokerageFirm": "<string>",
        "incrementalId": 123,
        "externalId": "<string>",
        "author": {
          "firstName": "<string>",
          "lastName": "<string>",
          "userId": "<string>",
          "email": "<string>",
          "brokerRole": "<string>"
        },
        "signedAt": "<string>",
        "startedAt": "<string>",
        "endedAt": "<string>",
        "stoppedAt": "<string>",
        "suspendedAt": "<string>",
        "reactivatedAt": "<string>",
        "acceptedEmailDomains": [
          "<string>"
        ],
        "acceptedQuoteOptions": {
          "availableConfigs": [
            {
              "tier": "<string>",
              "excess": "<string>",
              "perils": [
                {
                  "id": "<string>",
                  "required": true,
                  "options": [
                    "<string>"
                  ],
                  "showWhen": {
                    "fieldKey": "<string>",
                    "fieldValue": "<string>",
                    "condition": "<string>",
                    "value": "<string>"
                  }
                }
              ]
            }
          ],
          "defaultConfig": {
            "tier": "<string>",
            "excess": "<string>",
            "perils": [
              {
                "id": "<string>",
                "option": "<string>",
                "available": true,
                "unavailabilityMessage": "<string>"
              }
            ]
          }
        },
        "additionalQuoteComponents": {
          "id": "<string>",
          "premium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          }
        },
        "quote": {
          "id": "<string>",
          "entityId": "<string>",
          "provider": {
            "id": "<string>",
            "version": "<string>"
          },
          "rates": [
            {
              "id": "<string>",
              "rate": 123,
              "inputs": [
                {
                  "id": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "totalPremium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "components": [
            {
              "id": "<string>",
              "premium": {
                "amountPreFeesAndTaxes": 123,
                "fees": [
                  {
                    "id": "<string>",
                    "amount": 123,
                    "brokerageFirmId": "<string>"
                  }
                ],
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "taxes": [
                  {
                    "id": "<string>",
                    "amount": 123
                  }
                ],
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              }
            }
          ],
          "basePrice": 123
        },
        "proratedQuote": {
          "id": "<string>",
          "entityId": "<string>",
          "provider": {
            "id": "<string>",
            "version": "<string>"
          },
          "rates": [
            {
              "id": "<string>",
              "rate": 123,
              "inputs": [
                {
                  "id": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "totalPremium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "components": [
            {
              "id": "<string>",
              "premium": {
                "amountPreFeesAndTaxes": 123,
                "fees": [
                  {
                    "id": "<string>",
                    "amount": 123,
                    "brokerageFirmId": "<string>"
                  }
                ],
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "taxes": [
                  {
                    "id": "<string>",
                    "amount": 123
                  }
                ],
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              }
            }
          ],
          "basePrice": 123
        },
        "maximumNumberOfBikes": 123,
        "selectedTier": {},
        "stop": {
          "reason": "<string>",
          "details": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "createdAt": "<string>"
        },
        "brokerageFees": [
          {
            "brokerageFirmId": "<string>",
            "fee": 50
          }
        ]
      },
      "hasOpenedClientAccount": true,
      "derogation": {
        "id": "<string>",
        "policyId": "<string>",
        "branchId": "<string>",
        "createdAt": "<string>"
      },
      "brokerageFirm": {
        "id": "<string>",
        "companyInfo": {
          "siret": "<string>",
          "siren": "<string>",
          "nafCode": "<string>",
          "nafLabel": "<string>",
          "name": "<string>",
          "creationDate": "<string>",
          "location": {
            "city": "<string>",
            "country": "<string>",
            "address": "<string>",
            "postCode": "<string>"
          },
          "legalStatus": {
            "1": "<string>",
            "2": "<string>",
            "3": "<string>"
          },
          "headcount": "<string>"
        },
        "customFields": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      },
      "branch": {
        "branchId": "<string>",
        "createdAt": "<string>",
        "mergedAt": "<string>",
        "derogations": [
          {
            "derogationId": "<string>",
            "createdAt": "<string>"
          }
        ]
      }
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId
string
required

Query Parameters

count
number
default:10

the number of items to return

page
number
default:1

the page to retrieve

Body

application/json
statuses
enum<string>[]
Available options:
PENDING,
DECLINED,
APPROVED,
CREATED,
APPROVED,
DENIED
brokerageFirmName
string

Brokerage firm name

queryString
string

Full text search

productIds
string[]

Product ids

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages