Vendor Managemment

get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
get
/ux/common/vendor/vendor/
200Success
post

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRequired
namestringRequired
vendor_idstring · max: 25Required
organizationstring · max: 25Required
vendor_namestringOptional
statusintegerOptional
typeintegerOptional
web_urlstringOptional
contact_personstringOptional
emailstringOptional
descriptionstringOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
is_deletedbooleanOptional
Responses
post
/ux/common/vendor/vendor/
201Success

Gets a vendor with the given id

get

This endpoint is used to fetch a vendor details in the current organization

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
200Success
application/json
get
/ux/common/vendor/vendor/{id}/
200Success
put

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

idstringRequired
namestringRequired
vendor_idstring · max: 25Required
organizationstring · max: 25Required
vendor_namestringOptional
statusintegerOptional
typeintegerOptional
web_urlstringOptional
contact_personstringOptional
emailstringOptional
descriptionstringOptional
created_byintegerOptional
modified_byintegerOptional
creation_timestring · date-timeOptional
last_update_timestring · date-timeOptional
is_deletedbooleanOptional
Responses
200Success
application/json
put
/ux/common/vendor/vendor/{id}/
200Success

Deletes the vendor with given id

delete

This endpoint is used to delete an existing vendor for the current organization

Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired
Responses
delete
/ux/common/vendor/vendor/{id}/
204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
get
/ux/common/vendor/vendor/options/
200Success

Last updated