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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetProjectDetails
    {
        public Integer ID = null;
        
        public Integer getId() { return ID; }
        public GetProjectDetails setId(Integer value) { this.ID = value; return this; }
    }

    public static class ProjectDetails
    {
        public Integer ID = null;
        public UUID GlobalID = null;
        public String Number = null;
        public String Name = null;
        public String Description1 = null;
        public String Description2 = null;
        public Boolean Active = null;
        public Integer CorrespondenceInternalCompanyID = null;
        public String CorrespondenceInternalCompanyName = null;
        public UUID CorrespondenceInternalCompanyGlobalID = null;
        public String Postalcode = null;
        public String City = null;
        public Integer CountryID = null;
        public UUID CountryGlobalID = null;
        public String CountryName = null;
        public String GeoLocation = null;
        public String AddressComplete = null;
        public Integer CategoryID = null;
        public String CategoryDescription = null;
        public UUID CategoryGlobalID = null;
        
        public Integer getId() { return ID; }
        public ProjectDetails setId(Integer value) { this.ID = value; return this; }
        public UUID getGlobalID() { return GlobalID; }
        public ProjectDetails setGlobalID(UUID value) { this.GlobalID = value; return this; }
        public String getNumber() { return Number; }
        public ProjectDetails setNumber(String value) { this.Number = value; return this; }
        public String getName() { return Name; }
        public ProjectDetails setName(String value) { this.Name = value; return this; }
        public String getDescription1() { return Description1; }
        public ProjectDetails setDescription1(String value) { this.Description1 = value; return this; }
        public String getDescription2() { return Description2; }
        public ProjectDetails setDescription2(String value) { this.Description2 = value; return this; }
        public Boolean isActive() { return Active; }
        public ProjectDetails setActive(Boolean value) { this.Active = value; return this; }
        public Integer getCorrespondenceInternalCompanyID() { return CorrespondenceInternalCompanyID; }
        public ProjectDetails setCorrespondenceInternalCompanyID(Integer value) { this.CorrespondenceInternalCompanyID = value; return this; }
        public String getCorrespondenceInternalCompanyName() { return CorrespondenceInternalCompanyName; }
        public ProjectDetails setCorrespondenceInternalCompanyName(String value) { this.CorrespondenceInternalCompanyName = value; return this; }
        public UUID getCorrespondenceInternalCompanyGlobalID() { return CorrespondenceInternalCompanyGlobalID; }
        public ProjectDetails setCorrespondenceInternalCompanyGlobalID(UUID value) { this.CorrespondenceInternalCompanyGlobalID = value; return this; }
        public String getPostalcode() { return Postalcode; }
        public ProjectDetails setPostalcode(String value) { this.Postalcode = value; return this; }
        public String getCity() { return City; }
        public ProjectDetails setCity(String value) { this.City = value; return this; }
        public Integer getCountryID() { return CountryID; }
        public ProjectDetails setCountryID(Integer value) { this.CountryID = value; return this; }
        public UUID getCountryGlobalID() { return CountryGlobalID; }
        public ProjectDetails setCountryGlobalID(UUID value) { this.CountryGlobalID = value; return this; }
        public String getCountryName() { return CountryName; }
        public ProjectDetails setCountryName(String value) { this.CountryName = value; return this; }
        public String getGeoLocation() { return GeoLocation; }
        public ProjectDetails setGeoLocation(String value) { this.GeoLocation = value; return this; }
        public String getAddressComplete() { return AddressComplete; }
        public ProjectDetails setAddressComplete(String value) { this.AddressComplete = value; return this; }
        public Integer getCategoryID() { return CategoryID; }
        public ProjectDetails setCategoryID(Integer value) { this.CategoryID = value; return this; }
        public String getCategoryDescription() { return CategoryDescription; }
        public ProjectDetails setCategoryDescription(String value) { this.CategoryDescription = value; return this; }
        public UUID getCategoryGlobalID() { return CategoryGlobalID; }
        public ProjectDetails setCategoryGlobalID(UUID value) { this.CategoryGlobalID = value; return this; }
    }

}

Java GetProjectDetails DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":0,"GlobalID":"00000000-0000-0000-0000-000000000000","Number":"String","Name":"String","Description1":"String","Description2":"String","Active":false,"CorrespondenceInternalCompanyID":0,"CorrespondenceInternalCompanyName":"String","CorrespondenceInternalCompanyGlobalID":"00000000-0000-0000-0000-000000000000","Postalcode":"String","City":"String","CountryID":0,"CountryGlobalID":"00000000-0000-0000-0000-000000000000","CountryName":"String","GeoLocation":"String","AddressComplete":"String","CategoryID":0,"CategoryDescription":"String","CategoryGlobalID":"00000000-0000-0000-0000-000000000000"}