- Documentation
- Sandbox
Create business sales.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner business | |
globalOffer | string | true | globalOffer business | |
ratio | string | true | ratio business |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create business.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner business | |
objectif | string | true | object business | |
challenge | string | true | challenge business | |
strenght | string | true | strenght business | |
weaknesse | string | true | weaknesse business | |
opportunity | string | true | opportunity business | |
threat | string | true | threat business | |
strategic | string | true | strategic business | |
revenue | string | true | revenue business | |
firstClient | string | true | firstClient business |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create marketing.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | marketing partner | |
title | string | true | marketing title | |
description | string | true | marketing description | |
reference | string | true | marketing reference | |
location | string | true | marketing location | |
status | string | true | marketing status | |
comment | string | true | marketing comment | |
cost | string | true | marketing cost | |
support | string | true | marketing support | |
dueDate | date | true | marketing due date (format: d/m/Y) |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
update business sales.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner business | |
globalOffer | string | true | globalOffer business | |
ratio | string | true | ratio business |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
update business.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner business | |
objectif | string | true | object business | |
challenge | string | true | challenge business | |
strenght | string | true | strenght business | |
weaknesse | string | true | weaknesse business | |
opportunity | string | true | opportunity business | |
threat | string | true | threat business | |
strategic | string | true | strategic business | |
revenue | string | true | revenue business | |
firstClient | string | true | firstClient business |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
update marketing.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | marketing partner | |
title | string | true | marketing title | |
description | string | true | marketing description | |
reference | string | true | marketing reference | |
location | string | true | marketing location | |
status | string | true | marketing status | |
comment | string | true | marketing comment | |
cost | string | true | marketing cost | |
support | string | true | marketing support | |
dueDate | date | true | marketing due date (format: d/m/Y) |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label industry |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label industry |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label certification | |
logo | string | true | logo certification |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label certification | |
logo | string | true | logo certification |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Associate cockpit by user.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | id user |
type | \d+ | string | type of module |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Set cockpit by user.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | id user |
type | \d+ | string | type of module |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
widgets | array | true | list widgets |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Affect Profile for collateral.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
collaterals[] | string | true | collaterals |
Affect tag for Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
tagCollaterals[] | string | true | tagCollaterals |
Create a new Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameCollateral | string | true | Name | |
language | string | true | language | |
status | string | true | status | |
tagCollaterals[] | string | true | tagCollaterals | |
fileUpload | string | true | fileUpload | |
zoning | string | true | fileUpload | |
picto | string | true | fileUpload | |
dimension | string | true | dimension | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a Generate PDF.
Name | Requirement | Type | Description |
---|---|---|---|
partner | \d+ | integer | partner id |
_format | xml|json | ||
locale | |||
customer | |||
id | integer | Identifier of the Generate object to remove. |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all Collateral pagination.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
start | |||
limit |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
search | string | false | search | |
column | string | false | column | |
dir | string | false | dir |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get Number Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
search | string | false | search |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new generate Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
zoning | string | true | zoning (json) | |
partner | string | true | id Partner | |
collateral | string | true | id collateral | |
customer | string | true | Customer | |
nameFileGenerate | string | true | nameFileGenerate |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Put status a Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
id | integer | Identifier of the TagCollateral object to remove. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
status | string | true | status |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Edit a new Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameCollateral | string | true | Name | |
language | string | true | language | |
status | string | true | status | |
tagCollaterals[] | string | true | tagCollaterals | |
fileUpload | string | true | fileUpload | |
zoning | string | true | fileUpload | |
picto | string | true | fileUpload | |
dimension | string | true | dimension | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
get connection base.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
key | string | true | key api |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get Connector.
Name | Requirement | Type | Description |
---|---|---|---|
typeConnector | \d+ | integer | type Connector (base, salesforce, etc.) |
_format | xml|json | ||
idCustomer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create connector.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
key | string | true | key api | |
customer | string | true | id customer | |
typeConnector | string | true | type connector |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update connector.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
key | string | true | key api | |
customer | string | true | id customer | |
typeConnector | string | true | type connector |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
add customer.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
society | string | true | society of customer | |
address | string | true | address of customer | |
zipCode | string | true | zipCode of customer | |
city | string | true | city of customer | |
country | string | true | country of customer | |
fax | string | true | fax of customer | |
phone | string | true | phone of customer | |
string | true | email of customer | ||
firstname | string | true | firstname of customer | |
lastname | string | true | lastname of customer | |
language | string | true | language of customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update a password for customer.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
token | string | true | token of customer | |
string | true | email of customer | ||
plainPassword | string | true | password of customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new Family Tag Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | Name | |
description | string | true | Description | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a given familyTagCollateral.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | family tag collateral id |
_format | xml|json | ||
locale | |||
customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing Family Tag Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerCategory id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | {not blank} | Name |
description | string | false | Description | |
customer | string | false | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label File for Tag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label industry |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
DELETE Form.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idForm | string | true | form |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get form builder.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json | ||
form_builder |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
form_builder | integer | true | Form Builder ID |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
POST form.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
forms | string | true | grids |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create Formula.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
title | string | true | title formula | |
formBuilder | integer | true | formBuilder | |
formula | text | true | code formula |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update Formula.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
title | string | true | title formula | |
formula | text | true | code formula |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
add log.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
ip | string | true | ip user | |
logUser | string | true | id User | |
sessionUser | string | true | session User | |
product | string | true | enum (prm ou cms) | |
status | boolean | true | boolean |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
disconnect log.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | log connection id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
status | boolean | true | boolean |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
get list connect for ip .
Name | Requirement | Type | Description |
---|---|---|---|
ip | \d+ | sting | log ip |
sessionUser | \d+ | sting | log session |
idUser | \d+ | sting | id User |
_format | xml|json |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Name | Information | ||||
---|---|---|---|---|---|
parent |
|
||||
level |
|
||||
tree-view |
|
||||
flat-view |
|
Status Code | Description |
---|---|
200 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | The category name | |
crmId | string | false | The category CRM ID | |
parent | string | false | The parent category uuid |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | string | uuid (4) of the category | |
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | The category name | |
crmId | string | false | The category CRM ID |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
labelTechnical | string | true | Product technical name | |
labelCommercial | array | true | Product Commercial name | |
description | array | false | Product description | |
crmId | string | false | Product CRM ID | |
reference | string | true | Product reference | |
link | string | false | Product link |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | string | |
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
key | string | false | Optionnal parameter |
Status Code | Description |
---|---|
204 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | string | uuid of product |
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
labelTechnical | string | true | Product technical name | |
labelCommercial | array | true | Product Commercial name | |
description | array | false | Product description | |
crmId | string | false | Product CRM ID | |
reference | string | true | Product reference | |
link | string | false | Product link |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The customer unique identifier | |
label | string | false | The customer name | |
crm_id | string | false | Vendor crm identifier | |
address | string | false | The customer address (street) | |
address_complement | string | false | Address complement | |
city | string | false | Address city | |
zip_code | string | false | Address zip code | |
country_state | string | false | Address country state | |
country_code | string | false | Address country code | |
website_url | string | false | The customer website url | |
vendor_id | string | false | the vendor identifier |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | The customer name | |
crm_id | string | false | Vendor crm identifier | |
address | string | false | The customer address (street) | |
address_complement | string | false | Address complement | |
city | string | false | Address city | |
zip_code | string | false | Address zip code | |
country_state | string | false | Address country state | |
country_code | string | false | Address country code | |
website_url | string | false | The customer website url | |
vendor_id | string | false | the vendor identifier |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | string | uuid of customer |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crm_id | string | false | The contact crm id | |
vendor_id | string | false | The vendor unique id | |
lastname | string | true | The contact lastname | |
firstname | string | false | The contact firstname | |
string | false | The contact email, required if contact's phone is missing | ||
phone | string | false | The contact phone number, required if contact's email is missing | |
job_position | string | true | The job position of the contact | |
language | string | false | The language of the contact, ISO 639-1 |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crm_id | string | false | The contact crm id | |
vendor_id | string | false | The vendor unique id | |
lastname | string | true | The contact lastname | |
firstname | string | false | The contact firstname | |
string | false | The contact email, required if contact's phone is missing | ||
phone | string | false | The contact phone number, required if contact's email is missing | |
job_position | string | true | The job position of the contact | |
language | string | false | The language of the contact, ISO 639-1 |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
customer_uuid | string | true | The customer uuid | |
customer_contact_uuid | string | true | The customer conatct uuid |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crm_id | string | true | The customer contact crm id |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The customer contact unique identifier |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | string | uuid of customer |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | required if crm id is null | |
crm_id | string | false | required if uuid id is null |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | required if crm id is null | |
crm_id | string | false | required if uuid id is null | |
firstname | string | false | if new value for firstname equals null, it will return an error | |
lastname | string | false | if new value for lastname equals null, it will return an error | |
string | false | if set null and phone is null, it will return an error | ||
phone | string | false | if set null and email is null, it will return an error | |
job_position | string | false | Manager job position, function, ex: Backend developper | |
department | string | false | Manager department, ex: Research and Developpement | |
address_street | string | false | Address, street | |
address_complement | string | false | Address, infos that not in street | |
address_zipcode | string | false | Address, zip code | |
address_city | string | false | Address, city | |
address_region | string | false | Address, region or state or province | |
address_country_code | string | false | Address, 2 letters country code, ISO 3166-1 alpha-2 | |
language | string | false | Manager language, 2 letters code |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crm_id | string | false | crm Id | |
firstname | string | true | Manager first name | |
lastname | string | true | Manager last name | |
string | false | required if phone is empty | ||
phone | string | false | required if email is empty | |
job_position | string | false | Manager job position, function, ex: Backend developper | |
department | string | false | Manager department, ex: Research and Developpement | |
address_street | string | false | Address, street | |
address_complement | string | false | Address, infos that not in street | |
address_zipcode | string | false | Address, zip code | |
address_city | string | false | Address, city | |
address_region | string | false | Address, region or state or province | |
address_country_code | string | false | Address, 2 letters country code, ISO 3166-1 alpha-2 | |
language | string | false | Manager language, 2 letters code |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of key account manager | |
partner_id | integer | true | the id of the partner to attach to |
Status Code | Description |
---|---|
204 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of key account manager | |
partner_id | integer | true | the id of the partner to detach to |
Status Code | Description |
---|---|
204 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | The lead source uuid, required if crm Id is missing | |
crm_id | string | false | The lead source crm Id, required if uuid is missing | |
remove | boolean | false | if true, the lead source will be remove from db (the default), else it is a dry run |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | The lead type uuid, required if crm Id is missing | |
value | string | true | The lead type value | |
crm_id | string | false | The lead type crm Id, required if uuid is missing | |
save | boolean | false | if true lead type will be saved in db (the default), else no, like a dry run |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
value | string | true | The lead type value | |
crm_id | string | false | The lead type crm Id | |
save | boolean | false | if true lead type will be saved in db (the default), else no, like a dry run |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json | ||
crmId |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crmId | string | true | The crm id of the lead source |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json | ||
uuid |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The uuid of the lead source |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | The lead type uuid, required if crm Id is missing | |
crm_id | string | false | The lead type crm Id, required if uuid is missing | |
remove | boolean | false | if true, the lead type will be remove from db (the default), else it is a dry run |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | false | The lead type uuid, required if crm Id is missing | |
value | string | true | The lead type value | |
crm_id | string | false | The lead type crm Id, required if uuid is missing | |
save | boolean | false | if true lead type will be saved in db (the default), else no, like a dry run |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
value | string | true | The lead type value | |
crm_id | string | false | The lead type crm Id | |
save | boolean | false | if true lead type will be saved in db (the default), else no, like a dry run |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json | ||
crmId |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
crmId | string | true | The crm id of the lead type |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json | ||
uuid |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The uuid of the lead type |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | Uuid of the activity aggregate to find |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
page |
|
||||||
per_page |
|
||||||
approbation |
|
||||||
pipeline_step_uuid |
|
Status Code | Description |
---|---|
200 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | Deal uuid | |
closing_date | datetime | false | ||
production_date | datetime | false | ||
customer_uuid | string | false | ||
customer_contact_uuid | string | false | ||
turnover_amount_initial | integer | true | ||
turnover_amount_calculated | integer | true | ||
turnover_currency_initial | string | true | ||
default_turnover_currency | string | true | ||
exchange_rate | float | true | ||
sales_volume | integer | false |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
channel_manager_id | integer | true | ||
closing_date | datetime | false | ||
production_date | datetime | false | ||
customer_uuid | string | true | ||
customer_contact_uuid | string | true | ||
partner_contact_id | integer | true | ||
product_uuid | string | true | concerned product uuid | |
turnover_amount_initial | integer | true | ||
turnover_amount_calculated | integer | true | ||
turnover_currency_initial | string | true | ||
default_turnover_currency | string | true | ||
exchange_rate | float | true | ||
sales_volume | integer | false |
Status Code | Description |
---|---|
200 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json | ||
vendorUserId |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
page |
|
||||||
per_page |
|
||||||
approbation |
|
||||||
pipeline_step_uuid |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
vendorUserId | integer | true | id of the vendor user, i.e. the channel manager |
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of the status |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | The new step name | |
vendor_id | string | false | The vendor uuid | |
position | integer | false | The step position | |
crm_id | string | false | The step crm id | |
is_mandatory | boolean | false | Is this step is mandatory in the pipeline flow | |
is_crm_synchronizable | boolean | false | ||
is_editable | boolean | false | ||
need_approval | boolean | false | ||
translations | boolean | false |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of the status |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user_id | integer | true | Id of the user who make the update | |
uuid | string | true | Uuid of the lead to update | |
crm_id | string | false | the crm id of the lead | |
channel_manager | object | false | JSON object with at least the key id and value the id of the channel manager | |
lead_type | object | false | SON object with the lead type uuid or crm id : 'uuid': ..., 'crm_id': ... | |
lead_source | object | false | SON object with the lead source uuid or crm id : 'uuid': ..., 'crm_id': ... | |
turnover_amount_initial | float | false | turnover amount before change | |
turnover_currency_initial | string | false | turnover amount currency, 3 letters, ISO 4217 | |
exchange_rate | float | false | exchange rate between initial currency and vendor currency | |
turnover_amount_calculated | float | false | turnover amount after change | |
default_turnover_currency | string | false | Vendor currency currency, 3 letters, ISO 4217 | |
customer | object | false | JSON object with the customer uuid ex: 'uuid': ... | |
customer_contact | object | false | JSON object with the customer contact uuid ex: 'uuid': ... |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user_id | integer | true | Id of the user who make the update | |
crm_id | string | false | the crm id of the lead | |
customer | object | true | JSON object with the customer uuid ex: 'uuid': ... | |
customer_contact | object | true | JSON object with the customer contact uuid ex: 'uuid': ... | |
channel_manager | object | true | JSON object with the channel manager id : 'id': ... | |
lead_type | object | false | SON object with the lead type uuid or crm id : 'uuid': ..., 'crm_id': ... | |
lead_source | object | false | SON object with the lead source uuid or crm id : 'uuid': ..., 'crm_id': ... | |
turnover_amount_initial | float | false | turnover amount before change | |
turnover_currency_initial | string | false | turnover amount currency, 3 letters, ISO 4217 | |
exchange_rate | float | false | exchange rate between initial currency and vendor currency | |
turnover_amount_calculated | float | false | turnover amount after change | |
default_turnover_currency | string | false | Vendor currency currency, 3 letters, ISO 4217 |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the lead uniq identifier |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of the lead | |
user_id | integer | true | Id of the user who make the update |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The lead unique identifier | |
reason | string | true | The reason why the lead is canceled as text |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
lead_uuid | string | true | The lead unique identifier | |
step_done_uuid | string | true | The step done unique identifier |
Status Code | Description |
---|---|
200 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the lead uniq identifier | |
user_id | integer | true | Id of the user who make the update |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The lead unique identifier |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
lead_uuid | string | true | the lead uniq identifier | |
reason | string | true | Text with incomplete reason |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
lead_uuid | string | true | the lead uniq identifier | |
partner_contact_id | string | true | the partner contact id |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
lead_uuid | string | true | the lead uniq identifier | |
partner_contact_id | string | true | the partner contact id |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
lead_uuid | string | true | the lead uniq identifier | |
partner_contact_id | string | true | the partner contact id | |
expire_at | string | false | the expiration date, format ISO 8601 |
Status Code | Description |
---|---|
200 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | the uuid of the status |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
404 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | uuid of opportunity to update | |
user_id | integer | true | id of user who create the resource | |
partner | object | false | ['partner']['id'] concerned partner id | |
contract_type | object | false | ['contract_type']['uuid'] concerned contract type uuid | |
status | object | false | ['status']['uuid'] concerned status uuid | |
product | object | false | ['product']['uuid'] concerned product uuid | |
vendor_id | int | false | ||
crm_id | string | false | ||
pay_percentage | float | false | ||
estimated_turnover_amount | integer | false | ||
estimated_turnover_currency | string | false | ||
number_of_clients | integer | false | ||
start_annual_sales_volume | integer | false | ||
targeted_annual_sales_volume | integer | false | ||
note | string | false | ||
concurrent | string | false | ||
closing_date | datetime | false | ||
production_date | datetime | false | ||
priority | object | false | ['priority']['uuid'] | |
production_time | object | false | ['production_time']['uuid'] |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user_id | integer | true | id of user who create the resource | |
partner | object | true | ['partner']['id'] concerned partner id | |
contract_type | object | true | ['contract_type']['uuid'] concerned contract type uuid | |
status | object | true | ['status']['uuid'] concerned status uuid | |
product | object | true | ['product']['uuid'] concerned product uuid | |
vendor_id | int | false | ||
crm_id | string | false | ||
pay_percentage | float | false | ||
estimated_turnover_amount | integer | false | ||
estimated_turnover_currency | string | false | ||
number_of_clients | integer | false | ||
start_annual_sales_volume | integer | false | ||
targeted_annual_sales_volume | integer | false | ||
note | string | false | ||
concurrent | string | false | ||
closing_date | datetime | false | ||
production_date | datetime | false | ||
priority | object | false | ['priority']['uuid'] | |
production_time | object | false | ['production_time']['uuid'] |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | The name of the new MySalesPlanDefinition, must be unique | |
is_default | boolean | false | Is MySalesPlanDefinition the default one |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | The name of the new MySalesPlanDefinition, must be unique | |
type | string | true | The type of the new MySalesPlanDefinition | |
is_default | boolean | false | Is MySalesPlanDefinition the default one, false if it is not defined |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | ||
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | The uuid of the MySalesPlanDefinition to delete |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
uuid | string | true | Uuid of the task | |
user_id | integer | true | Id of user who update the task | |
label | string | false | Label | |
description | string | false | description | |
due_date | datetime | false | Due date | |
assignee | object | true | ['assignee']['id'] | |
assignor | object | true | ['assignor']['id'] | |
partner_account | object | true | ['partner_account']['id'] | |
remind_me | string | false | Remind me | |
subject | object | false | ['subject']['uuid'] | |
documents | array | false | Array of objects [['uuid':...], [['uuid':...]] | |
read_only_assignees | array | false | Array of objects [['id':...], [['id':...]] |
Status Code | Description |
---|---|
200 |
|
404 |
|
400 |
|
500 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | Label | |
rrule | string | true | Rrule see https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3 | |
assignee | object | true | ['assignee']['id'] | |
assignor | object | true | ['assignor']['id'] | |
partner_account | object | true | ['partner_account']['id'] | |
description | string | false | Description | |
remind_me | string | false | Remind me | |
subject | object | false | ['subject']['uuid'] | |
documents | array | false | Array of objects [['uuid':...], [['uuid':...]] | |
read_only_assignees | array | false | Array of objects [['id':...], [['id':...]] |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
uuid | [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} | string | Task uuid |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
user_id |
|
Name | Requirement | Type | Description |
---|---|---|---|
vendorUserId | \d+ | integer | Vendor user id |
Name | Information | ||||||
---|---|---|---|---|---|---|---|
start |
|
||||||
end |
|
create notification affect partner .
Name | Requirement | Type | Description |
---|---|---|---|
idPartner | \d+ | integer | partner id |
idUser | \d+ | integer | user id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new partner and contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
title | string | true | Title of partner | |
url | string | true | url web site of company | |
status | boolean | true | status of partner | |
description | textarea | true | Description of partner | |
summaryDescrip | textarea | true | summaryDescrip of partner | |
groupName | string | false | group name of partner | |
sizeCompany | string | false | size company of partner | |
addressCompany | string | false | addressCompany of partner | |
addressComplement | string | false | address complement of partner | |
zipCode | string | false | zipCode of partner | |
countryPartner | integer | false | countryPartner of partner | |
cityPartner | string | false | cityPartner of partner | |
customers | string | false | customers of partner | |
customer | string | false | id customer of partner | |
certificationLevel | string | false | certificationLevel of partner | |
iadvizeChannelName | string | false | iadvizeChannelName of partner | |
partnerIndustries | collection | false | partnerIndustries of partner | |
contractStatus | string | false | contractStatus of partner | |
anotherCompany | string | false | anotherCompany of partner | |
contactChannelPhone | string | false | contactChannelPhone of partner | |
contactChannelEmail | string | false | contactChannelEmail of partner | |
contactChannelContact | boolean | false | contactChannelContact of partner | |
logo | string | false | log of partner | |
urlFacebook | string | false | urlFacebook of partner | |
urlYoutube | string | false | urlYoutube of partner | |
urlTwitter | string | false | urlTwitter of partner | |
urlInstagtam | string | false | urlInstagtam of partner | |
urlVimeo | string | false | urlVimeo of partner | |
user | integer | false | The id of user | |
idApiCrm | string | false | The id Api Crm | |
idPartnerPortal | integer | false | id partner portal |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | string | false | {length: max: 60} | Punchline (slogan), limité à 60 caractères |
title | string | true | Title of partner | |
url | string | true | Company url web site | |
status | boolean | true | status of partner 1 OR 0 | |
description | textarea | true | Long description | |
summaryDescrip | textarea | true | Short description | |
sizeCompany | string | false | Size of the company | |
addressCompany | string | false | address | |
addressComplementOne | string | false | address complement 1 | |
addressComplementTwo | string | false | address complement 2 | |
zipCode | string | false | zip code | |
businessCore | type | false | Business core list | |
countryPartner | integer | false | country | |
cityPartner | string | false | city | |
certificationLevel | string | false | Certification level list | |
partnerIndustries | collection | false | Industries list | |
logo | string | false | Logo | |
user | integer | false | Id user of the owner | |
anotherCompany | string | false | Associated company list | |
listOtherCompany | string | false | Associated company state | |
customers | integer | false | Exemple de client | |
commentInterne | integer | false | Commentaire Interne | |
internalContact | integer | false | Interlocuteur interne | |
nbClient | integer | false | Nombre de client | |
siret | integer | false | siret | |
arguments | string | false | Texte court d'arguments commerciaux | |
videoLink | string | false | Lien d'une vidéo online (embed youtube) | |
partnerSolutionLink | string | false | Lien vers la solution/produit du partner | |
customTagsProposal | string | false | Proposition de mots-clefs | |
idCrm | string | false | CRM Id | |
contractType | string | false | Contract Type Id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get filter partner.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | user id |
_format | xml|json | ||
locale | |||
filter | |||
customer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
filter | string | true | type filter : mypartner, teampartner or allpartner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get filter partner Fast.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | user id |
_format | xml|json | ||
locale | |||
customer | |||
filter |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
filter | string | true | type filter : mypartner, teampartner or allpartner | |
pipeline | string | false | Pipeline code filter |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get filter partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user | integer | false | user id | |
pipeline | string | false | Pipeline code filter | |
search | string | false | search filter |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Search partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
tags[] | collection | true | List tags | |
partner[] | collection | true | List partner | |
country[] | collection | true | List country |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Search partner Oodrive.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
tags[] | collection | true | List tags | |
partner[] | collection | true | List partner | |
country[] | collection | true | List country |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partner prospect.
Name | Requirement | Type | Description |
---|---|---|---|
title | string | Title of partner | |
lastname | string | Lastname of Contact Company | |
firstname | string | Firstname of Contact Company | |
position | string | Function of Contact Company | |
mobileNumber | string | Phone number of Contact Company | |
language | string | Language of Contact Company | |
string | Email of Contact Company | ||
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
addressCompany | string | false | Address of Company | |
zipCode | string | false | Zip code of Company | |
cityPartner | string | false | City of Company | |
countryPartner | integer | false | Country of Compan | |
contractType | string | false | Contract Type | |
product | string | false | Product | |
comment | string | false | Comment |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update an existing partner.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | string | false | {length: max: 60} | Punchline (slogan), limité à 60 caractères |
title | string | true | Title of partner | |
url | string | false | url web site of company | |
status | boolean | false | status of partner | |
description | textarea | false | Description of partner | |
summaryDescrip | textarea | false | summaryDescrip of partner | |
sizeCompany | string | false | size company of partner | |
addressCompany | string | false | addressCompany of partner | |
addressComplementOne | string | false | address complement line 1 of partner | |
addressComplementTwo | string | false | address complement line 2 of partner | |
zipCode | string | false | zipCode of partner | |
countryPartner | integer | false | countryPartner of partner | |
cityPartner | string | false | cityPartner of partner | |
customers | string | false | customers of partner | |
customer | string | false | id customer of partner | |
certificationLevel | string | false | certificationLevel of partner | |
anotherCompany | string | false | anotherCompany of partner | |
logo | string | false | log of partner | |
partnerIndustries | collection | false | partnerIndustries of partner | |
listOtherCompany | string | false | other company of partner | |
commentInterne | integer | false | Commentaire Interne | |
internalContact | integer | false | Interlocuteur interne | |
nbClient | integer | false | Nombre de client | |
siret | integer | false | siret | |
user | integer | true | user | |
arguments | string | false | Texte court d'arguments commerciaux | |
videoLink | string | false | Lien d'une vidéo online (embed youtube) | |
partnerSolutionLink | string | false | Lien vers la solution/produit du partner | |
customTagsProposal | string | false | Proposition de mots-clefs |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update enbled functional user.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json | ||
locale | |||
customer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
status | boolean | true | enabled of partner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update enbled functional user.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | user id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
partnerSelected | string | true | List partner selected |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update stage partner.
Name | Requirement | Type | Description |
---|---|---|---|
idStage | \d+ | integer | stage id |
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update an existing partner.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | string | false | {length: max: 60} | Punchline (slogan), limité à 60 caractères |
title | string | true | Title of partner | |
url | string | true | url web site of company | |
status | boolean | true | status of partner | |
description | textarea | true | Description of partner | |
summaryDescrip | textarea | true | summaryDescrip of partner | |
sizeCompany | string | false | size company of partner | |
addressCompany | string | false | addressCompany of partner | |
addressComplementOne | string | false | address complement line 1 of partner | |
addressComplementTwo | string | false | address complement line 2 of partner | |
zipCode | string | false | zipCode of partner | |
countryPartner | integer | false | countryPartner of partner | |
cityPartner | string | false | cityPartner of partner | |
customers | string | false | customers of partner | |
customer | string | false | id customer of partner | |
certificationLevel | string | false | certificationLevel of partner | |
anotherCompany | string | false | anotherCompany of partner | |
logo | string | false | log of partner | |
partnerIndustries | collection | true | partnerIndustries of partner | |
listOtherCompany | string | false | other company of partner | |
commentInterne | integer | false | Commentaire Interne | |
internalContact | integer | false | Interlocuteur interne | |
nbClient | integer | false | Nombre de client | |
siret | integer | false | siret | |
idCrm | string | false | crm id | |
arguments | string | false | Texte court d'arguments commerciaux | |
videoLink | string | false | Lien d'une vidéo online (embed youtube) | |
partnerSolutionLink | string | false | Lien vers la solution/produit du partner | |
customTagsProposal | string | false | Proposition de mots-clefs |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete a given partner.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
id | \d+ | integer | Identifier of the partner object to remove. |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
partner | Partner | Partner class. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
Check if the category is unique.
Name | Requirement | Type | Description |
---|---|---|---|
locale | \d+ | string | language |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | category name | |
idCustomer | integer | true | customer id | |
id | integer | true | category id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partner.partnerCategory.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
list | string | true | Config of filter |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Config wizard of search.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
list | string | true | config of wizard |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partner.partnerCategory.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | {not blank} | Name of partnerCategory |
description | string | true | Description of partnerCategory |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Partial update of an existing PartnerCategory FROM A CRM
Name | Requirement | Type | Description |
---|---|---|---|
categoryCrmId | \d+ | integer | id of partnerCategory in the customer CRM, must be unique |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | {not blank} | Name of partnerCategory |
description | string | false | Description of partnerCategory | |
customer | integer | true | Customer Id | |
idCrm | string | false | Unique identifier of the category in external customer CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete a given PartnerCategory from the customer CRM.
Name | Requirement | Type | Description |
---|---|---|---|
categoryCrmId | \d+ | integer | PartnerCategory customer CRM id. |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
categoryCrmId | integer | true | partnerCategory CRM id |
Status Code | Description |
---|---|
204 |
|
404 |
|
500 |
|
Get a partnerCategory.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idCategory |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
Create a new partner.partnerCategory.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
list | string | true | List of order |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a given partner.category.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerCategory id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | partnerCategory id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Partial update of an existing PartnerCategory
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerCategory id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | {not blank} | Name of partnerCategory |
description | string | false | Description of partnerCategory | |
customer | integer | true | Customer Id | |
idCrm | string | false | Unique identifier of the category in external customer CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing partner.category.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerCategory id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | {not blank} | Name of partnerCategory |
description | string | false | Description of partnerCategory |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Check if the partner have a main contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idPartner |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | id of partner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new partner contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
true | {email address} | email of partner contact | ||
firstname | string | true | firstname of partner contact | |
lastname | string | true | lastname of partner contact | |
gender | integer | false | Gender of partner contact, values: 0/null = unknown, 1 = male, 2 = female | |
company | integer | true | Partner | |
mobileNumber | string | true | mobileNumber of partner contact | |
officePhoneNumber | string | false | officePhoneNumber of partner contact | |
status | string | true | status of partner contact (Activated','Invited', 'Not Invited) | |
type | enum | true | type of contact (main.contact','standard.contact','portal.user) | |
position | string | true | position of partner contact | |
department | string | false | Department/BU of partner contact | |
logo | string | false | logo of partner contact | |
language | string | false | language of partner contact | |
idCrm | string | false | CRM Id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create and migrate for main contact a new partner contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
true | {email address} | email of partner contact | ||
firstname | string | true | firstname of partner contact | |
lastname | string | true | lastname of partner contact | |
gender | integer | false | Gender of partner contact, values: 0/null = unknown, 1 = male, 2 = female | |
company | integer | true | Partner | |
user | integer | true | User | |
mobileNumber | string | true | mobileNumber of partner contact | |
officePhoneNumber | string | false | officePhoneNumber of partner contact | |
status | string | true | status of partner contact | |
master | boolean | true | To define if the contact is a master or no. | |
type | enum | true | type of contact | |
position | string | true | position of partner contact | |
department | string | false | Department/BU of partner contact |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update an existing partnerContact from the customer CRM
Name | Requirement | Type | Description |
---|---|---|---|
idCrm | mixed | partnerContact id | |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | false | {email address} | email of partner contact | |
firstname | string | false | firstname of partner contact | |
lastname | string | false | lastname of partner contact | |
company | integer | false | id partner of partner contact | |
user | integer | false | User of partner contact | |
mobileNumber | string | false | mobile Number of partner contact | |
officePhoneNumber | string | false | office Phone Number of partner contact | |
status | string | false | status of partner contact (Activated','Invited', 'Not Invited) | |
position | string | false | position of partner contact | |
department | string | false | Department/BU of partner contact | |
type | string | false | type of partner contact (main.contact','standard.contact','portal.user) | |
logo | string | false | logo of partner contact | |
language | string | false | language of partner contact | |
idCrm | string | true | Contact Id from CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | id of partner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing partnerContact.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerContact id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | true | {email address} | email of partner contact | |
firstname | string | true | firstname of partner contact | |
lastname | string | true | lastname of partner contact | |
company | integer | true | id partner of partner contact | |
user | integer | false | User of partner contact | |
mobileNumber | string | false | mobile Number of partner contact | |
officePhoneNumber | string | false | office Phone Number of partner contact | |
status | string | true | status of partner contact (Activated','Invited', 'Not Invited) | |
department | string | false | Department/BU of partner contact | |
position | string | false | position of partner contact | |
type | string | false | type of partner contact (main.contact','standard.contact','portal.user) | |
logo | string | false | logo of partner contact | |
language | string | false | language of partner contact | |
idCrm | string | false | Contact Id from CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update status partner contact
Name | Requirement | Type | Description |
---|---|---|---|
status | string | partnerContact status | |
_format | xml|json | ||
locale | |||
id | integer | Identifier of partnerContact. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
false | {email address} |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete or Activate partner contact
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerContact id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
false | {email address} | |||
enable | boolean | true | enabled of partner contact |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing partnerContact.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerContact id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | true | {email address} | email of partner contact | |
firstname | string | true | firstname of partner contact | |
lastname | string | true | lastname of partner contact | |
gender | integer | false | Gender of partner contact, values: 0/null = unknown, 1 = male, 2 = female | |
company | integer | true | id partner of partner contact | |
user | integer | false | User of partner contact | |
mobileNumber | string | false | mobile Number of partner contact | |
officePhoneNumber | string | false | office Phone Number of partner contact | |
status | string | true | status of partner contact (Activated','Invited', 'Not Invited) | |
position | string | false | position of partner contact | |
department | string | false | Department/BU of partner contact | |
type | string | false | type of partner contact (main.contact','standard.contact','portal.user) | |
logo | string | false | logo of partner contact | |
language | string | false | language of partner contact | |
idCrm | string | false | External CRM Id |
Status Code | Description |
---|---|
200 |
|
500 |
|
Update and migrate for main contact an existing partnerContact.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerContact id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | true | {email address} | email of partner contact | |
firstname | string | true | firstname of partner contact | |
lastname | string | true | lastname of partner contact | |
gender | integer | false | Gender of partner contact, values: 0/null = unknown, 1 = male, 2 = female | |
company | integer | true | id partner of partner contact | |
user | integer | false | User of partner contact | |
mobileNumber | string | false | mobile Number of partner contact | |
officePhoneNumber | string | false | office Phone Number of partner contact | |
master | boolean | true | master of partner contact | |
status | string | true | status of partner contact | |
position | string | false | position of partner contact | |
department | string | false | Department/BU of partner contact | |
type | string | false | type of partner contact | |
logo | string | false | logo of partner contact |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idcrm | string | partner contact CRM id | |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
partner | PartnerContact | PartnerContact class. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
Get all partnerAllCityEnabled for Oodrive.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
term | string | false | search term |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all partnerAllCountryEnabled.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
term | string | false | search term |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all partnerAllCountry.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
term | string | false | search term |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all partnerCountry.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
term |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
term | string | false | search term |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new partner document.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | string |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label of partner document | |
typeDocument | string | true | typeDocument of partner document | |
partner | integer | true | id partner of partner document | |
status | boolean | true | status of partner document | |
urlDocument | string | true | url of partner document | |
byPartner | boolean | true | bool byPartner | |
directory | integer | false | The id of the document directory |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a given partner Document.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner Document id |
locale | |||
_format |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | partner id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
documentId | int | true | the document ID | |
contactId | int | true | the partner contact ID | |
share | boolean | false | if set to true, document is shared with the contact, else is 'un-sahred' | |
notify | boolean | false | if set to true, contact is notified by email of the sharing, else no |
Status Code | Description |
---|---|
204 |
|
400 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
documentId | int | true | the document ID | |
display | boolean | true | true the document is shown to the channel manager, false is hidden |
TODO nicolas : can be removed after feature/document-sharing
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerDocument id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
contactPrincipalOnly | boolean | true | display or not partner document |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
TODO nicolas : can be removed after feature/document-sharing Update an existing partner Document display.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerDocument id |
_format | xml|json | ||
locale | |||
sendEmail |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
display | boolean | true | display or not partner document |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing partner Document.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerDocument id |
_format | xml|json | ||
locale | string |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label of partner document | |
typeDocument | string | true | typeDocument of partner document | |
partner | integer | true | id partner of partner document | |
status | boolean | true | status of partner document | |
urlDocument | string | true | url of partner document | |
byPartner | boolean | true | from by Contact Principal | |
directoryId | integer | false | The id of the document directory |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new partner forms contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameContact | string | true | name contact partner | |
phoneContact | string | true | phone contact partner | |
companyContact | string | true | company contact partner | |
mailContact | string | true | mail contatc partner | |
subjectContact | string | true | subject contact partner | |
messageContact | textarea | false | message contact partner | |
partner | string | false | id partner contact partner | |
status | string | false | status contact partner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label industry |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label industry |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Affect tag to partner.
Name | Requirement | Type | Description |
---|---|---|---|
idPartner | \d+ | integer | partner id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | true | {not blank} | ||
affectedList | string | true | Name of partnerTag | |
noAffectedList | string | true | Logo of partnerTag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Check if the tag is unique.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | string | The langue used on application. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | tag name | |
idCustomer | integer | true | idCustomer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partnerTag.
Name | Requirement | Type | Description |
---|---|---|---|
id_category | \d+ | integer | category id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | {not blank} | Name of partnerTag |
logo | string | true | Logo of partnerTag | |
description | text | true | Description of partnerTag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Name | Requirement | Type | Description |
---|---|---|---|
partnerCrmId | \d+ | integer | partner crm id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
tags_to_add | string | false | Array of crm ids of tags to add | |
tags_to_remove | string | false | Array of crm ids of tags to remove |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Partial update an existing PartnerTag FROM A CRM.
Name | Requirement | Type | Description |
---|---|---|---|
categoryCrmId | \d+ | integer | PartnerCategory customer CRM id, must be unique |
tagCrmId | \d+ | integer | PartnerTag customer CRM id, must be unique |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | {not blank} | Name of partnerTag |
logo | string | false | Logo of partnerTag | |
description | text | false | Description of partnerTag | |
customer | integer | true | Customer Id | |
idCrm | string | false | Unique identifier of the tag in external customer CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete a given partnerTag from the customer CRM
Name | Requirement | Type | Description |
---|---|---|---|
tagCrmId | \d+ | integer | partnerTag CRM id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
tagCrmId | integer | true | partnerTag CRM id |
Status Code | Description |
---|---|
204 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
partnerCategoryId | \d+ | integer | partnerCategory partnerCategoryId |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partnerCategoryId | integer | true | partnerCategory partnerCategoryId |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete a given partnerTag.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerTag id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | partnerTag id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Partial update an existing PartnerTag
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerTag id |
id_category | \d+ | integer | PartnerCategory id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | {not blank} | Name of partnerTag |
logo | string | false | Logo of partnerTag | |
description | text | false | Description of partnerTag | |
customer | integer | true | Customer Id | |
idCrm | string | false | Unique identifier of the tag in external customer CRM |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update an existing partnerTag.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerTag id |
_format | xml|json | ||
locale | |||
id_category |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | {not blank} | Name of partnerTag |
logo | string | true | Logo of partnerTag | |
description | text | true | Description of partnerTag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
codeForDelete | string | code of the pipeline to be deleted | |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
codeForReplace | string | false | code of the pipeline to be replaced by |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Set Pipeline by import from base.
Name | Requirement | Type | Description |
---|---|---|---|
tokenBase | \d+ | string | base api token |
_format | xml|json | ||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
namePipeline | string | true | namePipeline |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
post Pipeline partner.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | id user |
_format | xml|json | ||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
filter | array | true | filter tableau associative des divers filtre onboarding | |
datefrom | date | true | date onboading |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update pipeline onboarding.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
isOnboarding | boolean | true | pipeline onboarding |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Set Pipeline.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
pipelines | array | true | list Base pipeline |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Set Onboarding Configuration.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
customer | string | true | id customer | |
pipeline | string | true | type pipeline (create or import) |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Set Pipeline.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
pipelines | array | true | list pipeline |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create/Update grid.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
grids | string | true | grids |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new profile.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameProfile | string | true | Name | |
logoProfile | string | true | language | |
descriptionProfile | string | true | status | |
idPartner | string | true | idPartner |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get all profile for partner
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
idPartner | \d+ | integer | idPartner |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Edit a Profile.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameProfile | string | true | Name | |
logoProfile | string | true | language | |
descriptionProfile | string | true | status |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label certification | |
logo | string | true | logo certification |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
locale | type | ||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label certification | |
logo | string | true | logo certification |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new report click.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner | |
element | string | true | element of click | |
visitor | string | true | ip of visitor | |
page | text | true | page |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get The number of people who clicked on the email button.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get The number of people who clicked on the phone button.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
get report mail.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new report partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | string | true | if of partner | |
visitor | string | true | ip of visitor | |
page | text | true | page |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get report of sales deal.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | id of partner | |
teamPipeline | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to | |
status | string | true | status of sale deal |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get report of sales deal transformation rate.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
team | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
POST buget Lead for team.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
team | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
POST number Lead for team.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
team | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get total budget of salesLead.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | id of partner | |
teamPipeline | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to | |
idTag | array | true | id of tag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get total numbers of salesLead.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | id of partner | |
teamPipeline | string | true | teamPipeline | |
datefrom | string | true | date from | |
dateto | string | true | date to | |
idTag | array | true | id of tag |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new report tag.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idTag | string | true | if of tag | |
visitor | string | true | ip of visitor | |
page | text | true | page |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get stat tag for Category, year and month.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
idCategory |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
year | string | false | year | |
month | string | false | month |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get stat tag for Category, year and month.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale | |||
idCategory | |||
year | |||
month |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
year | string | false | year | |
month | string | false | month |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get / Post stat lead and partner by industry
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idUser | |||
idCustomer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
filter | string | false | filter (array) |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update pipeline crm update.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
isCrmUpdate | boolean | true | pipeline needValidation |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update pipeline crm update.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id Deal Pipeline |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
mandatory | boolean | true | pipeline needValidation |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update pipeline need validation.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
isNeedValidation | boolean | true | pipeline needValidation |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update pipeline editable.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
isEditable | boolean | true | pipeline editable |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new sales deal By Contact Partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner of sales lead | |
idContact | integer | true | idContact of sales lead | |
approbation | integer | true | client name of sales lead | |
status | integer | true | objet status DealPipeline of sales lead | |
clientName | string | true | Client Name of sales lead | |
title | string | true | Name of sales lead | |
zipCode | integer | true | zipCode of sales lead | |
city | string | true | city of sales lead | |
clientCountryCode | string | false | Country code ISO 3166-1 alpha-2 of tyhe client | |
language | string | true | language of sales lead | |
firstName | string | true | firstName of sales lead | |
lastName | string | true | lastName of sales lead | |
string | true | email of sales lead | ||
phone | string | true | phone of sales lead | |
clientJobPosition | string | false | Job position of the client | |
industry | integer | true | industry of sales lead | |
clientRelationship | string | true | clientRelationship of sales lead | |
clientBudget | integer | true | clientBudget of sales lead | |
clientDateClose | datetime | true | clientDateClose of sales lead | |
concernedProduct | string | true | concernedProduct of sales lead | |
clientComment | string | true | clientComment of sales lead | |
website | string | false | client website of sales deal | |
currency | string | false | currency of sales deal | |
siret | string | false | Siret of sales deal | |
volume | string | false | Volume of sales deal | |
date2 | string | false | date2 of sales deal |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete Deal Sales.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
idSales | integer | Sales id. | |
idUserCurrent | integer | User id. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
Update a sales deal CPQ Oodrive.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
idDeal |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
cpq | string | true | cpq |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update a new sales deal By Contact Partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
idDeal | |||
action |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
approbation | integer | true | client name of sales lead | |
status | integer | true | objet status DealPipeline of sales lead | |
clientName | string | true | Client Name of sales lead | |
title | string | true | Name of sales lead | |
zipCode | integer | true | zipCode of sales lead | |
city | string | true | city of sales lead | |
clientCountryCode | string | false | Country code ISO 3166-1 alpha-2 of tyhe client | |
language | string | true | language of sales lead | |
firstName | string | true | firstName of sales lead | |
lastName | string | true | lastName of sales lead | |
string | true | email of sales lead | ||
phone | string | true | phone of sales lead | |
clientJobPosition | string | false | Job position of the client | |
industry | integer | true | industry of sales lead | |
clientRelationship | string | true | clientRelationship of sales lead | |
clientBudget | integer | true | clientBudget of sales lead | |
clientDateClose | datetime | true | clientDateClose of sales lead | |
concernedProduct | string | true | concernedProduct of sales lead | |
clientComment | string | true | clientComment of sales lead | |
channelManagerComment | string | true | channelManagerComment of sales lead | |
website | string | false | client website of sales deal | |
currency | string | false | currency of sales deal | |
commentRevival | string | false | Comment Relance of sales deal | |
siret | string | false | Siret of sales deal | |
volume | string | false | Volume of sales deal | |
date2 | string | false | date2 of sales deal | |
mySalesPlan | string | true | SalesPlanDefinitionUuid |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Set DealPipeline.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | id customer |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
pipelines | array | true | list pipeline |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new sales lead.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner of sales lead | |
idContact | integer | true | idContact of sales lead | |
clientName | string | true | client name of sales lead | |
status | string | true | status of sales lead | |
industry | string | true | industry of sales lead | |
project | string | false | project of sales lead | |
website | string | false | website of sales lead | |
monthlyConnection | string | true | monthly connection of sales lead | |
objective | enum | true | objective of sales lead | |
comment | string | false | comment of sales lead | |
timeline | string | true | timeline of sales lead | |
budget | string | false | budget of sales lead | |
serviceField | enum | true | service field of sales lead | |
toolsService | string | false | tools service of sales lead | |
percentageConfidence | enum | true | percentage confidence of sales lead | |
decisionMaker | string | false | decision maker of sales lead | |
typeLead | string | false | typeLead maker of sales lead | |
typeOpportunity | string | false | typeOpportunity maker of sales lead | |
procedure | string | false | procedure maker of sales lead | |
roleDecisionMaker | string | false | role Decision Maker of sales lead | |
phoneDecisionMaker | string | false | phone Decision Maker of sales lead | |
emailDecisionMaker | string | false | email Decision maker of sales lead | |
firstNameDecisionMaker | string | false | first name Decision maker of sales lead |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete Lead Sales.
Name | Requirement | Type | Description |
---|---|---|---|
idSales | \d+ | integer | Get id Sales |
idUserCurrent | \d+ | integer | id User Current |
_format | xml|json |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update status sales lead.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | sales lead id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
status | enum | true | status of sales lead |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update view sales lead.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | sales lead id |
_format | xml|json |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update view sales lead.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | sales lead id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner of sales lead | |
idContact | integer | true | idContact of sales lead | |
clientName | string | true | client name of sales lead | |
status | string | true | status of sales lead | |
industry | string | true | industry of sales lead | |
project | string | false | project of sales lead | |
website | string | false | website of sales lead | |
monthlyConnection | string | true | monthly connection of sales lead | |
objective | enum | true | objective of sales lead | |
comment | string | false | comment of sales lead | |
timeline | string | true | timeline of sales lead | |
budget | string | false | budget of sales lead | |
serviceField | enum | true | service field of sales lead | |
toolsService | string | false | tools service of sales lead | |
percentageConfidence | enum | true | percentage confidence of sales lead | |
decisionMaker | string | false | decision maker of sales lead | |
typeLead | string | false | typeLead maker of sales lead | |
typeOpportunity | string | false | typeOpportunity maker of sales lead | |
procedure | string | false | procedure maker of sales lead | |
roleDecisionMaker | string | false | role Decision Maker of sales lead | |
phoneDecisionMaker | string | false | phone Decision Maker of sales lead | |
emailDecisionMaker | string | false | email Decision maker of sales lead | |
firstNameDecisionMaker | string | false | first name Decision maker of sales lead |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new sales Lead sharing.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner of sales lead sharing | |
idContact | integer | true | idPartner of sales lead sharing | |
approbation | integer | true | client name of sales lead sharing | |
status | integer | true | objet status DealPipeline of sales lead sharing | |
clientName | string | true | Client Name of sales lead sharing | |
title | string | true | Name of sales lead sharing | |
zipCode | integer | true | zipCode of sales lead sharing | |
city | string | true | city of sales lead sharing | |
clientCountryCode | string | false | Country code ISO 3166-1 alpha-2 of tyhe client | |
language | string | true | language of sales lead sharing | |
firstName | string | true | firstName of sales lead sharing | |
lastName | string | true | lastName of sales lead sharing | |
string | true | email of sales lead sharing | ||
phone | string | true | phone of sales lead sharing | |
clientJobPosition | string | false | Job position of the client | |
industry | integer | true | industry of sales lead sharing | |
clientRelationship | string | true | clientRelationship of sales lead sharing | |
clientBudget | integer | true | clientBudget of sales lead sharing | |
clientDateClose | datetime | true | clientDateClose of sales lead sharing | |
concernedProduct | string | true | concernedProduct of sales lead sharing | |
clientComment | string | true | clientComment of sales lead sharing | |
channelManagerComment | string | true | channelManagerComment of sales lead sharing |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Update sales Lead sharing.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
idLeadSharing | |||
action |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
idPartner | integer | true | idPartner of sales lead sharing | |
idContact | integer | true | idContact of sales lead sharing | |
approbation | integer | true | client name of sales lead sharing | |
status | integer | true | objet status DealPipeline of sales lead sharing | |
clientName | string | true | Client Name of sales lead sharing | |
title | string | true | Name of sales lead sharing | |
zipCode | integer | true | zipCode of sales lead sharing | |
city | string | true | city of sales lead sharing | |
clientCountryCode | string | false | Country code ISO 3166-1 alpha-2 of tyhe client | |
language | string | true | language of sales lead sharing | |
firstName | string | true | firstName of sales lead sharing | |
lastName | string | true | lastName of sales lead sharing | |
string | true | email of sales lead sharing | ||
phone | string | true | phone of sales lead sharing | |
clientJobPosition | string | false | Job position of the client | |
industry | integer | true | industry of sales lead sharing | |
clientRelationship | string | true | clientRelationship of sales lead sharing | |
clientBudget | integer | true | clientBudget of sales lead sharing | |
clientDateClose | datetime | true | clientDateClose of sales lead sharing | |
concernedProduct | string | true | concernedProduct of sales lead sharing | |
clientComment | string | true | clientComment of sales lead sharing | |
channelManagerComment | string | true | channelManagerComment of sales lead sharing |
Status Code | Description |
---|---|
200 |
|
400 |
|
500 |
|
Create business.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner sales plan | |
year | string | true | year sales plan | |
rq1 | string | true | revenu q1 sales plan | |
rq2 | string | true | revenu q2 sales plan | |
rq3 | string | true | revenu q3 sales plan | |
rq4 | string | true | revenu q4 sales plan | |
sq1 | string | true | number of sales q1 sales plan | |
sq2 | string | true | number of sales q2 sales plan | |
sq3 | string | true | number of sales q3 sales plan | |
sq4 | string | true | number of sales q4 sales plan |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
update sales plan.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
partner | string | true | partner sales plan | |
year | string | true | year sales plan | |
rq1 | string | true | revenu q1 sales plan | |
rq2 | string | true | revenu q2 sales plan | |
rq3 | string | true | revenu q3 sales plan | |
rq4 | string | true | revenu q4 sales plan | |
sq1 | string | true | number of sales q1 sales plan | |
sq2 | string | true | number of sales q2 sales plan | |
sq3 | string | true | number of sales q3 sales plan | |
sq4 | string | true | number of sales q4 sales plan |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Post data for export Visit.
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
startDate | string | false | start Date | |
endDate | string | false | end Date |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new Tag Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
idFamily |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | Name | |
description | string | true | Description | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update an existing Tag Collateral.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partnerCategory id |
_format | xml|json | ||
locale | |||
idFamily |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | Name | |
description | string | false | Description | |
customer | string | false | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new document Activity .
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameFile | Collection | true | Collection file | |
viewPartner | Collection | true | Collection view partner | |
listTask | Collection | true | Collection Task | |
customer | integer | true | customer id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new Tasks .
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasks | string | true | Name | |
assignedTo | string | true | assignedTo | |
dueDate | date | true | dueDate | |
atDueDate | string | true | atDueDate | |
reminder | string | true | reminder | |
atReminder | string | true | atReminder | |
tasksStatus | string | true | tasksStatus | |
tasksType | string | true | tasksType | |
customer | string | true | Customer | |
recurrence | string | true | id recurrence | |
limitRecurrence | string | true | limit recurrence (max 100) |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get all Tasks for Partner .
Name | Requirement | Type | Description |
---|---|---|---|
idPartner | \d+ | integer | partner id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
filter_status | Collection | true | liste filter status |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all Tasks .
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user | string | true | user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Delete a Document activity .
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Tasks id |
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Edit a new Tasks .
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasks | string | true | Name | |
assignedTo | string | true | assignedTo | |
dueDate | date | true | dueDate | |
atDueDate | string | true | atDueDate | |
reminder | string | true | reminder | |
atReminder | string | true | atReminder | |
tasksStatus | string | true | tasksStatus | |
tasksType | string | true | tasksType | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Filter all Tasks .
Name | Requirement | Type | Description |
---|---|---|---|
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
user | string | true | user | |
iduser | string | true | id user | |
status | string | true | tasks status | |
dueDateStart | string | true | due date start | |
dueDateEnd | string | true | due date end | |
reminderDateStart | string | true | reminder date start | |
reminderDateEnd | string | true | reminder date end |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all Tasks by id status.
Name | Requirement | Type | Description |
---|---|---|---|
idStatus | \d+ | integer | Task Status id |
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all Tasks by id type.
Name | Requirement | Type | Description |
---|---|---|---|
idType | \d+ | integer | Task Type id |
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new programmed Tasks .
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasks | string | true | Name | |
week | string | true | week | |
recurrence | string | true | recurrence | |
assignedTo | string | true | assignedTo | |
dueDate | date | true | dueDate | |
atDueDate | string | true | atDueDate | |
reminder | string | true | reminder | |
atReminder | string | true | atReminder | |
tasksStatus | string | true | tasksStatus | |
tasksType | string | true | tasksType | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
put status activity .
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Tasks id |
customer | \d+ | integer | customer id |
status | \d+ | integer | status |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new Tasks Status.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasksStatus | string | true | Name | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a Tasks Status.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Tasks Status id |
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Edit a new Tasks Status.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasksStatus | string | true | Name | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Order Tasks Status.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
customer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
list | string | true | List of order |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new Tasks Type.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasksType | string | true | Name | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Delete a Tasks Type.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Tasks Type id |
customer | \d+ | integer | customer id |
_format | xml|json | ||
locale |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Edit a new Tasks Type.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
locale | |||
id |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
nameTasksType | string | true | Name | |
customer | string | true | Customer |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
affect user to team.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | team id |
idUser | \d+ | integer | user id |
roles | string | roles user into team | |
customer | string | customer into team | |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
parent | integer | false | id team parent |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
add team.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label of team | |
customer | string | true | customer of team |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
delete teamUSer.
Name | Requirement | Type | Description |
---|---|---|---|
idUser | \d+ | integer | user id |
roles | \d+ | integer | roles for team |
customer | \d+ | integer | customer |
_format | xml|json |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
edit team.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
label | string | true | label of team |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new user for partner contact.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
punchline | false | {length: max: 60} | ||
firstname | string | true | firstname of user | |
lastname | string | true | lastname of user | |
string | true | email of user | ||
plainPassword | string | true | password of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
delete user.
Name | Requirement | Type | Description |
---|---|---|---|
idCustomer | \d+ | integer | customer id |
_format | xml|json | ||
idUser |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update a password for user.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
token | string | true | token of user | |
string | true | email of user | ||
plainPassword | string | true | password of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get all partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | true | email of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Get all partner.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
customer |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
string | true | email of user | ||
customer | string | true | email of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Create a new functional user.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
username | true | {not blank}, {length: min: 2, max: 255} | ||
string | true | {not blank}, {length: min: 2, max: 254}, {email address} | email of user | |
plainPassword | true | {not blank}, {length: min: 2, max: 4096} | ||
firstname | string | true | firstname of user | |
lastname | string | true | lastname of user | |
language | string | true | the default language | |
picture | string | true | the picture of user | |
allRoles | array | true | the roles of user | |
manager | User | true | the manager of user | |
idCrm | string | false | Crm Id |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Get all user by level.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json | ||
level |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
level | string | true | level of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
Update profil.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
username | true | {not blank}, {length: min: 2, max: 255} | ||
true | {not blank}, {length: min: 2, max: 254}, {email address} | |||
plainPassword | true | {not blank}, {length: min: 2, max: 4096} | ||
firstname | string | true | firstname of user | |
lastname | string | true | lastname of user | |
language | string | true | the default language | |
picture | string | true | the picture of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update enbled functional user.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
username | true | {not blank}, {length: min: 2, max: 255} | ||
true | {not blank}, {length: min: 2, max: 254}, {email address} | |||
plainPassword | true | {not blank}, {length: min: 2, max: 4096} | ||
isEnabled | boolean | true | enabled of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Update functional user.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | partner id |
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
username | true | {not blank}, {length: min: 2, max: 255} | ||
true | {not blank}, {length: min: 2, max: 254}, {email address} | |||
plainPassword | true | {not blank}, {length: min: 2, max: 4096} | ||
firstname | string | true | firstname of user | |
lastname | string | true | lastname of user | |
language | string | true | the default language | |
picture | User | true | the picture of user | |
allRoles | array | true | the roles of user | |
manager | User | true | the manager of user | |
customer | User | true | the customer of user | |
idPartner | User | true | the idPartner of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Create a new partner contact user.
Name | Requirement | Type | Description |
---|---|---|---|
_format | xml|json |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
username | true | {not blank}, {length: min: 2, max: 255} | ||
string | true | {not blank}, {length: min: 2, max: 254}, {email address} | email of user | |
plainPassword | true | {not blank}, {length: min: 2, max: 4096} | ||
firstname | string | true | firstname of user | |
lastname | string | true | lastname of user | |
language | string | true | the default language | |
picture | string | true | the picture of user | |
allRoles | array | true | list of user roles (Eg role1, role2 ... | |
manager | User | true | the manager of user |
Status Code | Description |
---|---|
200 |
|
404 |
|
500 |
|
206 |
|
Documentation auto-generated on Wed, 30 Oct 24 01:29:51 +0100