DigiOffice Gateway Web Services

GetProjectDetailsByGlobalID

The following routes are available for this service:
GET	/api/global/projects/{GlobalID}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProjectDetails:
    id: int = 0
    global_i_d: Optional[str] = None
    number: Optional[str] = None
    name: Optional[str] = None
    description1: Optional[str] = None
    description2: Optional[str] = None
    active: bool = False
    correspondence_internal_company_i_d: int = 0
    correspondence_internal_company_name: Optional[str] = None
    correspondence_internal_company_global_i_d: Optional[str] = None
    postalcode: Optional[str] = None
    city: Optional[str] = None
    country_i_d: int = 0
    country_global_i_d: Optional[str] = None
    country_name: Optional[str] = None
    geo_location: Optional[str] = None
    address_complete: Optional[str] = None
    category_i_d: int = 0
    category_description: Optional[str] = None
    category_global_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProjectDetailsByGlobalID:
    global_i_d: Optional[str] = None

Python 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: doapigw.baasbv.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>