Billiecart API

GetPersonRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
GET	/persons/{Id}


export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

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

export class UserAccountName
{
    public firstName?: string;
    public lastName?: string;

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

export class Person implements IIdentifiableResource
{
    public name?: UserAccountName;
    public displayName?: string;
    public email?: string;
    public phoneNumber?: string;
    public timezone?: string;
    public defaultOrganisationId?: string;
    public id?: string;

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

export class GetPersonResponse
{
    public responseStatus?: ResponseStatus;
    public person?: Person;

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

export class GetPersonRequest extends GetOperationUnTenanted<GetPersonResponse>
{
    public id?: string;

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

TypeScript GetPersonRequest 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 /persons/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"person":{"name":{"firstName":"String","lastName":"String"},"displayName":"String","email":"String","phoneNumber":"String","timezone":"String","defaultOrganisationId":"String","id":"String"}}