corporate-assignment-requests
Operations addressed under /corporate-assignment-requests — 5 operations.
aurax-bff-redirect-get-corporate-assignment-request-list
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 get-corporate-assignment-request-list; this entry declares none of its own.
Response body, read from the service source
The route declares its response as IEnumerable<CorporateAssignmentRequestDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CustomerId | Guid | no |
CustomerGroupId | Guid | no |
ProcessStatus | int? | yes |
CorporateAssignmentId | Guid? | yes |
CorporateAssignmentFields | string | no |
Status | int? | yes |
CorporateAssignmentRequestDecisions | List<CorporateAssignmentRequestDecisionDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-corporate-assignment-request-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
aurax-bff-redirect-create-corporate-assignment-request
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-corporate-assignment-request; this entry declares none of its own.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ALLTMNT_64 | 400 | CORPORATE_ASSIGNMENT_REQUEST_ALREADY_EXISTS_FOR_CUSTOMER | Corporate assignment request already exists for this customer. |
ERR_ALLTMNT_67 | 400 | INVALID_CORPORATE_ASSIGNMENT_FIELDS_JSON | Failed to deserialize the corporate assignment fields. |
ERR_ALLTMNT_68 | 400 | REQUESTED_GENERAL_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_GROUP_LIMIT | Requested general limit amount cannot be less than product group limit amount |
ERR_ALLTMNT_69 | 400 | PRODUCT_GROUP_REQUESTED_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_LIMIT | Product group requested limit amount cannot be less than product limit amount |
ERR_ALLTMNT_73 | 400 | ALLOTMENT_VALIDITY_DATE_CANNOT_BE_IN_PAST | Allotment validity date cannot be in the past |
aurax-bff-redirect-create-corporate-assignment-request › Request Body
corporateAssignmentFieldscustomerIdcorporateAssignmentIdcustomerGroupIdaurax-bff-redirect-create-corporate-assignment-request › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
aurax-bff-redirect-get-corporate-assignment-request-by-id
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 get-corporate-assignment-request-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as CorporateAssignmentRequestDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CustomerId | Guid | no |
CustomerGroupId | Guid | no |
ProcessStatus | int? | yes |
CorporateAssignmentId | Guid? | yes |
CorporateAssignmentFields | string | no |
Status | int? | yes |
CorporateAssignmentRequestDecisions | List<CorporateAssignmentRequestDecisionDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ALLTMNT_65 | 400 | CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND | Corporate assignment request not found. Request ID: {0}. |
path Parameters
idaurax-bff-redirect-get-corporate-assignment-request-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-redirect-update-corporate-assignment-request
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-corporate-assignment-request; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ALLTMNT_65 | 400 | CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND | Corporate assignment request not found. Request ID: {0}. |
ERR_ALLTMNT_67 | 400 | INVALID_CORPORATE_ASSIGNMENT_FIELDS_JSON | Failed to deserialize the corporate assignment fields. |
ERR_ALLTMNT_68 | 400 | REQUESTED_GENERAL_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_GROUP_LIMIT | Requested general limit amount cannot be less than product group limit amount |
ERR_ALLTMNT_69 | 400 | PRODUCT_GROUP_REQUESTED_LIMIT_CANNOT_BE_LESS_THAN_PRODUCT_LIMIT | Product group requested limit amount cannot be less than product limit amount |
ERR_ALLTMNT_73 | 400 | ALLOTMENT_VALIDITY_DATE_CANNOT_BE_IN_PAST | Allotment validity date cannot be in the past |
ERR_ALLTMNT_75 | 400 | CORPORATE_ASSIGNMENT_REQUEST_NOT_EDITABLE | not published in this snapshot |
path Parameters
idaurax-bff-redirect-update-corporate-assignment-request › Request Body
corporateAssignmentFieldscorporateAssignmentIdcustomerGroupIdcustomerIdaurax-bff-redirect-update-corporate-assignment-request › 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-delete-corporate-assignment-request
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-corporate-assignment-request; this entry declares none of its own.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ALLTMNT_65 | 400 | CORPORATE_ASSIGNMENT_REQUEST_NOT_FOUND | Corporate assignment request not found. Request ID: {0}. |
ERR_ALLTMNT_76 | 400 | CORPORATE_ASSIGNMENT_REQUEST_NOT_DELETABLE | not published in this snapshot |
path Parameters
idaurax-bff-redirect-delete-corporate-assignment-request › 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.