API - Contacts
This is a fork of page 30071 "APIV2 - Contacts" from version 23.3.14876.15704. Added support for Extra Fields.
Object Definition
| Object Type | Page |
| Object ID | 70314145 |
| Object Name | QWESR API - Contacts |
| Source Table | Contact |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | contacts |
| EntityName | contact |
Events
| Name | Description |
|---|---|
| OnAfterInsert(Record Contact; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised after a record is inserted. |
| OnBeforeModify(Record Contact; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text; List of [Integer]) | Raised before a record is modified. |
| OnGetExtraValues(Record Contact; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text) | Raised after a record is read from the database. Makes it possible to set the ExtraValues 1..10, to be returned to the client. |
Example
Read
Get a list of Contacts.
GET businesscentralPrefix/companies({id})/contacts?$schemaversion=2.0
Get a single Contact.
GET businesscentralPrefix/companies({id})/contacts({id})?$schemaversion=2.0
Create
Create a new Contact.
POST businesscentralPrefix/companies({id})/contacts?$schemaversion=2.0
Content-type: application/json
{
"type": "Company",
"displayName": "Cronus"
}
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | number | Code[20] | |
| Field | type | Enum "Contact Type" | |
| Field | displayName | Text[100] | |
| Field | companyNumber | Code[20] | |
| Field | companyName | Text[100] | |
| Field | contactBusinessRelation | Enum "Contact Business Relation" | Yes |
| Field | addressLine1 | Text[100] | |
| Field | addressLine2 | Text[50] | |
| Field | city | Text[30] | |
| Field | state | Text[30] | |
| Field | country | Code[10] | |
| Field | postalCode | Code[20] | |
| Field | phoneNumber | Text[30] | |
| Field | mobilePhoneNumber | Text[30] | |
| Field | Text[80] | ||
| Field | website | Text[255] | |
| Field | searchName | Code[100] | |
| Field | privacyBlocked | Boolean | |
| Field | taxRegistrationNumber | Text[50] | |
| Field | lastInteractionDate | Date | Yes |
| Field | lastModifiedDateTime | DateTime | Yes |
| Field | extraValue1 | Text | |
| Field | extraValue2 | Text | |
| Field | extraValue3 | Text | |
| Field | extraValue4 | Text | |
| Field | extraValue5 | Text | |
| Field | extraValue6 | Text | |
| Field | extraValue7 | Text | |
| Field | extraValue8 | Text | |
| Field | extraValue9 | Text | |
| Field | extraValue10 | Text | |
| Sub page | picture |
This documentation is generated from Spider v27.0