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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class ProjectDetails implements IConvertible
{
    int? ID;
    String? GlobalID;
    String? Number;
    String? Name;
    String? Description1;
    String? Description2;
    bool? Active;
    int? CorrespondenceInternalCompanyID;
    String? CorrespondenceInternalCompanyName;
    String? CorrespondenceInternalCompanyGlobalID;
    String? Postalcode;
    String? City;
    int? CountryID;
    String? CountryGlobalID;
    String? CountryName;
    String? GeoLocation;
    String? AddressComplete;
    int? CategoryID;
    String? CategoryDescription;
    String? CategoryGlobalID;

    ProjectDetails({this.ID,this.GlobalID,this.Number,this.Name,this.Description1,this.Description2,this.Active,this.CorrespondenceInternalCompanyID,this.CorrespondenceInternalCompanyName,this.CorrespondenceInternalCompanyGlobalID,this.Postalcode,this.City,this.CountryID,this.CountryGlobalID,this.CountryName,this.GeoLocation,this.AddressComplete,this.CategoryID,this.CategoryDescription,this.CategoryGlobalID});
    ProjectDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        GlobalID = json['GlobalID'];
        Number = json['Number'];
        Name = json['Name'];
        Description1 = json['Description1'];
        Description2 = json['Description2'];
        Active = json['Active'];
        CorrespondenceInternalCompanyID = json['CorrespondenceInternalCompanyID'];
        CorrespondenceInternalCompanyName = json['CorrespondenceInternalCompanyName'];
        CorrespondenceInternalCompanyGlobalID = json['CorrespondenceInternalCompanyGlobalID'];
        Postalcode = json['Postalcode'];
        City = json['City'];
        CountryID = json['CountryID'];
        CountryGlobalID = json['CountryGlobalID'];
        CountryName = json['CountryName'];
        GeoLocation = json['GeoLocation'];
        AddressComplete = json['AddressComplete'];
        CategoryID = json['CategoryID'];
        CategoryDescription = json['CategoryDescription'];
        CategoryGlobalID = json['CategoryGlobalID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'GlobalID': GlobalID,
        'Number': Number,
        'Name': Name,
        'Description1': Description1,
        'Description2': Description2,
        'Active': Active,
        'CorrespondenceInternalCompanyID': CorrespondenceInternalCompanyID,
        'CorrespondenceInternalCompanyName': CorrespondenceInternalCompanyName,
        'CorrespondenceInternalCompanyGlobalID': CorrespondenceInternalCompanyGlobalID,
        'Postalcode': Postalcode,
        'City': City,
        'CountryID': CountryID,
        'CountryGlobalID': CountryGlobalID,
        'CountryName': CountryName,
        'GeoLocation': GeoLocation,
        'AddressComplete': AddressComplete,
        'CategoryID': CategoryID,
        'CategoryDescription': CategoryDescription,
        'CategoryGlobalID': CategoryGlobalID
    };

    getTypeName() => "ProjectDetails";
    TypeContext? context = _ctx;
}

class GetProjectDetails implements IConvertible
{
    int? ID;

    GetProjectDetails({this.ID});
    GetProjectDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID
    };

    getTypeName() => "GetProjectDetails";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'ProjectDetails': TypeInfo(TypeOf.Class, create:() => ProjectDetails()),
    'GetProjectDetails': TypeInfo(TypeOf.Class, create:() => GetProjectDetails()),
});

Dart 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
}