DigiOffice Gateway Web Services

<back to all web services

Get4PSBCPersons

Get persons mapped to 4PS specific result set

Requires Authentication
The following routes are available for this service:
GET/api/4PSBC/persons
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Get persons mapped to 4PS specific result set
*/
// @Api(Description="Get persons mapped to 4PS specific result set")
// @ApiResponse(Description="Persons are returned in the message body", IsDefaultResponse=true, StatusCode=200)
class Get4PSBCPersons implements IConvertible
{
    /**
    * Number of items in the resultset per page. Default = 100
    */
    // @ApiMember(Description="Number of items in the resultset per page. Default = 100")
    int? PageSize;

    /**
    * Page number of paged resultset. Default = 1
    */
    // @ApiMember(Description="Page number of paged resultset. Default = 1")
    int? PageNumber;

    Get4PSBCPersons({this.PageSize,this.PageNumber});
    Get4PSBCPersons.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'test_dogw.klokgroep.nl', types: <String, TypeInfo> {
    'Get4PSBCPersons': TypeInfo(TypeOf.Class, create:() => Get4PSBCPersons()),
});

Dart Get4PSBCPersons DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/4PSBC/persons HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

[{"systemId":"00000000-0000-0000-0000-000000000000","digiOfficeId":"00000000-0000-0000-0000-000000000000","companyName4ps":"String","no":"String","firstName":"String","middleName":"String","surname":"String","gender":"String","initials":"String","nameAbbreviation":"String","title":"String","titleBehindTheName":"String","phoneNo":"String","mobilePhoneNo":"String","eMail":"String","visitAddress":"String","visitAddress2":"String","visitAddressPostCode":"String","visitAddressCity":"String","visitAddressCountryRegionId":"String","companyId":"00000000-0000-0000-0000-000000000000","blocked":false,"cocCity":"String"}]