Billiecart API

CreatePersonRequest

The following routes are available for this service:
POST	/persons


export class PostOperationUnTenanted<TResponse> implements IPost
{

    public constructor(init?: Partial<PostOperationUnTenanted<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 CreatePersonResponse
{
    public responseStatus?: ResponseStatus;
    public person?: Person;

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

export class CreatePersonRequest extends PostOperationUnTenanted<CreatePersonResponse>
{
    public userAccountId?: string;
    public timezone?: string;
    public phoneNumber?: string;

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

TypeScript CreatePersonRequest DTOs

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

HTTP + XML

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

POST /persons HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons">
  <PhoneNumber>String</PhoneNumber>
  <Timezone>String</Timezone>
  <UserAccountId>String</UserAccountId>
</CreatePersonRequest>

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

<CreatePersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Persons">
  <Person xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:DefaultOrganisationId>String</d2p1:DefaultOrganisationId>
    <d2p1:DisplayName>String</d2p1:DisplayName>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Name>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:LastName>String</d2p1:LastName>
    </d2p1:Name>
    <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    <d2p1:Timezone>String</d2p1:Timezone>
  </Person>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CreatePersonResponse>