Producer Management API

Endpoint Index

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

fetchProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:read

Fetch Producers

fetchProducers

GET /producers/{tenantLocator}/producers/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseProducerResponse
Security Group:producers   Permissions:read,list

Fetch Producer Hierarchy

fetchProducerHierarchy

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerHierarchyResponse
Security Group:producers   Permission:read

Create Producer

createProducer

POST /producers/{tenantLocator}/producers

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:ProducerCreateRequest
Response:ProducerResponse
Security Group:producers   Permission:write

Update Producer

updateProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Request:ProducerUpdateRequest
Response:ProducerResponse
Security Group:producers   Permission:write

Replace Producer

replaceProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Request:ProducerCreateRequest
Response:ProducerResponse
Security Group:producers   Permission:write

Validate Producer

validateProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:write

Discard Producer

discardProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:write

Suspend Producer

suspendProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:write

Unsuspend Producer

unsuspendProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:write

Retire Producer

retireProducer

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Response:ProducerResponse
Security Group:producers   Permission:write

Producer Codes

Fetch Producer Code

fetchProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:read

Fetch Producer Codes

fetchProducerCodes

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseProducerCodeResponse
Security Group:producers   Permissions:read,list

Fetch Producer Code By Code

fetchProducerCodeByCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
code	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:read

Create Producer Code

createProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Request:ProducerCodeCreateRequest
Response:ProducerCodeResponse
Security Group:producers   Permission:write

Update Producer Code

updateProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Request:ProducerCodeUpdateRequest
Response:ProducerCodeResponse
Security Group:producers   Permission:write

Replace Producer Code

replaceProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Request:ProducerCodeReplaceRequest
Response:ProducerCodeResponse
Security Group:producers   Permission:write

Validate Producer Code

validateProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Discard Producer Code

discardProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Suspend Producer Code

suspendProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Unsuspend Producer Code

unsuspendProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Retire Producer Code

retireProducerCode

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Generate Code By Number

generateCodeByNumber

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Set Code By Number

setCodeByNumber

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerCodeLocator	path	string	required
code	query	string	required

Response:ProducerCodeResponse
Security Group:producers   Permission:write

Licenses

Fetch Producer License

fetchProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerLicenseLocator	path	string	required

Response:ProducerLicenseResponse
Security Group:producers   Permission:read

Fetch Producer Licenses

fetchProducerLicenses

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseProducerLicenseResponse
Security Group:producers   Permissions:read,list

Create Producer License

createProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Request:ProducerLicenseCreateRequest
Response:ProducerLicenseResponse
Security Group:producers   Permission:write

Update Producer License

updateProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerLicenseLocator	path	string	required

Request:ProducerLicenseUpdateRequest
Response:ProducerLicenseResponse
Security Group:producers   Permission:write

Replace Producer License

replaceProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerLicenseLocator	path	string	required

Request:ProducerLicenseReplaceRequest
Response:ProducerLicenseResponse
Security Group:producers   Permission:write

Validate Producer License

validateProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerLicenseLocator	path	string	required

Response:ProducerLicenseResponse
Security Group:producers   Permission:write

Discard Producer License

discardProducerLicense

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerLicenseLocator	path	string	required

Response:ProducerLicenseResponse
Security Group:producers   Permission:write

Appointments

Fetch Producer Appointment

fetchProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerAppointmentLocator	path	string	required

Response:ProducerAppointmentResponse
Security Group:producers   Permission:read

Fetch Producer Appointments

fetchProducerAppointments

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseProducerAppointmentResponse
Security Group:producers   Permissions:read,list

Create Producer Appointment

createProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required

Request:ProducerAppointmentCreateRequest
Response:ProducerAppointmentResponse
Security Group:producers   Permission:write

Update Producer Appointment

updateProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerAppointmentLocator	path	string	required

Request:ProducerAppointmentUpdateRequest
Response:ProducerAppointmentResponse
Security Group:producers   Permission:write

Replace Producer Appointment

replaceProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerAppointmentLocator	path	string	required

Request:ProducerAppointmentReplaceRequest
Response:ProducerAppointmentResponse
Security Group:producers   Permission:write

Validate Producer Appointment

validateProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerAppointmentLocator	path	string	required

Response:ProducerAppointmentResponse
Security Group:producers   Permission:write

Discard Producer Appointment

discardProducerAppointment

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
producerLocator	path	string	required
producerAppointmentLocator	path	string	required

Response:ProducerAppointmentResponse
Security Group:producers   Permission:write

ProducerResponse

required
locator string
producerState Enum draft | validated | suspended | discarded | retired
type string
createdAt datetime
createdBy uuid

optional
parentLocator string?
validationResult ValidationResult?
data map<string,object>?

ListPageResponseProducerResponse

required
listCompleted boolean
items ProducerResponse[]

ProducerHierarchyResponse

required
locator string
producerState Enum draft | validated | suspended | discarded | retired
type string
createdAt datetime
createdBy uuid
childProducers ProducerHierarchyResponse[]

optional
parentLocator string?
validationResult ValidationResult?
data map<string,object>?

ProducerCreateRequest

required
type string

optional
parentLocator string?
data map<string,object>?

ProducerUpdateRequest

required
removeData map<string,object>
setData map<string,object>

optional
parentLocator string?
type string?

ProducerCodeResponse

required
locator string
producerLocator string
producerCodeState Enum draft | validated | suspended | discarded | retired
type string
createdAt datetime
createdBy uuid

optional
code string?
validationResult ValidationResult?
data map<string,object>?

ListPageResponseProducerCodeResponse

required
listCompleted boolean
items ProducerCodeResponse[]

ProducerCodeCreateRequest

required
type string

optional
code string?
data map<string,object>?

ProducerCodeUpdateRequest

required
removeData map<string,object>
setData map<string,object>

optional
producerLocator string?
code string?
type string?

ProducerCodeReplaceRequest

required
producerLocator string
type string

optional
code string?
data map<string,object>?

ProducerLicenseResponse

required
locator string
producerLocator string
producerLicenseState Enum draft | validated | discarded
type string
createdAt datetime
createdBy uuid
jurisdictions string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
expirationTime datetime?
licenseNumber string?
validationResult ValidationResult?
data map<string,object>?

ListPageResponseProducerLicenseResponse

required
listCompleted boolean
items ProducerLicenseResponse[]

ProducerLicenseCreateRequest

required
type string
jurisdictions string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
expirationTime datetime?
licenseNumber string?
data map<string,object>?

ProducerLicenseUpdateRequest

required
removeData map<string,object>
setData map<string,object>

optional
producerLocator string?
effectiveTime datetime?
expirationTime datetime?
licenseNumber string?
type string?
jurisdictions string[]?
producerCodes string[]?
products string[]?

ProducerLicenseReplaceRequest

required
producerLocator string
type string
jurisdictions string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
expirationTime datetime?
licenseNumber string?
data map<string,object>?

ProducerAppointmentResponse

required
locator string
producerLocator string
producerAppointmentState Enum draft | validated | discarded
type string
createdAt datetime
createdBy uuid
jurisdictions string[]
licenses string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
appointmentNumber string?
expirationTime datetime?
validationResult ValidationResult?
data map<string,object>?

ListPageResponseProducerAppointmentResponse

required
listCompleted boolean
items ProducerAppointmentResponse[]

ProducerAppointmentCreateRequest

required
type string
jurisdictions string[]
licenses string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
appointmentNumber string?
expirationTime datetime?
data map<string,object>?

ProducerAppointmentUpdateRequest

required
removeData map<string,object>
setData map<string,object>

optional
producerLocator string?
effectiveTime datetime?
appointmentNumber string?
expirationTime datetime?
type string?
jurisdictions string[]?
licenses string[]?
producerCodes string[]?
products string[]?

ProducerAppointmentReplaceRequest

required
producerLocator string
type string
jurisdictions string[]
licenses string[]
producerCodes string[]
products string[]

optional
effectiveTime datetime?
appointmentNumber string?
expirationTime datetime?
data map<string,object>?