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-06-03T18:30:54.3545695",
"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-06-03T18:30:54.3545695+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-06-03T18:30:54.3545695+00:00</d2p1:Updated>
</d2p1:Allergen>
</List>
</PageListOfAllergennhwwKC9D>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Sample:
PK ۓ�\r��Ƕ 5 xl/workbook.xml � (� ����@�{��r�5䠢���_`��O�����O ��ۙ��v�h\_ӳ���\λl�������]k��0I�Ӷ����oE:@Ep4`�F�NZ�W�?,oa�;����Pj^����S��9[��d���7%�~�(�QQ�K���ܛ�ǜ�LNã�o�DT����I�w���.�PK ۓ�\���� � [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
ۓ�\U��' ' _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="Rcf475d1ed1fe4094" /></Relationships>PK ۓ�\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 ۓ�\�6g�� P xl/_rels/workbook.xml.rels � (� ��AN�0E�b͞�q�TM�aö�ƞ�Q;�@�Ƃ#q�"A*�`ӕ5짧�lvo��^0��]y&�����o���춛=�*�d��Xz��朴�IQ�gt���0�����Y��K!�yX2����C�]7h|��4�����G���A�c?�ˑg�
�Ѵ�7�J��,��2��������]/dD!�F��P��17��*�y�!mz鴌�jM%S�B�4�Z\��տ�~PK ۓ�\Ѓ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 ۓ�\\��� | 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- ۓ�\r��Ƕ 5 xl/workbook.xmlPK- ۓ�\���� � � [Content_Types].xmlPK-
ۓ�\U��' ' U _rels/.relsPK- ۓ�\r�p1� � xl/worksheets/sheet1.xmlPK- ۓ�\�6g�� P � xl/_rels/workbook.xml.relsPK- ۓ�\Ѓc'2 E
� xl/styles.xmlPK- ۓ�\\��� | _ xl/sharedStrings.xmlPK � �
application/vnd.ms-excel
Sample:
PK ۓ�\5�3j� 5 xl/workbook.xml � (� ����0��&�C���B�N\�z�^�"
�'m
>��o�vfg�:k;>��GN�U�ƃ��"��$s'm@�]��d>H�"���V��I�$9�01/�r�0��X�X`� ��V�dB��x@�.�fe0�����"�)a�ETH1 5n�gE�������D�e���Ӣ�$����a�l��/PK ۓ�\���� � [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
ۓ�\\Y8�' ' _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="R5316a26b6a854da5" /></Relationships>PK ۓ�\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 ۓ�\��q� P xl/_rels/workbook.xml.rels � (� ��KN�0@�b͞8͏5�M�����8jbG�[��Xp$��U$H%l����I3�����4�39?X��*I��V�o��C
��zO#�8��0{W�oA�0?q }bg2����0���|FqĞx��wK�2��2��V�Aг��L��_�;zM���Z�)y~
�$R��d��NE)UV7yZT�����e$����/dd^*j��*jY��w���H�/�tZ�j��uIPW�\\���_l� PK ۓ�\Ѓ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 ۓ�\\��� | 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- ۓ�\5�3j� 5 xl/workbook.xmlPK- ۓ�\���� � [Content_Types].xmlPK-
ۓ�\\Y8�' ' V _rels/.relsPK- ۓ�\r�p1� � xl/worksheets/sheet1.xmlPK- ۓ�\��q� P � xl/_rels/workbook.xml.relsPK- ۓ�\Ѓc'2 E
� xl/styles.xmlPK- ۓ�\\��� | _ xl/sharedStrings.xmlPK � �