DigiOffice Gateway Web Services

<back to all web services

GetProjectDetails

Requires Authentication
The following routes are available for this service:
GET/api/projects/{ID}
"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 GetProjectDetails {
    /** @param {{ID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
}

JavaScript GetProjectDetails DTOs

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

HTTP + JSV

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

GET /api/projects/{ID} HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Number: String,
	Name: String,
	Description1: String,
	Description2: String,
	Active: False,
	CorrespondenceInternalCompanyID: 0,
	CorrespondenceInternalCompanyName: String,
	Postalcode: String,
	City: String,
	CountryID: 0,
	CountryName: String,
	GeoLocation: String,
	AddressComplete: String,
	CategoryID: 0,
	CategoryDescription: String
}