products

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<AllotmentProductParentDto>.

Field	Declared type	Nullable
ParentAllotmentProductName	string	no

Member names are the service's declaration names.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

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_1	400	AP_MUST_BE_UNIQUE_FOR_SAME_PARENT_PRODUCT_AND_NAME	It is not allowed to have more than one allotment product with the same name and parent Allotment Product.
ERR_ALLTMNT_15	400	ALLOTMENT_VALIDITY_DAY_MUST_BE_BETWEEN_MAX_AND_MIN	default Validity Day must have a value that is between min Validity Day and max Validity Day.
ERR_ALLTMNT_2	400	AP_MUST_BE_UNIQUE_FOR_SAME_DOMAIN_PRODUCT	It is not allowed to have more than one allotment product with the same domain Product.
ERR_ALLTMNT_27	400	NON_LEAF_PARENT_PRODUCT_MUST_BE_UNIQUE_AND_NOT_LASTLEAF	Parent product is cannot be found with the given Parent Allotment Product : {0}.
ERR_ALLTMNT_5	400	PRODUCT_MUST_NOT_INCLUDE_SAME_NAMED_FIELD	It is not allowed to have more than one field with the same name for an allotment product.

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 AllotmentProductDto.

Field	Declared type	Nullable
Name	string	no
IsLastLeaf	bool?	yes
ParentAllotmentProductId	Guid?	yes
AccountProductId	Guid?	yes
AllotmentType	int?	yes
MinAllotmentValidityDay	int?	yes
MaxAllotmentValidityDay	int?	yes
DefaultAllotmentValidityDay	int?	yes
AllotmentProductFields	List<AllotmentProductFieldDto> (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_30	400	PRODUCT_NOT_FOUND_WITH_THE_GIVEN_DOMAIN_PRODUCT_ID	Product is cannot be found with the given domain product: {0}.

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 AllotmentProductDto.

Field	Declared type	Nullable
Name	string	no
IsLastLeaf	bool?	yes
ParentAllotmentProductId	Guid?	yes
AccountProductId	Guid?	yes
AllotmentType	int?	yes
MinAllotmentValidityDay	int?	yes
MaxAllotmentValidityDay	int?	yes
DefaultAllotmentValidityDay	int?	yes
AllotmentProductFields	List<AllotmentProductFieldDto> (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_1	400	AP_MUST_BE_UNIQUE_FOR_SAME_PARENT_PRODUCT_AND_NAME	It is not allowed to have more than one allotment product with the same name and parent Allotment Product.
ERR_ALLTMNT_15	400	ALLOTMENT_VALIDITY_DAY_MUST_BE_BETWEEN_MAX_AND_MIN	default Validity Day must have a value that is between min Validity Day and max Validity Day.
ERR_ALLTMNT_2	400	AP_MUST_BE_UNIQUE_FOR_SAME_DOMAIN_PRODUCT	It is not allowed to have more than one allotment product with the same domain Product.
ERR_ALLTMNT_27	400	NON_LEAF_PARENT_PRODUCT_MUST_BE_UNIQUE_AND_NOT_LASTLEAF	Parent product is cannot be found with the given Parent Allotment Product : {0}.
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_14	400	ROOT_PRODUCT_WITH_LEAFS_CANNOT_BE_DELETED	Product has child products. It cannot be deleted.
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.
ERR_ALLTMNT_4	400	PRODUCT_MUST_NOT_BE_USED_IN_ASSIGNMENT_FOR_DELETION	Product is used for allotment allotment assignment. It cannot be deleted.

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<AllotmentProductFieldDto>.

Field	Declared type	Nullable
AllotmentProductFieldId	Guid	no
Name	string	no
DataType	int?	yes
IsActive	bool	no
IsMandatory	bool	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.

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 CreateAllotmentProductFieldDto.

Field	Declared type	Nullable
AllotmentProductFieldId	Guid?	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.
ERR_ALLTMNT_5	400	PRODUCT_MUST_NOT_INCLUDE_SAME_NAMED_FIELD	It is not allowed to have more than one field with the same name for an allotment product.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.
ERR_ALLTMNT_5	400	PRODUCT_MUST_NOT_INCLUDE_SAME_NAMED_FIELD	It is not allowed to have more than one field with the same name for an allotment product.
ERR_ALLTMNT_6	400	PRODUCT_FIELD_MUST_BE_EXIST	Field is cannot be found with given field: {0}.

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
ERR_ALLTMNT_3	400	PRODUCT_MUST_BE_EXIST	Product is cannot be found with the given: {0}.
ERR_ALLTMNT_31	400	ALLOTMENT_FIELD_IS_USED_CANNOT_BE_DELETED	Field is used while assigning an allotment. It cannot be deleted.
ERR_ALLTMNT_6	400	PRODUCT_FIELD_MUST_BE_EXIST	Field is cannot be found with given field: {0}.