DigiOffice Gateway Web Services

<back to all web services

Get4PSBCCompanies

Get companies mapped to 4PS specific result set

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

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

    ///<summary>
    ///Get companies mapped to 4PS specific result set
    ///</summary>
    [<Api(Description="Get companies mapped to 4PS specific result set")>]
    [<ApiResponse(Description="Companies are returned in the message body", IsDefaultResponse=true, StatusCode=200)>]
    [<AllowNullLiteral>]
    type Get4PSBCCompanies() = 
        ///<summary>
        ///Number of items in the resultset per page. Default = 100
        ///</summary>
        [<ApiMember(Description="Number of items in the resultset per page. Default = 100")>]
        member val PageSize:Int32 = new Int32() with get,set

        ///<summary>
        ///Page number of paged resultset. Default = 1
        ///</summary>
        [<ApiMember(Description="Page number of paged resultset. Default = 1")>]
        member val PageNumber:Int32 = new Int32() with get,set

F# Get4PSBCCompanies 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/4PSBC/companies HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		visitAddress: String,
		visitAddress2: String,
		vatRegistrationNo: String,
		vendorNo: String,
		customerNo: String,
		eMail: String,
		companyName4ps: String,
		systemId: 00000000-0000-0000-0000-000000000000,
		digiOfficeId: 00000000-0000-0000-0000-000000000000,
		cocRegistrationNo: String,
		cocLocationNo: String,
		cocCity: String,
		visitAddressCountryRegionId: String,
		countryRegionId: String,
		countryRegionCodeId: String,
		mobilePhoneNo: String,
		name: String,
		name2: String,
		visitAddressCity: String,
		city: String,
		address: String,
		visitAddressPostCode: String,
		postCode: String,
		phoneNo: String,
		phoneNo2: String,
		homePage: String,
		no: String,
		companyId: 00000000-0000-0000-0000-000000000000,
		blocked: False,
		nameAbbreviation: String
	}
]