Producer Management API

Action	Endpoint
Fetch Producer	GET/producers/{tenantLocator}/producers/{producerLocator}
Fetch Producers	GET/producers/{tenantLocator}/producers/list
Fetch Producer Hierarchy	GET/producers/{tenantLocator}/producers/{producerLocator}/producerHierarchy
Create Producer	POST/producers/{tenantLocator}/producers
Update Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}
Replace Producer	PUT/producers/{tenantLocator}/producers/{producerLocator}
Validate Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}/validate
Discard Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}/discard
Suspend Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}/suspend
Unsuspend Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}/unsuspend
Retire Producer	PATCH/producers/{tenantLocator}/producers/{producerLocator}/retire
Fetch Producer Code	GET/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
Fetch Producer Codes	GET/producers/{tenantLocator}/producers/{producerLocator}/codes/list
Fetch Producer Code By Code	GET/producers/{tenantLocator}/producers/codes/{code}
Create Producer Code	POST/producers/{tenantLocator}/producers/{producerLocator}/codes
Update Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
Replace Producer Code	PUT/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
Validate Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/validate
Discard Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/discard
Suspend Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/suspend
Unsuspend Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/unsuspend
Retire Producer Code	PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/retire
Generate Code By Number	POST/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/generate
Set Code By Number	POST/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/set
Fetch Producer License	GET/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
Fetch Producer Licenses	GET/producers/{tenantLocator}/producers/{producerLocator}/licenses/list
Create Producer License	POST/producers/{tenantLocator}/producers/{producerLocator}/licenses
Update Producer License	PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
Replace Producer License	PUT/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
Validate Producer License	PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/validate
Discard Producer License	PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/discard
Fetch Producer Appointment	GET/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
Fetch Producer Appointments	GET/producers/{tenantLocator}/producers/{producerLocator}/appointments/list
Create Producer Appointment	POST/producers/{tenantLocator}/producers/{producerLocator}/appointments
Update Producer Appointment	PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
Replace Producer Appointment	PUT/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
Validate Producer Appointment	PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/validate
Discard Producer Appointment	PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/discard

Producers

Fetch Producer

Fetch ProducerfetchProducer

GET/producers/{tenantLocator}/producers/{producerLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

read

Fetch Producers

Fetch ProducersfetchProducers

GET/producers/{tenantLocator}/producers/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseProducerResponse

Security Group:producers

Permissions:

read,list

Fetch Producer Hierarchy

Fetch Producer HierarchyfetchProducerHierarchy

GET/producers/{tenantLocator}/producers/{producerLocator}/producerHierarchy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerHierarchyResponse

Security Group:producers

Permission:

read

Create Producer

Create ProducercreateProducer

POST/producers/{tenantLocator}/producers

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:ProducerCreateRequest

Response:ProducerResponse

Security Group:producers

Permission:

write

Update Producer

Update ProducerupdateProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Request:ProducerUpdateRequest

Response:ProducerResponse

Security Group:producers

Permission:

write

Replace Producer

Replace ProducerreplaceProducer

PUT/producers/{tenantLocator}/producers/{producerLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Request:ProducerCreateRequest

Response:ProducerResponse

Security Group:producers

Permission:

write

Validate Producer

Validate ProducervalidateProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}/validate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

write

Discard Producer

Discard ProducerdiscardProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}/discard

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

write

Suspend Producer

Suspend ProducersuspendProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}/suspend

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

write

Unsuspend Producer

Unsuspend ProducerunsuspendProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}/unsuspend

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

write

Retire Producer

Retire ProducerretireProducer

PATCH/producers/{tenantLocator}/producers/{producerLocator}/retire

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Response:ProducerResponse

Security Group:producers

Permission:

write

Producer Codes

Fetch Producer Code

Fetch Producer CodefetchProducerCode

GET/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

read

Fetch Producer Codes

Fetch Producer CodesfetchProducerCodes

GET/producers/{tenantLocator}/producers/{producerLocator}/codes/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseProducerCodeResponse

Security Group:producers

Permissions:

read,list

Fetch Producer Code By Code

Fetch Producer Code By CodefetchProducerCodeByCode

GET/producers/{tenantLocator}/producers/codes/{code}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`code`	path	`string`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

read

Create Producer Code

Create Producer CodecreateProducerCode

POST/producers/{tenantLocator}/producers/{producerLocator}/codes

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Request:ProducerCodeCreateRequest

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Update Producer Code

Update Producer CodeupdateProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Request:ProducerCodeUpdateRequest

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Replace Producer Code

Replace Producer CodereplaceProducerCode

PUT/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Request:ProducerCodeReplaceRequest

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Validate Producer Code

Validate Producer CodevalidateProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/validate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Discard Producer Code

Discard Producer CodediscardProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/discard

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Suspend Producer Code

Suspend Producer CodesuspendProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/suspend

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Unsuspend Producer Code

Unsuspend Producer CodeunsuspendProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/unsuspend

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Retire Producer Code

Retire Producer CoderetireProducerCode

PATCH/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/retire

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Generate Code By Number

Generate Code By NumbergenerateCodeByNumber

POST/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/generate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Set Code By Number

Set Code By NumbersetCodeByNumber

POST/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerCodeLocator`	path	`ulid`	Yes
`code`	query	`string`	Yes

Response:ProducerCodeResponse

Security Group:producers

Permission:

write

Licenses

Fetch Producer License

Fetch Producer LicensefetchProducerLicense

GET/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerLicenseLocator`	path	`ulid`	Yes

Response:ProducerLicenseResponse

Security Group:producers

Permission:

read

Fetch Producer Licenses

Fetch Producer LicensesfetchProducerLicenses

GET/producers/{tenantLocator}/producers/{producerLocator}/licenses/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseProducerLicenseResponse

Security Group:producers

Permissions:

read,list

Create Producer License

Create Producer LicensecreateProducerLicense

POST/producers/{tenantLocator}/producers/{producerLocator}/licenses

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Request:ProducerLicenseCreateRequest

Response:ProducerLicenseResponse

Security Group:producers

Permission:

write

Update Producer License

Update Producer LicenseupdateProducerLicense

PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerLicenseLocator`	path	`ulid`	Yes

Request:ProducerLicenseUpdateRequest

Response:ProducerLicenseResponse

Security Group:producers

Permission:

write

Replace Producer License

Replace Producer LicensereplaceProducerLicense

PUT/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerLicenseLocator`	path	`ulid`	Yes

Request:ProducerLicenseReplaceRequest

Response:ProducerLicenseResponse

Security Group:producers

Permission:

write

Validate Producer License

Validate Producer LicensevalidateProducerLicense

PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/validate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerLicenseLocator`	path	`ulid`	Yes

Response:ProducerLicenseResponse

Security Group:producers

Permission:

write

Discard Producer License

Discard Producer LicensediscardProducerLicense

PATCH/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/discard

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerLicenseLocator`	path	`ulid`	Yes

Response:ProducerLicenseResponse

Security Group:producers

Permission:

write

Appointments

Fetch Producer Appointment

Fetch Producer AppointmentfetchProducerAppointment

GET/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerAppointmentLocator`	path	`ulid`	Yes

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

read

Fetch Producer Appointments

Fetch Producer AppointmentsfetchProducerAppointments

GET/producers/{tenantLocator}/producers/{producerLocator}/appointments/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseProducerAppointmentResponse

Security Group:producers

Permissions:

read,list

Create Producer Appointment

Create Producer AppointmentcreateProducerAppointment

POST/producers/{tenantLocator}/producers/{producerLocator}/appointments

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes

Request:ProducerAppointmentCreateRequest

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

write

Update Producer Appointment

Update Producer AppointmentupdateProducerAppointment

PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerAppointmentLocator`	path	`ulid`	Yes

Request:ProducerAppointmentUpdateRequest

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

write

Replace Producer Appointment

Replace Producer AppointmentreplaceProducerAppointment

PUT/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerAppointmentLocator`	path	`ulid`	Yes

Request:ProducerAppointmentReplaceRequest

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

write

Validate Producer Appointment

Validate Producer AppointmentvalidateProducerAppointment

PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/validate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerAppointmentLocator`	path	`ulid`	Yes

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

write

Discard Producer Appointment

Discard Producer AppointmentdiscardProducerAppointment

PATCH/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/discard

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`producerLocator`	path	`ulid`	Yes
`producerAppointmentLocator`	path	`ulid`	Yes

Response:ProducerAppointmentResponse

Security Group:producers

Permission:

write

ProducerResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`producerState`	`Enum draft \| validated \| suspended \| discarded \| retired`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`validationResult`	`ValidationResult?`
`data`	`map<string, object>?`

ListPageResponseProducerResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ProducerResponse[]`

ProducerHierarchyResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`producerState`	`Enum draft \| validated \| suspended \| discarded \| retired`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`childProducers`	`ProducerHierarchyResponse[]`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`validationResult`	`ValidationResult?`
`data`	`map<string, object>?`

ProducerCreateRequest

Required properties

Property	Type	Description
`type`	`string`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`data`	`map<string, object>?`

ProducerUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`type`	`string?`

ProducerCodeResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`producerLocator`	`ulid`
`producerCodeState`	`Enum draft \| validated \| suspended \| discarded \| retired`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`code`	`string?`
`validationResult`	`ValidationResult?`
`data`	`map<string, object>?`

ListPageResponseProducerCodeResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ProducerCodeResponse[]`

ProducerCodeCreateRequest

Required properties

Property	Type	Description
`type`	`string`

Optional properties

Property	Type	Description
`code`	`string?`
`data`	`map<string, object>?`

ProducerCodeUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`producerLocator`	`ulid?`
`code`	`string?`
`type`	`string?`

ProducerCodeReplaceRequest

Required properties

Property	Type	Description
`producerLocator`	`ulid`
`type`	`string`

Optional properties

Property	Type	Description
`code`	`string?`
`data`	`map<string, object>?`

ProducerLicenseResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`producerLocator`	`ulid`
`producerLicenseState`	`Enum draft \| validated \| discarded`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`jurisdictions`	`string[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`expirationTime`	`datetime?`
`licenseNumber`	`string?`
`validationResult`	`ValidationResult?`
`data`	`map<string, object>?`

ListPageResponseProducerLicenseResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ProducerLicenseResponse[]`

ProducerLicenseCreateRequest

Required properties

Property	Type	Description
`type`	`string`
`jurisdictions`	`string[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`expirationTime`	`datetime?`
`licenseNumber`	`string?`
`data`	`map<string, object>?`

ProducerLicenseUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`producerLocator`	`ulid?`
`effectiveTime`	`datetime?`
`expirationTime`	`datetime?`
`licenseNumber`	`string?`
`type`	`string?`
`jurisdictions`	`string[]?`
`producerCodes`	`string[]?`
`products`	`string[]?`

ProducerLicenseReplaceRequest

Required properties

Property	Type	Description
`producerLocator`	`ulid`
`type`	`string`
`jurisdictions`	`string[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`expirationTime`	`datetime?`
`licenseNumber`	`string?`
`data`	`map<string, object>?`

ProducerAppointmentResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`producerLocator`	`ulid`
`producerAppointmentState`	`Enum draft \| validated \| discarded`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`jurisdictions`	`string[]`
`licenses`	`ulid[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`appointmentNumber`	`string?`
`expirationTime`	`datetime?`
`validationResult`	`ValidationResult?`
`data`	`map<string, object>?`

ListPageResponseProducerAppointmentResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`ProducerAppointmentResponse[]`

ProducerAppointmentCreateRequest

Required properties

Property	Type	Description
`type`	`string`
`jurisdictions`	`string[]`
`licenses`	`ulid[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`appointmentNumber`	`string?`
`expirationTime`	`datetime?`
`data`	`map<string, object>?`

ProducerAppointmentUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Optional properties

Property	Type	Description
`producerLocator`	`ulid?`
`effectiveTime`	`datetime?`
`appointmentNumber`	`string?`
`expirationTime`	`datetime?`
`type`	`string?`
`jurisdictions`	`string[]?`
`licenses`	`ulid[]?`
`producerCodes`	`string[]?`
`products`	`string[]?`

ProducerAppointmentReplaceRequest

Required properties

Property	Type	Description
`producerLocator`	`ulid`
`type`	`string`
`jurisdictions`	`string[]`
`licenses`	`ulid[]`
`producerCodes`	`string[]`
`products`	`string[]`

Optional properties

Property	Type	Description
`effectiveTime`	`datetime?`
`appointmentNumber`	`string?`
`expirationTime`	`datetime?`
`data`	`map<string, object>?`

Producer Management API

On this page