CFL Contacts API

• 3/2/2023
• 2 minutes to read

APIPublisher = 'christiaens';
APIGroup = 'bocountdynamics';
APIVersion = 'v2.0';
EntityName = 'contact';
EntitySetName = 'contacts';

GET

method: GET
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/contacts

Entity:

{
    "@odata.etag": "W/\"JzE5Ozg5NTkwMTQwNjA0MDAyNDQ4MzIxOzAwOyc=\"",
    "id": "5ac1ebf3-14e7-ec11-adf7-94f78238fd27",
    "no": "50005",
    "type": "Company",
    "name": "TEST",
    "companyNo": "50005",
    "companyName": "TEST",
    "contactBusinessRelation": "None",
    "address": "Britse Lei 1",
    "address2": "",
    "city": "ANTWERPEN",
    "county": "",
    "countryRegionCode": "BE",
    "postCode": "2000",
    "phoneNo": "",
    "mobilePhoneNo": "",
    "email": "",
    "homePage": "",
    "searchName": "TEST AANPASSING",
    "privacyBlocked": false,
    "taxRegistrationNumber": "",
    "organizationalLevelCode":"",
    "lastInteractionDate": "0001-01-01",
    "systemModifiedAt": "2022-06-08T10:24:31.857Z"
}

CREATE

method: POST
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/contacts
Body:

{
    "type": "Company",
    "name": "TEST",
    "address": "Britse Lei 1",
    "address2": "",
    "city": "ANTWERPEN",
    "county": "",
    "countryRegionCode": "BE",
    "postCode": "2000",
    "phoneNo": "",
    "mobilePhoneNo": "",
    "email": "",
    "homePage": "",
    "searchName": "TEST",
    "privacyBlocked": false,
    "taxRegistrationNumber": "",
    "organizationalLevelCode":""
}

DELETE

method: DELETE
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/contacts(5ac1ebf3-14e7-ec11-adf7-94f78238fd27)

UPDATE

method: PATCH
Url: https://server:port/serverinstance/api/Christiaens/BoCountDynamics/v2.0/companies(companyid)/contacts(5ac1ebf3-14e7-ec11-adf7-94f78238fd27)
Headers:
"If-Match" : W/"JzE5Ozg5NTkwMTQwNjA0MDAyNDQ4MzIxOzAwOyc="
Body:

{
    "name": "Test aanpassing"
}