GET api/Data/Contacts?PartnerKey={PartnerKey}&apiKey={apiKey}&CustomerId={CustomerId}&IncludeStudents={IncludeStudents}&IncludeStaff={IncludeStaff}&IncludeParents={IncludeParents}&IncludeAddressBook={IncludeAddressBook}&IncludeEmails={IncludeEmails}&IncludeMobiles={IncludeMobiles}&options={options}

Request Information

URI Parameters

Name	Type	Additional information
PartnerKey	string	Required
apiKey	string	Required
CustomerId	integer	Required
IncludeStudents	integer	Default value is 1
IncludeStaff	integer	Default value is 1
IncludeParents	integer	Default value is 1
IncludeAddressBook	integer	Default value is 0
IncludeEmails	integer	Default value is 0
IncludeMobiles	integer	Default value is 0
options	string	Default value is

Body Parameters

None.

Response Information

Resource Description

ApiContactsResponse

Name	Type	Additional information
CustomerId	integer	None.
errorMsg	string	None.
Contacts	Collection of ApiContact	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "errorMsg": "sample string 2",
  "Contacts": [
    {
      "ContactId": 1,
      "ContactType": "sample string 2",
      "Id": "sample string 3",
      "Gender": "sample string 4",
      "Name": "sample string 5",
      "Surname": "sample string 6",
      "Forename": "sample string 7",
      "GroupIds": "sample string 8",
      "HomeEmail": "sample string 9",
      "WorkEmail": "sample string 10",
      "Mobile": "sample string 11",
      "ParentContactIds": "sample string 12",
      "P1ParentContactIds": "sample string 13",
      "ChildContactIds": "sample string 14",
      "AttendanceMarks": "sample string 15",
      "AttendanceMarkStart": "sample string 16",
      "attributes": "sample string 17",
      "LastImportedDateTime": "sample string 18"
    },
    {
      "ContactId": 1,
      "ContactType": "sample string 2",
      "Id": "sample string 3",
      "Gender": "sample string 4",
      "Name": "sample string 5",
      "Surname": "sample string 6",
      "Forename": "sample string 7",
      "GroupIds": "sample string 8",
      "HomeEmail": "sample string 9",
      "WorkEmail": "sample string 10",
      "Mobile": "sample string 11",
      "ParentContactIds": "sample string 12",
      "P1ParentContactIds": "sample string 13",
      "ChildContactIds": "sample string 14",
      "AttendanceMarks": "sample string 15",
      "AttendanceMarkStart": "sample string 16",
      "attributes": "sample string 17",
      "LastImportedDateTime": "sample string 18"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiContactsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/m5api.Models">
  <Contacts>
    <ApiContact>
      <AttendanceMarkStart>sample string 16</AttendanceMarkStart>
      <AttendanceMarks>sample string 15</AttendanceMarks>
      <ChildContactIds>sample string 14</ChildContactIds>
      <ContactId>1</ContactId>
      <ContactType>sample string 2</ContactType>
      <Forename>sample string 7</Forename>
      <Gender>sample string 4</Gender>
      <GroupIds>sample string 8</GroupIds>
      <HomeEmail>sample string 9</HomeEmail>
      <Id>sample string 3</Id>
      <LastImportedDateTime>sample string 18</LastImportedDateTime>
      <Mobile>sample string 11</Mobile>
      <Name>sample string 5</Name>
      <P1ParentContactIds>sample string 13</P1ParentContactIds>
      <ParentContactIds>sample string 12</ParentContactIds>
      <Surname>sample string 6</Surname>
      <WorkEmail>sample string 10</WorkEmail>
      <attributes>sample string 17</attributes>
    </ApiContact>
    <ApiContact>
      <AttendanceMarkStart>sample string 16</AttendanceMarkStart>
      <AttendanceMarks>sample string 15</AttendanceMarks>
      <ChildContactIds>sample string 14</ChildContactIds>
      <ContactId>1</ContactId>
      <ContactType>sample string 2</ContactType>
      <Forename>sample string 7</Forename>
      <Gender>sample string 4</Gender>
      <GroupIds>sample string 8</GroupIds>
      <HomeEmail>sample string 9</HomeEmail>
      <Id>sample string 3</Id>
      <LastImportedDateTime>sample string 18</LastImportedDateTime>
      <Mobile>sample string 11</Mobile>
      <Name>sample string 5</Name>
      <P1ParentContactIds>sample string 13</P1ParentContactIds>
      <ParentContactIds>sample string 12</ParentContactIds>
      <Surname>sample string 6</Surname>
      <WorkEmail>sample string 10</WorkEmail>
      <attributes>sample string 17</attributes>
    </ApiContact>
  </Contacts>
  <CustomerId>1</CustomerId>
  <errorMsg>sample string 2</errorMsg>
</ApiContactsResponse>