DigiOffice Gateway Web Services

<back to all web services

GetProjectDetailsByGlobalID

Requires Authentication
The following routes are available for this service:
GET/api/global/projects/{GlobalID}
"use strict";
export class ProjectDetails {
    /** @param {{ID?:number,GlobalID?:string,Number?:string,Name?:string,Description1?:string,Description2?:string,Active?:boolean,CorrespondenceInternalCompanyID?:number,CorrespondenceInternalCompanyName?:string,CorrespondenceInternalCompanyGlobalID?:string,Postalcode?:string,City?:string,CountryID?:number,CountryGlobalID?:string,CountryName?:string,GeoLocation?:string,AddressComplete?:string,CategoryID?:number,CategoryDescription?:string,CategoryGlobalID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    GlobalID;
    /** @type {string} */
    Number;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description1;
    /** @type {string} */
    Description2;
    /** @type {boolean} */
    Active;
    /** @type {number} */
    CorrespondenceInternalCompanyID;
    /** @type {string} */
    CorrespondenceInternalCompanyName;
    /** @type {string} */
    CorrespondenceInternalCompanyGlobalID;
    /** @type {string} */
    Postalcode;
    /** @type {string} */
    City;
    /** @type {number} */
    CountryID;
    /** @type {string} */
    CountryGlobalID;
    /** @type {string} */
    CountryName;
    /** @type {string} */
    GeoLocation;
    /** @type {string} */
    AddressComplete;
    /** @type {number} */
    CategoryID;
    /** @type {string} */
    CategoryDescription;
    /** @type {string} */
    CategoryGlobalID;
}
export class GetProjectDetailsByGlobalID {
    /** @param {{GlobalID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    GlobalID;
}

JavaScript GetProjectDetailsByGlobalID DTOs

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

HTTP + CSV

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

GET /api/global/projects/{GlobalID} HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","Number":"String","Name":"String","Description1":"String","Description2":"String","Active":false,"CorrespondenceInternalCompanyID":0,"CorrespondenceInternalCompanyName":"String","CorrespondenceInternalCompanyGlobalID":"00000000-0000-0000-0000-000000000000","Postalcode":"String","City":"String","CountryID":0,"CountryGlobalID":"00000000-0000-0000-0000-000000000000","CountryName":"String","GeoLocation":"String","AddressComplete":"String","CategoryID":0,"CategoryDescription":"String","CategoryGlobalID":"00000000-0000-0000-0000-000000000000"}