CRM in Cloud Web API documentations

Funzioni e scopo

Il controller Company consente di eseguire innumerevoli operazioni nelle aziende del sistema.

Il Business Object che rappresenta le aziende è la classe CompanyBO.

Il DTO (Data Transfer Object) usato per rappresentare il modello dati dell'azienda è CompanyDTO

Sicurezza

Questo controller è sottoposto alle regole di security del sistema.
Per maggiori dettagli, fare riferimento alla sezione Authentication

Note

Le indicazioni riportate di seguito hanno lo scopo di illustrare le funzionalità e le caratteristiche di questo Web API controller.

Aliases

Questo controller è invocabile tramite altri nomi oltre a quello di default.

Ciò significa che, facendo riferimento alla grammatica di routing ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) è possibile utilizzare un fragment differente per il componente {controller}.

Di seguito è riportata la lista di tali alias per il fragment {controller}, in ordine di preferenza d'uso.

Alias	Path
Companies	/api/v1/Companies
Company	/api/v1/Company

Authentication

Token JWT

Al fine di potere invocare le API REST, è necessario ottenere un token di autenticazione tramite l’apposito servizio /Auth/Login.
Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Bearer Authentication

La "Bearer Authentication" (tradotta "autenticazione al portatore", detta anche "autenticazione token") è uno schema di autenticazione HTTP che coinvolge un token di sicurezza denominato bearer token.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Identificazione dell’applicazione chiamante

Alcune delle funzioni delle API REST possono essere utilizzate solamente se (oltre ad una corretta autenticazione dell’utente) si esegue anche una dichiarazione dell’applicazione chiamante.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Actions & Paths

Di seguito sono elencate le azioni REST eseguibili tramite le Web API.
Le azioni sono raggruppate per "topic".
Clicca un "topic" per visualizzare le diverse azioni in esso contenute.

Ad ogni azione corrisponde un metodo interno alla classe del controller Web API, ed un set di paths di routing utilizzabili per invocarla.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Company/CreateOrUpdate /api/v1/Company/ /api/v1/Company/Exists /api/v1/Company/ /api/v1/Company/Humanize /api/v1/Company/GetFull /api/v1/Company/GetNewInstance
Multiple CRUD	/api/v1/Company/MultipleDelete /api/v1/Company/MultipleExists /api/v1/Company/MultipleGet
Activities	/api/v1/Company/Activities /api/v1/Company/ActivitiesIds /api/v1/Company/Activities/Count
Contacts	/api/v1/Company/Contacts /api/v1/Company/ContactsIds /api/v1/Company/Contacts/Count
Documents	/api/v1/Company/Documents /api/v1/Company/DocumentsIds /api/v1/Company/Documents/Count
External References	/api/v1/Company/SearchIdsByExternalReference /api/v1/Company/GetByExternalReference /api/v1/Company/DeleteByExternalReference /api/v1/Company/MapByExternalReference /api/v1/Company/ResetExternalReferences /api/v1/Company/UnmapByExternalReference /api/v1/Company/GetIdsMappedByExternalReference /api/v1/Company/GetItemsMappedByExternalReference /api/v1/Company/GetIdsNotMappedByExternalReference /api/v1/Company/GetIdsByExternalReference /api/v1/Company/GetItemsNotMappedByExternalReference
Flow	/api/v1/Company/Flows /api/v1/Company/FlowsIds /api/v1/Company/Flows/Count
Lists	/api/v1/Company/Lists /api/v1/Company/ListsIds /api/v1/Company/ListsCount
Mailings	/api/v1/Company/Mailings /api/v1/Company/MailingsIds /api/v1/Company/MailingsCount
Misc	/api/v1/Company/ResolveCustomerToken /api/v1/Company/Location /api/v1/Company/Templates /api/v1/Company/HtmlPreview /api/v1/Company/GetDownloadUrl /api/v1/Company/Archive /api/v1/Company/Photo /api/v1/Company/GetSample /api/v1/Company/GetBoDeleteModes /api/v1/Company/FreeFields /api/v1/Company/Recent /api/v1/Company/GetHash /api/v1/Company/PrintableFields
OData	/api/v1/Company/SearchIds /api/v1/Company/Search /api/v1/Company/Count
Opportunities	/api/v1/Company/Opportunities /api/v1/Company/OpportunitiesIds /api/v1/Company/Opportunities/Count
Preview	/api/v1/Company/Previews /api/v1/Company/Preview
Sub Locations	/api/v1/Company/SubLocations /api/v1/Company/SubLocationsIds /api/v1/Company/SubLocations/Count
Swagger	/api/v1/Company/GetPolymorphicSchema /api/v1/Company/GetStandardSchema /api/v1/Company/GetSwagger

GET: /api/v1/Company/

Routing template:

/api/{version}/Company/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
id	integer	YES	Path	Format: int64
template	string	NO	Query
request	CompanyPrintableRequest	NO	Query

Name	Type	Required	In	Features
externalReference	string	NO	Query
excludeDeletedItems	boolean	NO	Query

Name	Type	Required	In	Features
serializePropertiesAsDictionary	boolean	NO	Query	Default: True
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
generateSample	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
force	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
includeFull	boolean	NO	Query	Default: True
includeNesting	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
filter	string	NO	Query
orderBy	string	NO	Query
skip	integer	NO	Query	Format: int64
top	integer	NO	Query	Format: int64
select	string	NO	Query

Name	Description
ActionResultDTO	Action Result
ActivityBOActivityRelationDTO	Activity BO Activity Relation
ActivityBOHourBandDTO	Activity BO Hour Band
ActivityCostBOPriceDetailDTO	Activity Cost BO Price Detail
ActivityDTO	Activity
ActivityEMailDataDTO	Activity EMail Data
ActivityFaxDataDTO	Activity Fax Data
ActivityPriorities	Activity Priorities
ActivitySource	Activity Source
ActivityStates	Activity States
ActivityType	Activity Type
AddressAccuracy	Address Accuracy
AddressDTO	Address
AddressesListDTO	Addresses List
AlarmActionType	Alarm Action Type
AlarmDTO	Alarm
AlarmNotificationDTO	Alarm Notification
AlarmTimeValueType	Alarm Time Value Type
AnagraphicStatus	Anagraphic Status
ApprovedStatus	Approved Status
BoDeleteMode	Bo Delete Mode
BusinessObjectType	Business Object Type
CompanyDTO	Company
CompanyPrintableRequest	Company Printable Request
ContactDTO	Contact
ContactOtherCompanyDTO	Contact Other Company
CRMTables	CRM Tables
CrossActivityWith	Cross Activity With
CrossType	Cross Type
DefaultCodeType	Default Code Type
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
DirectionDTO	Direction
DTOPropertyUsage	DTO Property Usage
EMailNormalizedDTO	EMail Normalized
EMailNormalizeType	EMail Normalize Type
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossDTO	File Cross
FileCrossTypes	File Cross Types
FilePreview	File Preview
FlowDTO	Flow
FlowLinkDTO	Flow Link
FlowLogDTO	Flow Log
FlowStepResult	Flow Step Result
FreeFieldsBOItemDTO	Free Fields BO Item
FreeFieldsBOItemLocalizingDTO	Free Fields BO Item Localizing
FreeFieldsBOTreeItemDTO	Free Fields BO Tree Item
FreeFieldsType	Free Fields Type
Gender	Gender
GeoDTO	Geo
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
InfluencerRoleType	Influencer Role Type
JToken	J Token
LinkItem	Link Item
LiquidStruct	Liquid Struct
ListDTO	List
ListMailingListRightsDTO	List Mailing List Rights
LocalizeType	Localize Type
LocalizingDTO	Localizing
LocationDTO	Location
MailAddressDTO	Mail Address
MailingDeliveryDTO	Mailing Delivery
MailingListRightsDTO	Mailing List Rights
MailListStatus	Mail List Status
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
NormalizerNormalizeAddressDTO	Normalizer Normalize Address
NormalizerNormalizeCityDTO	Normalizer Normalize City
OpportunityCompetitorDTO	Opportunity Competitor
OpportunityDTO	Opportunity
OpportunityPartnerDTO	Opportunity Partner
OpportunityProductDTO	Opportunity Product
OpportunityReferrerDTO	Opportunity Referrer
OpportunityRefStatusType	Opportunity Ref Status Type
OpportunityStatus	Opportunity Status
PaymentCrossDTO	Payment Cross
PhoneNormalizedDTO	Phone Normalized
PhoneNormalizeType	Phone Normalize Type
PrivacyActivityMotivationImplicitConsentDTO	Privacy Activity Motivation Implicit Consent
PrivacyManagementDTO	Privacy Management
PrivacyTypeManagementDTO	Privacy Type Management
RelationDTO	Relation
SampleGenerationStrategy	Sample Generation Strategy
ServiceCrossType	Service Cross Type
SharePermissionDTO	Share Permission
SharingDTO	Sharing
ShippedBy	Shipped By
StorageDTO	Storage
StoragePermission	Storage Permission
SyncPropertyFlag	Sync Property Flag
TargetListCrossType	Target List Cross Type
ToDoStates	To Do States
TypePrivacy	Type Privacy

APIv1italianoCompany

Company

Funzioni e scopo

Sicurezza

Note

Aliases

Authentication

Token JWT

Bearer Authentication

Identificazione dell’applicazione chiamante

Actions & Paths

GET: /api/v1/Company/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Provalo !

DELETE: /api/v1/Company/{id}

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Provalo !

GET: /api/v1/Company/{id}

Parameters:

Produces:

Response: 200 (Success) CompanyDTO

Samples

Provalo !

GET: /api/v1/Company/{id}/Activities

Parameters:

Produces:

Response: 200 (Success) ActivityDTO

Samples

Provalo !

GET: /api/v1/Company/{id}/Activities/Count

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Provalo !

GET: /api/v1/Company/{id}/ActivitiesIds

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Provalo !

GET: /api/v1/Company/{id}/Archive

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Provalo !

GET: /api/v1/Company/{id}/Contacts

Parameters:

Produces:

Response: 200 (Success) ContactDTO

Samples

Provalo !

GET: /api/v1/Company/{id}/Contacts/Count

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Provalo !

GET: /api/v1/Company/{id}/ContactsIds

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Provalo !

GET: /api/v1/Company/{id}/Documents

Parameters:

Produces:

Response: 200 (Success) StorageDTO

Samples

Provalo !

GET: /api/v1/Company/{id}/Documents/Count

Parameters:

Produces:

API v1 italiano Company