Socotra Producers API
The Producers API from Socotra — 31 operation(s) for producers.
The Producers API from Socotra — 31 operation(s) for producers.
openapi: 3.0.1
info:
title: Socotra Insurance Suite OpenAPI Definition Producers API
description: Socotra Insurance Suite API
termsOfService: https://www.socotra.com
version: v0
servers:
- url: /
description: Generated server url
tags:
- name: Producers
paths:
/producers/{tenantLocator}/producers/{producerLocator}:
get:
operationId: fetchProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- read
deprecated: false
tags:
- Producers
put:
operationId: replaceProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
patch:
operationId: updateProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}:
get:
operationId: fetchProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerLicenseLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- read
deprecated: false
tags:
- Producers
put:
operationId: replaceProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerLicenseLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseReplaceRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
patch:
operationId: updateProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerLicenseLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}:
get:
operationId: fetchProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- read
deprecated: false
tags:
- Producers
put:
operationId: replaceProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeReplaceRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
patch:
operationId: updateProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}:
get:
operationId: fetchProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerAppointmentLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- read
deprecated: false
tags:
- Producers
put:
operationId: replaceProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerAppointmentLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentReplaceRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
patch:
operationId: updateProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerAppointmentLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentUpdateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers:
post:
operationId: createProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/licenses:
post:
operationId: createProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes:
post:
operationId: createProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/set:
post:
operationId: setCodeByNumber
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: code
in: query
required: true
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/generate:
post:
operationId: generateCodeByNumber
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/appointments:
post:
operationId: createProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentCreateRequest'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/validate:
patch:
operationId: validateProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/unsuspend:
patch:
operationId: unsuspendProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/suspend:
patch:
operationId: suspendProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/retire:
patch:
operationId: retireProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/validate:
patch:
operationId: validateProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerLicenseLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/discard:
patch:
operationId: discardProducerLicense
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerLicenseLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerLicenseResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/discard:
patch:
operationId: discardProducer
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/validate:
patch:
operationId: validateProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/unsuspend:
patch:
operationId: unsuspendProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/suspend:
patch:
operationId: suspendProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/retire:
patch:
operationId: retireProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/discard:
patch:
operationId: discardProducerCode
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerCodeLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerCodeResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/validate:
patch:
operationId: validateProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerAppointmentLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/discard:
patch:
operationId: discardProducerAppointment
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: producerAppointmentLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerAppointmentResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- write
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{producerLocator}/producerHierarchy:
get:
operationId: fetchProducerHierarchy
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: producerLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProducerHierarchyResponse'
deprecated: false
x-securityGroup: producers
x-securityPermission:
- read
deprecated: false
tags:
- Producers
/producers/{tenantLocator}/producers/{pr
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-producers-api-openapi.yml