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
PageListOfAllergen| Name | 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": "2026-04-03T06:16:47.1947296",
"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>2026-04-03T06:16:47.1947296+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>2026-04-03T06:16:47.1947296+00:00</d2p1:Updated>
</d2p1:Allergen>
</List>
</PageListOfAllergennhwwKC9D>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK 2�\�z� 5 xl/workbook.xml � (� ����0D�&�C��E�R8q����Ri�-ik��-H�yۙ�};b������G�箠]cΘ�j�';����:
!J�b�m���ʷFؙ�9 (k|�FOW�?,?:��w�A+J�2�<s����/2[��$l
�ߔX`�Ţ��� %�so
�P�r��\�c
u�� ����a�m��/PK 2�\���� � [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
2�\v�' ' _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="R6b4d48394c61408f" /></Relationships>PK 2�\r�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 2�\�"�� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�.�SP�n�a[zcO⨉�n�gc���V���X��j4��'�|��6o�HN��]�b@�iopL��6��G��D��I^q����Hi�'+?�˝·I�����JT�t����d�5���3���nи��8�K���h��
=�~J�^�2ȓia��k�d(�K'g��ZL���w^� ֍0R��-D��2V4�)�K�Ne�P��QF2� �75z��/PK 2�\Ѓ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 2�\\��� | 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- 2�\�z� 5 xl/workbook.xmlPK- 2�\���� � � [Content_Types].xmlPK-
2�\v�' ' U _rels/.relsPK- 2�\r�p1� � xl/worksheets/sheet1.xmlPK- 2�\�"�� P � xl/_rels/workbook.xml.relsPK- 2�\Ѓc'2 E
� xl/styles.xmlPK- 2�\\��� | ] xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK 2�\atڶ 5 xl/workbook.xml � (� ����0��&�C������ū�kYlmI[��o)�ě����o����t�z�r[R���3�@ng�a���i_̴��X�V�=K���,���N��љ��
�qѫ~F)��V�
!���!qtQc�;���!��*"l���hPX�<P�[S�=%6�a�Cz�4o��19q��WX����PK 2�\���� � [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
2�\' ' _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="R60af1b02a470436f" /></Relationships>PK 2�\r�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 2�\��� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞�i�&��vÆm�\{GM�Ȟ=�����ĂMW��==i���c�{��!��5�g:�M���>�n�8(J��Sdi��,Ѵ�<j�����ХN�è(����'�!_��a[&;\&�ѷm������ �WN�"��
R?�ȯ!�ؓi`�Ee$*�ֲK
��M-�e������dL!�LN�<V�2V4�ҥ�N��LM�I����(�Z�W5~��/PK 2�\Ѓ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 2�\\��� | 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- 2�\atڶ 5 xl/workbook.xmlPK- 2�\���� � � [Content_Types].xmlPK-
2�\' ' U _rels/.relsPK- 2�\r�p1� � xl/worksheets/sheet1.xmlPK- 2�\��� P � xl/_rels/workbook.xml.relsPK- 2�\Ѓc'2 E
� xl/styles.xmlPK- 2�\\��� | ^ xl/sharedStrings.xmlPK � �