DigiOffice Gateway Web Services

<back to all web services

GetProjectDetails

Requires Authentication
The following routes are available for this service:
GET/api/projects/{ID}
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: Optional[int] = None
    global_i_d: Optional[str] = None
    number: Optional[str] = None
    name: Optional[str] = None
    description1: Optional[str] = None
    description2: Optional[str] = None
    active: Optional[bool] = None
    correspondence_internal_company_i_d: Optional[int] = None
    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: Optional[int] = None
    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: Optional[int] = None
    category_description: Optional[str] = None
    category_global_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProjectDetails:
    id: Optional[int] = None

Python 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: digiofficeapigateway.deltares.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
}