DigiOffice 4PS IDB API

Number of APIs: 21

1. Metadata

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/$metadata

Door middel van het opvragen van de metadata is het mogelijk om de mogelijkheden van de API op te vragen.

2. applicationsInfo

GET {{Protocol}}://{{Server}}/{{NST}}/api/4ps/app/v1.1/applicationsInfo?Company={{CentralCompany}}

Door middel van de applicationInfo is het mogelijk om de applicatie informatie van 4PS op te vragen. De versie van 4PS staat in de Value currentAppVersion.

EndFragment

3. Companies

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/companies

Door middel van de Companies collectie is het mogelijk om de bedrijven (dit zijn de interne bedrijven in DigiOffice) op te halen vanuit 4PS.

Opmerkelijk; ieder bedrijf heeft een uniek systenmVersion. (nog een keer vragen aan Klaas).

4. CompaniesTop1 (set EnvVariabelen)

GET {{Protocol}}://{{Server}}/{{NST}}/api/4ps/app/v1.0/companies?$top=1

Door middel van deze collectie is het mogelijk om de eerste company uit te vragen. Dit wordt geregeld door de param $top = 1 op het tabblad Params.

Op het Tests tabblad worden de variabelen CompanySystemId en CompanyName door middel van het resultaat gevuld.

StartFragment

EndFragment

5. crmCompaniesInsert

POST {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmCompanies?Company={{CentralCompany}}

Door middel van de crmCompaniesInsert is het mogelijk om een nieuw bedrijf (relatie) aan te maken in 4PS.

6. crmCompanies (set crmCompanySystemId)

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmCompanies?$filter=no eq 'BE00016'&Company={{CentralCompany}}

Door middel van de crmCompanies is het mogelijk om de bedrijven (crm) - (Relaties in DigiOffice) op te halen.

Door de parameter '$filter' met de waarde no eq 'BE00016' is het mogelijk om 1 specifieke relaties op te halen.

Door middel van het test-script (tabblad Tests) wordt het systemId in de variabele CalculationSystemId. Dit systemID is benodigd voor het doen van een update.

7. crmCompaniesUpdate

PATCH {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmCompanies({{crmCompanySystemId}})?Company={{CentralCompany}}

Door middel van de crmCompaniesUpdate is het mogelijk om een bedrijf (relatie) te updaten. Merk op dat er voor het bijwerken een SystemID benodigd is, welke in de url wordt meegegeven:

v1.0/crmCompanies**(<**CalculationSystemId>**)**?Company={{CentralCompany}}

8. crmPersonsInsert

POST {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmPersons?Company={{CentralCompany}}

Eenvoudig voorbeeld van het toevoegen van een persoon.

9. crmPersons

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmPersons?Company={{CentralCompany}}

10. crmPersons (set PersonSystemId)

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmPersons?Company={{CentralCompany}}&$top=1&$filter=no eq 'PE00010'

Door middel van de crmPersons wordt Gonnie Geelhoud opgehaald (door middel van het $filter = 'PE00010').

Vanuit het resultaat wordt de variabele PersonSystemId gezet, welke wordt gebruikt bij de crmPersonsUpdate.

11. crmPersonsUpdate

PATCH {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmPersons({{PersonSystemId}})?Company={{CentralCompany}}

Door middel van de crmPersons wordt Gonnie Geelhoud opgehaald (door middel van het $filter = 'PE00010').

Vanuit het resultaat wordt de variabele PersonSystemId gezet, welke wordt gebruikt bij de crmPersonsUpdate.

12. crmContactPersonsInsert

POST {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmContactPersons?Company={{CentralCompany}}

Door middel van de crmContactPersonsInsert is het mogelijk om een contactpersoon toe te voegen.

Merk op dat crmCompanyId en crmPersonId beide 4PS systemIDs dienen te zijn van respectievelijk het bedrijf (relatie in DigiOffice) en de persoon. Beide dienen dus al aanwezig te zijn in DigiOffice en 4PS.

EndFragment

EndFragment

13. crmContactPersons

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmContactPersons?Company={{CentralCompany}}

Request haalt de contactpersonen op van het bedrijf meegegeven in de ContralCompany variabele.

14. crmContactPersons (set ContactSystemId)

GET {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmContactPersons?Company={{CentralCompany}}&$filter=no eq 'CP000119'

Request haalt de contactpersoon Gonnie Geelhoed gekoppeld aan bownlingbaan de Kegel op. Dit aan de hand van het $filter = no eq 'CP000119'.

15. crmContactPersonsUpdate

PATCH {{Protocol}}://{{Server}}/{{NST}}/api/{{ApiPublisher}}/{{ApiGroup}}/v1.0/crmContactPersons({{ContactSystemId}})?Company={{CentralCompany}}

Request haalt de contactpersoon Gonnie Geelhoed gekoppeld aan bownlingbaan de Kegel op. Dit aan de hand van het $filter = no eq 'CP000119'.

16. Get Documents

GET {{Protocol}}://{{Server}}/{{NST}}/api/4ps/Document/v1.0/documents?Company={{Company}}&$orderby=no

17. Get Document

GET {{Protocol}}://{{Server}}/{{NST}}/api/4ps/Document/v1.0/documents({{DocumentSystemID}})?Company={{Company}}&$expand=documentLinks

18. Add Document fout in dev4

POST {{Protocol}}://{{Server}}/{{NST}}/api/4ps/Document/v1.0/documents?$expand=documentLinks

19. Update Document with Documentlinks

PUT {{Protocol}}://{{Server}}/{{NST}}/api/4ps/App/v1.0/documents({{DocumentSystemID}})

20. Get DigiOfficeDocuments

GET {{Protocol}}://{{Server}}/{{NST}}/api/4ps/idbApi/v1.0/digiOfficeDocuments

21. LinkDigiOfficeDocument

PUT {{Protocol}}://{{Server}}/{{NST}}/api/4ps/idbApi/v1.0/companies(e4f961fd-dac4-ed11-bb62-8e6997113edc)/digiOfficeDocuments({{DocumentSystemID}})

Key	Datatype	Required	Description
Company	string