Server

<back to all web services

GetObjekt

Objekte
Requires Authentication
The following routes are available for this service:
GET/api/v1/objekte/{Guid}

// @DataContract
export class Address
{
    // @DataMember
    public guid: string;

    // @DataMember
    public street: string;

    // @DataMember
    public street2: string;

    // @DataMember
    public streetNumber: string;

    // @DataMember
    public zipcode: string;

    // @DataMember
    public city: string;

    // @DataMember
    public mailbox: string;

    // @DataMember
    public additional: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Nutzeinheit
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Nummer")
    public Nummer: string;

    // @DataMember(Name="Lage")
    public Lage: string;

    // @DataMember(Name="ObjektGuid")
    public ObjektGuid: string;

    // @DataMember(Name="AdressGuid")
    public AdressGuid: string;

    public constructor(init?: Partial<Nutzeinheit>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BillingInformation
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Von")
    public Von: string;

    // @DataMember(Name="Bis")
    public Bis: string;

    // @DataMember(Name="IstAbgeschlossen")
    public IstAbgeschlossen: boolean;

    // @DataMember(Name="HatNebenkosten")
    public HatNebenkosten: boolean;

    // @DataMember(Name="ObjektGuid")
    public ObjektGuid: string;

    // @DataMember(Name="AnmerkungKundenportal")
    public AnmerkungKundenportal: string;

    // @DataMember(Name="KundenportalMarkedDone")
    public KundenportalMarkedDone: boolean;

    // @DataMember(Name="MarkedDoneAt")
    public MarkedDoneAt?: string;

    // @DataMember(Name="KundenportalMarkedClosed")
    public KundenportalMarkedClosed: boolean;

    // @DataMember(Name="MarkedClosedAt")
    public MarkedClosedAt?: string;

    public constructor(init?: Partial<BillingInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Objekt
{
    // @DataMember
    public guid: string;

    // @DataMember
    public number: string;

    // @DataMember
    public isCompleted: string;

    // @DataMember
    public completedDate?: string;

    // @DataMember
    public address: Address;

    // @DataMember
    public nutzeinheiten: Nutzeinheit[];

    // @DataMember
    public billingInformations: BillingInformation[];

    public constructor(init?: Partial<Objekt>) { (Object as any).assign(this, init); }
}

export class GetObjektResponse
{
    public objekt: Objekt;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetObjektResponse>) { (Object as any).assign(this, init); }
}

export class GetObjekt implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public guid: string;

    // @ApiMember(ParameterType="query")
    public include: string;

    public constructor(init?: Partial<GetObjekt>) { (Object as any).assign(this, init); }
}

TypeScript GetObjekt DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/v1/objekte/{Guid} HTTP/1.1 
Host: brendle-schneider-servdesk.eras-online.de 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"objekt":{"guid":"00000000000000000000000000000000","number":"String","isCompleted":"String","completedDate":"0001-01-01T00:00:00.0000000Z","address":{"guid":"00000000000000000000000000000000","street":"String","street2":"String","streetNumber":"String","zipcode":"String","city":"String","mailbox":"String","additional":"String"},"nutzeinheiten":[{"guid":"00000000000000000000000000000000","number":"String","location":"String","address":{"guid":"00000000000000000000000000000000","street":"String","street2":"String","streetNumber":"String","zipcode":"String","city":"String","mailbox":"String","additional":"String"},"nutzer":[{"guid":"00000000000000000000000000000000","name1":"String","name2":"String","name3":"String","name4":"String","nutzerType":"Leerstand","nutzeinheitNumberExternal":"String","nutzerInNutzeinheitSequence":0,"rangeFrom":"0001-01-01T00:00:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","isDeleted":false,"isCreatedByApp":false,"IstUvi":"String","EigentuemerBewohnt":"String","Email":"String","Mobil":"String","title":"String","salutation":"String"}],"ownerNutzeinheiten":[{"guid":"00000000000000000000000000000000","name1":"String","name2":"String","name3":"String","name4":"String","rangeFrom":"0001-01-01T00:00:00.0000000Z","rangeTo":"0001-01-01T00:00:00.0000000Z","title":"String","salutation":"String","address":{"guid":"00000000000000000000000000000000","street":"String","street2":"String","streetNumber":"String","zipcode":"String","city":"String","mailbox":"String","additional":"String"}}],"nutzeinheitenDevices":[{"guid":"00000000000000000000000000000000","assignedFromDate":"0001-01-01T00:00:00.0000000Z","assignedToDate":"0001-01-01T00:00:00.0000000Z","room":"String","ongoingNumber":"String","isRented":false,"isMaintained":false,"device":{"guid":"00000000000000000000000000000000","number":"String","label":"String","description":"String","installationDate":"0001-01-01T00:00:00.0000000Z","deinstallationDate":"0001-01-01T00:00:00.0000000Z","calibrationDate":"0001-01-01T00:00:00.0000000Z","unit":"L","note":"String","deviceCatalog":{"Guid":"String","TypKurz":"String","TypLang":"String","Ablesbar":false,"Klasse":"String","Abzug":false,"Hkvv":false,"Funk":false},"deviceConsumptions":[{"guid":"00000000000000000000000000000000","deviceReading":0,"deviceReadingDate":"0001-01-01T00:00:00.0000000Z","deviceReadingKind":"ZA","changeDate":"0001-01-01T00:00:00.0000000Z","note":"String","ampouleColour":"String","deviceGuid":"String"}]}}]}],"billingInformations":[{"guid":"String","from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z","isCompleted":false,"hasNebenkosten":false}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}