Contacts API

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

1. ContactGroup

1.1. Create

1.1.1. ($id, array $data)

1.1.1.1. return int $id

1.2. Update

1.2.1. ($id, array $data)

1.2.1.1. return bool

1.3. Delete

1.3.1. (mixed $id)

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

1.4. List

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

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

1.5. Get

1.5.1. ($id)

1.5.1.1. return array $group

1.6. AddCards

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

1.6.1.1. return int $cardsCnt

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

1.7. AddCardsToHiddenGroup

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

1.7.1.1. return int $cardsCnt

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

1.8. RemoveCards

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

1.8.1.1. return bool

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

1.9. GetCardsCount

1.9.1. (mixed $id)

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

2. ContactCard

2.1. Create

2.1.1. (array $data)

2.1.1.1. return int $id

2.2. Update

2.2.1. ($id, array $data)

2.2.1.1. return bool

2.3. Delete

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

2.3.1.1. return bool

2.4. List

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

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

2.5. Get

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

2.5.1.1. return array $card

2.6. GetGroups

2.6.1. ($id)

2.6.1.1. return array $groupIds

2.7. SetGroups

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

2.7.1.1. return bool

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

2.8. RemoveGroups

2.8.1. ($id)

2.8.1.1. return bool

2.9. GetConfig

2.9.1. ()

2.9.1.1. return array $config

2.10. UpdateConfig

2.10.1. (array $fields)

2.10.1.1. return bool

3. ContactField

3.1. Create

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

3.1.1.1. return int $id

3.2. Update

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

3.2.1.1. return bool

3.3. Delete

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

3.3.1.1. return bool

3.4. Get

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

3.4.1.1. return array $field

3.5. Reorder

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

3.5.1.1. return bool

4. ContactType

4.1. List

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

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

4.2. Create

4.2.1. (array $data=[])

4.2.1.1. return int $id

4.3. Update

4.3.1. ($type, array $data)

4.3.1.1. return bool

4.4. Delete

4.4.1. ($type)

4.4.1.1. return bool

4.5. Reorder

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

4.5.1.1. return bool