BokaMera.API.Host

<back to all web services

DeleteReferenceWithReferenceType

The following routes are available for this service:
DELETE/references/{companyid}/{ownerid}/{referencetype}Delete a reference with the reference typeDelete a reference

export class ReferenceQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description Id of the reference */
    // @ApiMember(Description="Id of the reference")
    public Id: 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 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 when the reference was updated. */
    // @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
    public Updated: string;

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

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

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

    public ResponseStatus: ResponseStatus;

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

export class DeleteReferenceWithReferenceType
{
    /** @description The company id */
    // @ApiMember(Description="The company id", IsRequired=true, ParameterType="path")
    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", ParameterType="path")
    public OwnerId: string;

    /** @description Reference type of the reference */
    // @ApiMember(Description="Reference type of the reference", ParameterType="path")
    public ReferenceType: string;

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

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

DELETE /references/{companyid}/{ownerid}/{referencetype} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReferenceType: String,
	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
		}
	}
}