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
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
GET /producers/{tenantLocator}/producers/listRequest 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
GET /producers/{tenantLocator}/producers/{producerLocator}/producerHierarchyRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerHierarchyResponse
Security Group:producers  Permission:read
GET /producers/eventsResponse:ProducersEventTypeDefinitions
Security Group:public  Permission:public
POST /producers/{tenantLocator}/producersRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
Request:ProducerCreateRequest
Response:ProducerResponse
Security Group:producers  Permission:write
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
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
PATCH /producers/{tenantLocator}/producers/{producerLocator}/validateRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/discardRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/suspendRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/unsuspendRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/retireRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Response:ProducerResponse
Security Group:producers  Permission:write
Producer Codes
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
GET /producers/{tenantLocator}/producers/{producerLocator}/codes/listRequest 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
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
POST /producers/{tenantLocator}/producers/{producerLocator}/codesRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
Request:ProducerCodeCreateRequest
Response:ProducerCodeResponse
Security Group:producers  Permission:write
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
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
PATCH /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/validateRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/discardRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/suspendRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/unsuspendRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
PATCH /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/retireRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
POST /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/generateRequest Parameters:
| Name | Position | Type | Required |
|---|---|---|---|
| tenantLocator | path | uuid | required |
| producerLocator | path | string | required |
| producerCodeLocator | path | string | required |
Response:ProducerCodeResponse
Security Group:producers  Permission:write
POST /producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/setRequest 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
¶requiredlocator stringproducerState Enum draft | validated | suspended | discarded | retiredtype stringcreatedAt datetimecreatedBy uuidoptionalparentLocator string?validationResult ValidationResult?data map<string,object>?
ListPageResponseProducerResponse
¶requiredlistCompleted booleanitems ProducerResponse[]
ProducerHierarchyResponse
¶requiredlocator stringproducerState Enum draft | validated | suspended | discarded | retiredtype stringcreatedAt datetimecreatedBy uuidchildProducers ProducerHierarchyResponse[]optionalparentLocator string?validationResult ValidationResult?data map<string,object>?
ProducersEventTypeDefinitions
¶requiredproducerCodeEvents ProducerCodeEventsproducerEvents ProducerEvents
ProducerCodeEvents
¶optionalproducers.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
¶requiredproducerCodeLocator stringoptionalcode string?
ProducerEvents
¶optionalproducers.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
¶requiredproducerLocator string
ProducerCreateRequest
¶requiredtype stringoptionalparentLocator string?data map<string,object>?
ProducerUpdateRequest
¶requiredremoveData map<string,object>setData map<string,object>optionalparentLocator string?type string?
ProducerCodeResponse
¶requiredlocator stringproducerLocator stringproducerCodeState Enum draft | validated | suspended | discarded | retiredtype stringcreatedAt datetimecreatedBy uuidoptionalcode string?validationResult ValidationResult?data map<string,object>?
ListPageResponseProducerCodeResponse
¶requiredlistCompleted booleanitems ProducerCodeResponse[]
ProducerCodeCreateRequest
¶requiredtype stringoptionalcode string?data map<string,object>?
ProducerCodeUpdateRequest
¶requiredremoveData map<string,object>setData map<string,object>optionalproducerLocator string?code string?type string?
ProducerCodeReplaceRequest
¶requiredproducerLocator stringtype stringoptionalcode string?data map<string,object>?