DigiOffice API Services 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 .xml suffix or ?format=xml

HTTP + XML

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-do-services.klokgroep.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Project">
  <Active>false</Active>
  <AddressComplete>String</AddressComplete>
  <CategoryDescription>String</CategoryDescription>
  <CategoryGlobalID>00000000-0000-0000-0000-000000000000</CategoryGlobalID>
  <CategoryID>0</CategoryID>
  <City>String</City>
  <CorrespondenceInternalCompanyGlobalID>00000000-0000-0000-0000-000000000000</CorrespondenceInternalCompanyGlobalID>
  <CorrespondenceInternalCompanyID>0</CorrespondenceInternalCompanyID>
  <CorrespondenceInternalCompanyName>String</CorrespondenceInternalCompanyName>
  <CountryGlobalID>00000000-0000-0000-0000-000000000000</CountryGlobalID>
  <CountryID>0</CountryID>
  <CountryName>String</CountryName>
  <Description1>String</Description1>
  <Description2>String</Description2>
  <GeoLocation>String</GeoLocation>
  <GlobalID>00000000-0000-0000-0000-000000000000</GlobalID>
  <ID>0</ID>
  <Name>String</Name>
  <Number>String</Number>
  <Postalcode>String</Postalcode>
</ProjectDetails>