GET api/v2/Contacts/GetContactsByFarm?FarmId={FarmId}

Request Information

URI Parameters

Name	Description	Type	Additional information
FarmId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ContactsContract

Name	Type	Additional information
ContactId	integer	None.
Name	string	None.
FarmRoleId	integer	None.
IntegratorId	integer	None.
NIF	string	None.
Phone	string	None.
Mobile	string	None.
Email	string	None.
Address	string	None.
Postcode	string	None.
City	string	None.
IsDefault	boolean	None.
AllowMessaging	boolean	None.
Remarks	string	None.
FarmId	integer	None.
FarmRoleDescription	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContactId": 1,
    "Name": "sample string 2",
    "FarmRoleId": 3,
    "IntegratorId": 4,
    "NIF": "sample string 5",
    "Phone": "sample string 6",
    "Mobile": "sample string 7",
    "Email": "sample string 8",
    "Address": "sample string 9",
    "Postcode": "sample string 10",
    "City": "sample string 11",
    "IsDefault": true,
    "AllowMessaging": true,
    "Remarks": "sample string 14",
    "FarmId": 15,
    "FarmRoleDescription": "sample string 16"
  },
  {
    "ContactId": 1,
    "Name": "sample string 2",
    "FarmRoleId": 3,
    "IntegratorId": 4,
    "NIF": "sample string 5",
    "Phone": "sample string 6",
    "Mobile": "sample string 7",
    "Email": "sample string 8",
    "Address": "sample string 9",
    "Postcode": "sample string 10",
    "City": "sample string 11",
    "IsDefault": true,
    "AllowMessaging": true,
    "Remarks": "sample string 14",
    "FarmId": 15,
    "FarmRoleDescription": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactsContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FPService/v2/contracts/2017/01">
  <ContactsContract>
    <Address>sample string 9</Address>
    <AllowMessaging>true</AllowMessaging>
    <City>sample string 11</City>
    <ContactId>1</ContactId>
    <Email>sample string 8</Email>
    <FarmId>15</FarmId>
    <FarmRoleDescription>sample string 16</FarmRoleDescription>
    <FarmRoleId>3</FarmRoleId>
    <IntegratorId>4</IntegratorId>
    <IsDefault>true</IsDefault>
    <Mobile>sample string 7</Mobile>
    <NIF>sample string 5</NIF>
    <Name>sample string 2</Name>
    <Phone>sample string 6</Phone>
    <Postcode>sample string 10</Postcode>
    <Remarks>sample string 14</Remarks>
  </ContactsContract>
  <ContactsContract>
    <Address>sample string 9</Address>
    <AllowMessaging>true</AllowMessaging>
    <City>sample string 11</City>
    <ContactId>1</ContactId>
    <Email>sample string 8</Email>
    <FarmId>15</FarmId>
    <FarmRoleDescription>sample string 16</FarmRoleDescription>
    <FarmRoleId>3</FarmRoleId>
    <IntegratorId>4</IntegratorId>
    <IsDefault>true</IsDefault>
    <Mobile>sample string 7</Mobile>
    <NIF>sample string 5</NIF>
    <Name>sample string 2</Name>
    <Phone>sample string 6</Phone>
    <Postcode>sample string 10</Postcode>
    <Remarks>sample string 14</Remarks>
  </ContactsContract>
</ArrayOfContactsContract>