partners
Operations addressed under /partners — 6 operations.
aurax-bff-redirect-get-partner-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<PartnerDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
Description | string | no |
Config | Dictionary<string, object> | no |
IsActive | bool | no |
ChannelDefinitionId | Guid? | yes |
Email | string | no |
PhoneNumber | string | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-partner-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-create-partner
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target create-partner-bpm; this entry declares none of its own.
aurax-bff-redirect-create-partner › Request Body
codeemailisActivenamephoneNumberchannelDefinitionIdconfigdescriptionaurax-bff-redirect-create-partner › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-partner-by-code
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PartnerDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
Description | string | no |
Config | Dictionary<string, object> | no |
IsActive | bool | no |
ChannelDefinitionId | Guid? | yes |
Email | string | no |
PhoneNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_160 | 400 | PartnerIsNotFound | Partner cannot be found. |
path Parameters
codePresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-partner-by-code › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-partner-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as PartnerDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
Description | string | no |
Config | Dictionary<string, object> | no |
IsActive | bool | no |
ChannelDefinitionId | Guid? | yes |
Email | string | no |
PhoneNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_160 | 400 | PartnerIsNotFound | Partner cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-partner-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-update-partner
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target update-partner-bpm; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-update-partner › Request Body
codeemailisActivenamephoneNumberchannelDefinitionIdconfigdescriptionaurax-bff-redirect-update-partner › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-delete-partner
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target delete-partner-bpm; this entry declares none of its own.
path Parameters
idaurax-bff-redirect-delete-partner › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.