Get Started. It's Free
or sign up with your email address
Contacts API by Mind Map: Contacts API

1. ContactField

1.1. Create

1.1.1. ($type, array $data=[])

1.1.1.1. return int $id

1.2. Update

1.2.1. ($id = null, $key = null, array $data)

1.2.1.1. return bool

1.3. Delete

1.3.1. ($id = null, $key = null)

1.3.1.1. return bool

1.4. Get

1.4.1. ($id = null, $key = null)

1.4.1.1. return array $field

1.5. Reorder

1.5.1. ($id = null, $key = null, $targetPlace, $targetPosition = 'before')

1.5.1.1. return bool

2. ContactType

2.1. List

2.1.1. (array $criteria = [], array $pagination = [], array $sort = [])

2.1.1.1. return array [ array $items int $totalItemCount ]

2.2. Create

2.2.1. (array $data=[])

2.2.1.1. return int $id

2.3. Update

2.3.1. ($type, array $data)

2.3.1.1. return bool

2.4. Delete

2.4.1. ($type)

2.4.1.1. return bool

2.5. Reorder

2.5.1. ($id = null, $targetPlace, $targetPosition = 'before')

2.5.1.1. return bool

3. ContactGroup

3.1. Create

3.1.1. (array $data)

3.1.1.1. return int $id

3.2. Update

3.2.1. ($id, array $data)

3.2.1.1. return bool

3.3. Delete

3.3.1. (mixed $id)

3.3.1.1. return array [ array $processed array $notProcessed ]

3.4. List

3.4.1. (array $criteria = [], array $pagination = [], array $sort = [])

3.4.1.1. return array [ array $items int $totalItemCount ]

3.5. Get

3.5.1. ($id)

3.5.1.1. return array $group

3.6. AddCards

3.6.1. (mixed $id, array $filters = [])

3.6.1.1. return int $cardsCnt

3.6.1.1.1. mixed $cardId = null, int $groupId = null переносим в filters. all => 1, если необходимо применить ко всем картам, отсальные фильтры тогда игнорируются

3.7. AddCardsToHiddenGroup

3.7.1. (array $filters = [])

3.7.1.1. return int $cardsCnt

3.7.1.1.1. mixed $cardId = null, int $groupId = null переносим в filters. all => 1, если необходимо применить ко всем картам, отсальные фильтры тогда игнорируются

3.8. RemoveCards

3.8.1. (mixed $id, array $filters = [])

3.8.1.1. return bool

3.8.1.1.1. mixed $cardId = null переносим в filters

3.9. GetCardsCount

3.9.1. (mixed $id)

3.9.1.1. return array [ $groupId => $cnt]

4. ContactCard

4.1. Create

4.1.1. (array $data)

4.1.1.1. return int $id

4.2. Update

4.2.1. ($id, array $data)

4.2.1.1. return bool

4.3. Delete

4.3.1. ($groupId = null, mixed $id = [], array $filters = [])

4.3.1.1. return bool

4.4. List

4.4.1. (array $criteria = [], array $pagination = [], array $sort = [], array $fields = [])

4.4.1.1. return array [ array $items int $totalItemCount ]

4.5. Get

4.5.1. ($id, array $fields = [])

4.5.1.1. return array $card

4.6. GetGroups

4.6.1. ($id)

4.6.1.1. return array $groupIds

4.7. SetGroups

4.7.1. ($id, array $groupId, $replace = false)

4.7.1.1. return bool

4.7.1.1.1. как удалить из всех групп? передавать пустой масив? &groupId[]=-1

4.8. RemoveGroups

4.8.1. ($id)

4.8.1.1. return bool

4.9. GetConfig

4.9.1. ()

4.9.1.1. return array $config

4.10. UpdateConfig

4.10.1. (array $fields)

4.10.1.1. return bool