GET api/People/Limit={limit}/Offset={offset}/Search={search}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
limit

integer

Required

offset

integer

Required

search

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of API_People_Get_Filtered_Result
NameDescriptionTypeAdditional information
id

string

None.

given_name

string

None.

family_name

string

None.

email

string

None.

status

string

None.

membership_grade

string

None.

cnt

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "sample string 1",
    "given_name": "sample string 2",
    "family_name": "sample string 3",
    "email": "sample string 4",
    "status": "sample string 5",
    "membership_grade": "sample string 6",
    "cnt": 1
  },
  {
    "id": "sample string 1",
    "given_name": "sample string 2",
    "family_name": "sample string 3",
    "email": "sample string 4",
    "status": "sample string 5",
    "membership_grade": "sample string 6",
    "cnt": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPI_People_Get_Filtered_Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YPWebApi">
  <API_People_Get_Filtered_Result>
    <cnt>1</cnt>
    <email>sample string 4</email>
    <family_name>sample string 3</family_name>
    <given_name>sample string 2</given_name>
    <id>sample string 1</id>
    <membership_grade>sample string 6</membership_grade>
    <status>sample string 5</status>
  </API_People_Get_Filtered_Result>
  <API_People_Get_Filtered_Result>
    <cnt>1</cnt>
    <email>sample string 4</email>
    <family_name>sample string 3</family_name>
    <given_name>sample string 2</given_name>
    <id>sample string 1</id>
    <membership_grade>sample string 6</membership_grade>
    <status>sample string 5</status>
  </API_People_Get_Filtered_Result>
</ArrayOfAPI_People_Get_Filtered_Result>