BokaMera.API.Host

AddReference

The following routes are available for this service:
POST	/references	Add reference	Add reference


export class ReferenceQueryResponse
{
    public CompanyId: string;
    public Id: string;
    public OwnerId: string;
    public ReferenceType: string;
    public ReferenceTypeId: number;
    public ExternalData: string;
    public Updated: string;
    public Created: string;
    public CreatedBy: string;
    public UpdatedBy: string;
    public ResponseStatus: ResponseStatus;

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

export class AddReference implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Internal Id of the reference. Example could be the Booking Id */
    // @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    public OwnerId: string;

    /** @description The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system */
    // @ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
    public ReferenceType: string;

    /** @description External reference type id - can we fetched from /externalreferencestypes endpoint */
    // @ApiMember(Description="External reference type id - can we fetched from /externalreferencestypes endpoint")
    public ReferenceTypeId?: number;

    /** @description The external data. Could be a Id or a JSON object or anything */
    // @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
    public ExternalData: string;

    /** @description Will show who created the reference. */
    // @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    public CreatedBy: string;

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

TypeScript AddReference 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.

POST /references HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ReferenceType: String,
	ReferenceTypeId: 0,
	ExternalData: String,
	CreatedBy: String
}

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

{
	ReferenceType: String,
	ReferenceTypeId: 0,
	ExternalData: String,
	CreatedBy: String,
	UpdatedBy: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}