GET api/allergens?IncludeDeleted={IncludeDeleted}&Relations={Relations}&Skip={Skip}&Take={Take}&TotalCount={TotalCount}
Get list of allergens
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeDeleted |
Include deleted allergens in the list |
boolean |
None. |
Relations |
Also return allergen relatiosn |
boolean |
None. |
Skip |
Number of records to skip over |
integer |
None. |
Take |
Number of records to take |
integer |
None. |
TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Body Parameters
None.
Response Information
Resource Description
List of matching allergens
PageListOfAllergenName | Description | Type | Additional information |
---|---|---|---|
Type | string |
None. |
|
List | Collection of Allergen |
None. |
|
Skip |
Number of records to skip over |
integer |
None. |
Take |
Number of records to take |
integer |
None. |
TotalCount | integer |
Relation. This field may not always be loaded or used for updates. |
Response Formats
application/json, text/json
Sample:
{ "type": "Allergen", "list": [ { "$id": "2", "id": 1, "name": "sample string 2", "reserved": true, "updated": "2025-06-14T07:01:36.344137", "deleted": true, "ingredients": [ { "$id": "3", "id": 1, "allergenID": 2, "text": "sample string 3" }, { "$ref": "3" } ] }, { "$ref": "2" } ], "skip": 1, "take": 1, "totalCount": 1 }
application/xml, text/xml
Sample:
<PageListOfAllergennhwwKC9D xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.Common"> <Skip>1</Skip> <Take>1</Take> <TotalCount>1</TotalCount> <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/EziManager.Models.EMC.Allergens"> <d2p1:Allergen> <d2p1:Deleted>true</d2p1:Deleted> <d2p1:ID>1</d2p1:ID> <d2p1:Ingredients> <d2p1:AllergenIngredient> <d2p1:AllergenID>2</d2p1:AllergenID> <d2p1:ID>1</d2p1:ID> <d2p1:Text>sample string 3</d2p1:Text> </d2p1:AllergenIngredient> <d2p1:AllergenIngredient> <d2p1:AllergenID>2</d2p1:AllergenID> <d2p1:ID>1</d2p1:ID> <d2p1:Text>sample string 3</d2p1:Text> </d2p1:AllergenIngredient> </d2p1:Ingredients> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Reserved>true</d2p1:Reserved> <d2p1:Updated>2025-06-14T07:01:36.344137+00:00</d2p1:Updated> </d2p1:Allergen> <d2p1:Allergen> <d2p1:Deleted>true</d2p1:Deleted> <d2p1:ID>1</d2p1:ID> <d2p1:Ingredients> <d2p1:AllergenIngredient> <d2p1:AllergenID>2</d2p1:AllergenID> <d2p1:ID>1</d2p1:ID> <d2p1:Text>sample string 3</d2p1:Text> </d2p1:AllergenIngredient> <d2p1:AllergenIngredient> <d2p1:AllergenID>2</d2p1:AllergenID> <d2p1:ID>1</d2p1:ID> <d2p1:Text>sample string 3</d2p1:Text> </d2p1:AllergenIngredient> </d2p1:Ingredients> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:Reserved>true</d2p1:Reserved> <d2p1:Updated>2025-06-14T07:01:36.344137+00:00</d2p1:Updated> </d2p1:Allergen> </List> </PageListOfAllergennhwwKC9D>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 28�Z���� 5 xl/workbook.xml � (� ����0��&�C��Ј18q�����4ҟtk��H�yۙ��v���Wc�}�h(�%Bp����N֡�w���,�SؾW-ֶ}k4A�$��#e �_i���y��Ġ��A^�K�������b2���o����"*f@c�k�Ytn]�S�|����_��k����s ��;����PK 28�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK 28�Z��Fo' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="Rc1ff030b9a4c4e6f" /></Relationships>PK 28�Zr�p1� xl/worksheets/sheet1.xml � (� ��[O�0��J�{遃l���3^�u�2)]�n��-��b�Z�<_�~ �ջl��k#T�C`xW�Jt�l}�«"�~3 �8�3k�����!S6\2�=��Z��d�M���%ߨ� yg�8A��̺�L#����R��5g�� ۱�d��EV W}H4�sxM�[ *2?ޛoc0��U��a�P�{-�;����١�O���b�Xפ�;�j�)��A ٻ���MW�pB]�U�e�L>�ѣ�Gg��2"+���4��'?����E���ɋg����4�(N�ӳ>��{�a��V=�~�UF�nh���&w��g�8�q�$�)q�$�)�Y�)�]�L {�N��Ӆ�Ⱦ$��?�3�����=�6&E�:_��;�,��N�ߺ� PK 28�Z��)=� P xl/_rels/workbook.xml.rels � (� ��An� E��f_cc�:Q�l��6�(Ɗ Hۜ���W(j�֑��&+4��i������m���8:�CU�@�J�F;�pJ����v��I�|#��G���Iɯ)���,b�<���.�"�2�yRV�- K\3����?D��(���ӌ6���.�AL@"�z��"�>�"S�<���S�zf�5y% �fj1�'��^�z!Shu-y-;������S y�K�e�P��mٽ��U�⪺̉^���PK 28�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK 28�Z\��� | xl/sharedStrings.xml � (� eP�J�0����I׃�4]��^��z�оm�&/5�U�_oVY����3�r����D.��UH����`�s{q#�����`�$Ŷ*�Xd+��#�t�5u#K*N�Y��,g�MS�����ˢ���:���3���R���g�O8���]&(5W�>�_��������\kg�6��?-k��{H�Y�BA�1��H= Br�:>�y�}�Ƣ �&��I�Z����z���y��PK- 28�Z���� 5 xl/workbook.xmlPK- 28�Z���� � � [Content_Types].xmlPK- 28�Z��Fo' ' U _rels/.relsPK- 28�Zr�p1� � xl/worksheets/sheet1.xmlPK- 28�Z��)=� P � xl/_rels/workbook.xml.relsPK- 28�ZЃc'2 E � xl/styles.xmlPK- 28�Z\��� | _ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 28�Z�6�� 5 xl/workbook.xml � (� ����0D�&�C��`TR8q�����m�-ik��-H�yۙ�};b������G�箠2�1g�75����]g���{1�u���6o�&�s�d�� AY�=]i����Z/�V�ehy<"�fO��_d4���I�b�)����EZA J��4���*����y��5r�<����a�m��/PK 28�Z���� � [Content_Types].xml � (� ���J�0�_��*M�D��V�*��d� �d�k��<�H���V���= ��|�o��|����������+�����7l���e۶~=E�"�zlXO�@Ճ��C�3]HNR~���R��uU�<���������a��36��b7םQ �1Z�$�8z�R��3 tP��-c�� g����_M��Of���~O�s�T���� ����P<�D��e=1Z��a2�b ��%#H'�2}���e�B)��~j/F�t��PK 28�Z�d��' ' _rels/.rels � (� <?xml version="1.0" encoding="utf-8"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml" Id="R39b117b6462e48b4" /></Relationships>PK 28�Zr�p1� xl/worksheets/sheet1.xml � (� ��[O�0��J�{遃l���3^�u�2)]�n��-��b�Z�<_�~ �ջl��k#T�C`xW�Jt�l}�«"�~3 �8�3k�����!S6\2�=��Z��d�M���%ߨ� yg�8A��̺�L#����R��5g�� ۱�d��EV W}H4�sxM�[ *2?ޛoc0��U��a�P�{-�;����١�O���b�Xפ�;�j�)��A ٻ���MW�pB]�U�e�L>�ѣ�Gg��2"+���4��'?����E���ɋg����4�(N�ӳ>��{�a��V=�~�UF�nh���&w��g�8�q�$�)q�$�)�Y�)�]�L {�N��Ӆ�Ⱦ$��?�3�����=�6&E�:_��;�,��N�ߺ� PK 28�Zf��� P xl/_rels/workbook.xml.rels � (� ��Kn�0@�b;���� �n)p�q�ؑmh9[=R�P�Jm����h~OO��|����Ɓ\Ї���A+��m��9�v���D0�HZ��㴦4H����Ц�v~1�����'�!-���3�I�� �CtZ��N�G��0}u�br����O)�[ȳD�8,��y����B��u������dJ�ۂ��K�+,*c�G�}���i^��ժ��r%9�+����ѻ��~PK 28�ZЃc'2 E xl/styles.xml � (� �S�j�0��&0���0�^�]v��:��d;��H��Kj�vG�Mz�zOHr�iB8v �F��WEG�?s�Oh�lff�uZМ���ށh�R���6�'��2��������ɳ�UŦ`<Қo���x���8��K�6BC ^�کĖ��B���n��f8����9� ����CUk��#��U�ub��WUB;��k���&� AR>��� ��im��ΑF���YO��%�}� ��LJ\in�,���9oy}��y.�$��6��ųNJ�c��T��rĘ)փBR淶�E3ʟ�\��q��PK 28�Z\��� | xl/sharedStrings.xml � (� eP�J�0����I׃�4]��^��z�оm�&/5�U�_oVY����3�r����D.��UH����`�s{q#�����`�$Ŷ*�Xd+��#�t�5u#K*N�Y��,g�MS�����ˢ���:���3���R���g�O8���]&(5W�>�_��������\kg�6��?-k��{H�Y�BA�1��H= Br�:>�y�}�Ƣ �&��I�Z����z���y��PK- 28�Z�6�� 5 xl/workbook.xmlPK- 28�Z���� � � [Content_Types].xmlPK- 28�Z�d��' ' U _rels/.relsPK- 28�Zr�p1� � xl/worksheets/sheet1.xmlPK- 28�Zf��� P � xl/_rels/workbook.xml.relsPK- 28�ZЃc'2 E � xl/styles.xmlPK- 28�Z\��� | _ xl/sharedStrings.xmlPK � �