DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Project

Import project record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportProject
"use strict";
export class Header {
    /** @param {{Contains?:string,Date?:string,MessageID?:string,Sender?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Inhoud van het bericht */
    Contains;
    /**
     * @type {string}
     * @description Datum aanmaak bericht */
    Date;
    /**
     * @type {string}
     * @description ID voor het bericht */
    MessageID;
    /**
     * @type {string}
     * @description Verzender van het bericht */
    Sender;
}
export class Response_Project {
    /** @param {{Status?:string,Errors?:string,DigiOfficeProjectID?:string,DigiOfficeGlobalID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Reponse status (Ok/Error) */
    Status;
    /**
     * @type {string}
     * @description Errors summary */
    Errors;
    /**
     * @type {string}
     * @description ID of the project in DigiOffice */
    DigiOfficeProjectID;
    /**
     * @type {string}
     * @description GlobalID (digiOfficeId) of the project in DigiOffice */
    DigiOfficeGlobalID;
}
export class IDB_4PSBC_Response_Project {
    /** @param {{Header?:Header,Response?:Response_Project}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Header of the response */
    Header;
    /**
     * @type {Response_Project}
     * @description Response body */
    Response;
}
export class Data_Project {
    /** @param {{systemId?:string,digiOfficeId?:string,companyId?:string,no?:string,description?:string,description2?:string,visitAddress?:string,visitAddress2?:string,visitAddressPostCode?:string,visitAddressCity?:string,visitAddressCountryRegionId?:string,address?:string,postCode?:string,city?:string,countryRegionId?:string,projectStatus?:string,startingDate?:string,endingDate?:string,contactId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    systemId;
    /** @type {?string} */
    digiOfficeId;
    /** @type {?string} */
    companyId;
    /** @type {string} */
    no;
    /** @type {string} */
    description;
    /** @type {string} */
    description2;
    /** @type {string} */
    visitAddress;
    /** @type {string} */
    visitAddress2;
    /** @type {string} */
    visitAddressPostCode;
    /** @type {string} */
    visitAddressCity;
    /** @type {string} */
    visitAddressCountryRegionId;
    /** @type {string} */
    address;
    /** @type {string} */
    postCode;
    /** @type {string} */
    city;
    /** @type {string} */
    countryRegionId;
    /** @type {string} */
    projectStatus;
    /** @type {?string} */
    startingDate;
    /** @type {?string} */
    endingDate;
    /** @type {?string} */
    contactId;
}
export class IDB_4PSBC_Import_Project {
    /** @param {{Header?:Header,Data?:Data_Project}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Header}
     * @description Message header */
    Header;
    /**
     * @type {Data_Project}
     * @description Message data */
    Data;
}

JavaScript IDB_4PSBC_Import_Project DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/4PSBC/ImportProject HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Data":{"systemId":"00000000-0000-0000-0000-000000000000","digiOfficeId":"00000000-0000-0000-0000-000000000000","companyId":"00000000-0000-0000-0000-000000000000","no":"String","description":"String","description2":"String","visitAddress":"String","visitAddress2":"String","visitAddressPostCode":"String","visitAddressCity":"String","visitAddressCountryRegionId":"String","address":"String","postCode":"String","city":"String","countryRegionId":"String","projectStatus":"String","startingDate":"0001-01-01T00:00:00.0000000","endingDate":"0001-01-01T00:00:00.0000000","contactId":"00000000-0000-0000-0000-000000000000"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Header":{"Contains":"String","Date":"String","MessageID":"String","Sender":"String"},"Response":{"Status":"String","Errors":"String","DigiOfficeProjectID":"String","DigiOfficeGlobalID":"00000000-0000-0000-0000-000000000000"}}