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
Fetch Producers Event Definitions	GET /producers/events
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

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

Fetch Producers Event Definitions

fetchProducersEventDefinitions

GET /producers/events

Response:ProducersEventTypeDefinitions
Security Group:public   Permission:public

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

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>?

ProducersEventTypeDefinitions

required
producerCodeEvents ProducerCodeEvents
producerEvents ProducerEvents

ProducerCodeEvents

optional
producers.producercode.create ProducerCodeEventData?
producers.producercode.discard ProducerCodeEventData?
producers.producercode.numberAssignmentFailed ProducerCodeEventData?
producers.producercode.retire ProducerCodeEventData?
producers.producercode.suspend ProducerCodeEventData?
producers.producercode.unsuspend ProducerCodeEventData?
producers.producercode.update ProducerCodeEventData?
producers.producercode.validate ProducerCodeEventData?

ProducerCodeEventData

required
producerCodeLocator string

optional
code string?

ProducerEvents

optional
producers.producer.create ProducerEventData?
producers.producer.discard ProducerEventData?
producers.producer.retire ProducerEventData?
producers.producer.suspend ProducerEventData?
producers.producer.unsuspend ProducerEventData?
producers.producer.update ProducerEventData?
producers.producer.validate ProducerEventData?

ProducerEventData

required
producerLocator string

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>?