DigiOffice Gateway Web Services

<back to all web services

IDB_4PSBC_Import_Project

Import project record vanuit 4PS

Requires Authentication
The following routes are available for this service:
POST/api/4PSBC/ImportProject
namespace DO.Synchronization.IDB_4PSBC.DTO

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Header() = 
        ///<summary>
        ///Inhoud van het bericht
        ///</summary>
        [<ApiMember(Description="Inhoud van het bericht")>]
        member val Contains:String = null with get,set

        ///<summary>
        ///Datum aanmaak bericht
        ///</summary>
        [<ApiMember(Description="Datum aanmaak bericht")>]
        member val Date:String = null with get,set

        ///<summary>
        ///ID voor het bericht
        ///</summary>
        [<ApiMember(Description="ID voor het bericht")>]
        member val MessageID:String = null with get,set

        ///<summary>
        ///Verzender van het bericht
        ///</summary>
        [<ApiMember(Description="Verzender van het bericht")>]
        member val Sender:String = null with get,set

    [<AllowNullLiteral>]
    type Response_Project() = 
        ///<summary>
        ///Reponse status (Ok/Error)
        ///</summary>
        [<ApiMember(Description="Reponse status (Ok/Error)", IsRequired=true)>]
        member val Status:String = null with get,set

        ///<summary>
        ///Errors summary
        ///</summary>
        [<ApiMember(Description="Errors summary")>]
        member val Errors:String = null with get,set

        ///<summary>
        ///ID of the project in DigiOffice
        ///</summary>
        [<ApiMember(Description="ID of the project in DigiOffice", IsRequired=true)>]
        member val DigiOfficeProjectID:String = null with get,set

        ///<summary>
        ///GlobalID (digiOfficeId) of the project in DigiOffice
        ///</summary>
        [<ApiMember(Description="GlobalID (digiOfficeId) of the project in DigiOffice", IsRequired=true)>]
        member val DigiOfficeGlobalID:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type IDB_4PSBC_Response_Project() = 
        ///<summary>
        ///Header of the response
        ///</summary>
        [<ApiMember(Description="Header of the response", IsRequired=true)>]
        member val Header:Header = null with get,set

        ///<summary>
        ///Response body
        ///</summary>
        [<ApiMember(Description="Response body", IsRequired=true)>]
        member val Response:Response_Project = null with get,set

    [<AllowNullLiteral>]
    type Data_Project() = 
        member val systemId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val digiOfficeId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val companyId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val no:String = null with get,set
        member val description:String = null with get,set
        member val description2:String = null with get,set
        member val visitAddress:String = null with get,set
        member val visitAddress2:String = null with get,set
        member val visitAddressPostCode:String = null with get,set
        member val visitAddressCity:String = null with get,set
        member val visitAddressCountryRegionId:String = null with get,set
        member val address:String = null with get,set
        member val postCode:String = null with get,set
        member val city:String = null with get,set
        member val countryRegionId:String = null with get,set
        member val projectStatus:String = null with get,set
        member val startingDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val endingDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val contactId:Nullable<Guid> = new Nullable<Guid>() with get,set

    ///<summary>
    ///Import project record vanuit 4PS
    ///</summary>
    [<Api(Description="Import project record vanuit 4PS")>]
    [<AllowNullLiteral>]
    type IDB_4PSBC_Import_Project() = 
        ///<summary>
        ///Message header
        ///</summary>
        [<ApiMember(Description="Message header", IsRequired=true)>]
        member val Header:Header = null with get,set

        ///<summary>
        ///Message data
        ///</summary>
        [<ApiMember(Description="Message data", IsRequired=true)>]
        member val Data:Data_Project = null with get,set

F# IDB_4PSBC_Import_Project 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.

POST /api/4PSBC/ImportProject HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Data: 
	{
		systemId: 00000000-0000-0000-0000-000000000000,
		digiOfficeId: 00000000-0000-0000-0000-000000000000,
		companyId: 00000000-0000-0000-0000-000000000000,
		no: String,
		description: String,
		description2: String,
		visitAddress: String,
		visitAddress2: String,
		visitAddressPostCode: String,
		visitAddressCity: String,
		visitAddressCountryRegionId: String,
		address: String,
		postCode: String,
		city: String,
		countryRegionId: String,
		projectStatus: String,
		startingDate: 0001-01-01,
		endingDate: 0001-01-01,
		contactId: 00000000-0000-0000-0000-000000000000
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		Contains: String,
		Date: String,
		MessageID: String,
		Sender: String
	},
	Response: 
	{
		Status: String,
		Errors: String,
		DigiOfficeProjectID: String
	}
}