POST api/Contact/GetContactsList

Get a list of contacts

Request Information

Body Parameters

GetContactsListModel
NameDescriptionTypeAdditional information
DeviceId

Device id

integer

None.

ContactType

There is only a white list, fixed 1

integer

None.

Token

Get it after logging in Token

string

None.

Language

Language Option

string

None.

AppId

APP Application Identifier

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DeviceId": 1,
  "ContactType": 2,
  "Token": "sample string 3",
  "Language": "sample string 4",
  "AppId": "sample string 5"
}

application/xml, text/xml

Sample:
<GetContactsListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ParModel">
  <AppId>sample string 5</AppId>
  <Language>sample string 4</Language>
  <Token>sample string 3</Token>
  <ContactType>2</ContactType>
  <DeviceId>1</DeviceId>
</GetContactsListModel>

Response Information

Resource Description

ProContactsResult
NameDescriptionTypeAdditional information
Message

message

string

None.

WhiteCount

Whitelist number

integer

None.

List

contact list

Collection of ContactItem

None.

State

status code

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "WhiteCount": 2,
  "List": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "AvatarImage": "sample string 3",
      "PhoneNum": "sample string 4",
      "IsAdmin": true,
      "No": 6,
      "Type": 7,
      "UserId": 8,
      "DeviceId": 9,
      "Nickname": "sample string 10",
      "IMEI": "sample string 11",
      "UserGroupId": 12,
      "IsSoS": 13
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "AvatarImage": "sample string 3",
      "PhoneNum": "sample string 4",
      "IsAdmin": true,
      "No": 6,
      "Type": 7,
      "UserId": 8,
      "DeviceId": 9,
      "Nickname": "sample string 10",
      "IMEI": "sample string 11",
      "UserGroupId": 12,
      "IsSoS": 13
    }
  ],
  "State": 3
}

application/xml, text/xml

Sample:
<ProContactsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ResModel">
  <State>3</State>
  <List>
    <ContactItem>
      <AvatarImage>sample string 3</AvatarImage>
      <DeviceId>9</DeviceId>
      <IMEI>sample string 11</IMEI>
      <Id>1</Id>
      <IsAdmin>true</IsAdmin>
      <IsSoS>13</IsSoS>
      <Name>sample string 2</Name>
      <Nickname>sample string 10</Nickname>
      <No>6</No>
      <PhoneNum>sample string 4</PhoneNum>
      <Type>7</Type>
      <UserGroupId>12</UserGroupId>
      <UserId>8</UserId>
    </ContactItem>
    <ContactItem>
      <AvatarImage>sample string 3</AvatarImage>
      <DeviceId>9</DeviceId>
      <IMEI>sample string 11</IMEI>
      <Id>1</Id>
      <IsAdmin>true</IsAdmin>
      <IsSoS>13</IsSoS>
      <Name>sample string 2</Name>
      <Nickname>sample string 10</Nickname>
      <No>6</No>
      <PhoneNum>sample string 4</PhoneNum>
      <Type>7</Type>
      <UserGroupId>12</UserGroupId>
      <UserId>8</UserId>
    </ContactItem>
  </List>
  <Message>sample string 1</Message>
  <WhiteCount>2</WhiteCount>
</ProContactsResult>