ProspectController
Base route: crm/prospects
| Namespace | Axiom.App.Crm.Api.Controllers |
|---|---|
| Base Route | crm/prospects |
| Security | SalesProfessional, SalesEssential |
Endpoints
| Method | Route | Method Name | Parameters | Return Type |
|---|---|---|---|---|
| Get | crm/prospects/lists/{Id:int} |
GetList | Id: int, searchText: string, skip: int, limit: int, tags: List<string>, orderBy: string, direction: string, filters: string | List |
| Get | crm/prospects/{prospectListId:int} |
Get | prospectListId: int | ProspectListDetail |
| Get | crm/prospects/lists |
GetDocumentLists | None | List<DocumentListBasic> |
| Get | crm/prospects/{contactId:int}/contact |
GetContact | contactId: int | Contact |
| Get | crm/prospects/form/{form}/ |
GetForm | form: string | DocumentForm |
| Get | crm/prospects/count |
GetTotalCount | None | int |
| Get | crm/prospects/{prospectListId:int}/count |
GetTotalProspectCount | prospectListId: int | int |
| Post | crm/prospects/{prospectId:int}/user |
UserAdd | user: UserBasic, prospectId: int | bool |
| Delete | crm/prospects/{prospectId:int}/user/{userId:int} |
UserDelete | prospectId: int, userId: int | bool |
| Put | crm/prospects |
Put | document: Document | bool |
| Put | crm/prospects/{prospectListId:int}/order |
UpdateOrder | prospectListId: int, contacts: List<Contact> | void |
| Post | crm/prospects |
Post | document: Document | int |
| Post | crm/prospects/deleteselected |
DeleteSelected | selectedIds: List<int> | bool |
| Delete | crm/prospects/{prospectListId:int} |
Delete | prospectListId: int | int |
| Post | crm/prospects/addtoprospectlists/{contactId:int} |
AddToProspectLists | contactId: int, selectedProspectListIds: int[] | bool |
Detailed Endpoint Information
Get
crm/prospects/lists/{Id:int}
GetList
Return Type
List
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
Id |
int |
Query | No |
searchText |
string |
Query | No |
skip |
int |
Query | No |
limit |
int |
Query | No |
tags |
List<string> |
FromQuery | No |
orderBy |
string |
Query | No |
direction |
string |
Query | No |
filters |
string |
Query | No |
Get
crm/prospects/{prospectListId:int}
Get
Return Type
ProspectListDetail
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
prospectListId |
int |
Query | No |
Get
crm/prospects/lists
GetDocumentLists
Return Type
List<DocumentListBasic>
Parameters
No parameters
Get
crm/prospects/{contactId:int}/contact
GetContact
Return Type
Contact
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
contactId |
int |
Query | No |
Get
crm/prospects/form/{form}/
GetForm
Return Type
DocumentForm
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
form |
string |
Query | No |
Get
crm/prospects/count
GetTotalCount
Return Type
int
Parameters
No parameters
Get
crm/prospects/{prospectListId:int}/count
GetTotalProspectCount
Return Type
int
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
prospectListId |
int |
Query | No |
Post
crm/prospects/{prospectId:int}/user
UserAdd
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
user |
UserBasic |
FromBody | No |
prospectId |
int |
Query | No |
Delete
crm/prospects/{prospectId:int}/user/{userId:int}
UserDelete
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
prospectId |
int |
Query | No |
userId |
int |
Query | No |
Put
crm/prospects
Put
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
document |
Document |
FromBody | No |
Put
crm/prospects/{prospectListId:int}/order
UpdateOrder
Return Type
void
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
prospectListId |
int |
Query | No |
contacts |
List<Contact> |
FromBody | No |
Post
crm/prospects
Post
Return Type
int
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
document |
Document |
FromBody | No |
Post
crm/prospects/deleteselected
DeleteSelected
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
selectedIds |
List<int> |
FromBody | No |
Delete
crm/prospects/{prospectListId:int}
Delete
Return Type
int
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
prospectListId |
int |
Query | No |
Post
crm/prospects/addtoprospectlists/{contactId:int}
AddToProspectLists
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
contactId |
int |
Query | No |
selectedProspectListIds |
int[] |
FromBody | No |