BokaMera.API.Host

UpdateReference

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, SuperAdminVisma

The following routes are available for this service:
PUT	/references/{Id}	Update a reference	Update a reference

"use strict";
export class ReferenceQueryResponse {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ExternalData?:string,Updated?:string,Created?:string,CreatedBy?:string,UpdatedBy?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id */
    CompanyId;
    /**
     * @type {string}
     * @description Id of the reference */
    Id;
    /**
     * @type {string}
     * @description Internal Id of the reference. Example could be the Booking Id */
    OwnerId;
    /**
     * @type {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 */
    ReferenceType;
    /**
     * @type {string}
     * @description The external data. Could be a Id or a JSON object or anything */
    ExternalData;
    /**
     * @type {string}
     * @description Will show when the reference was updated. */
    Updated;
    /**
     * @type {string}
     * @description Will show when the reference was created. */
    Created;
    /**
     * @type {string}
     * @description Will show who created the reference. */
    CreatedBy;
    /**
     * @type {string}
     * @description Will show who update the reference. */
    UpdatedBy;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class UpdateReference {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ExternalData?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description Id of the reference */
    Id;
    /**
     * @type {?string}
     * @description Internal Id of the reference. Example could be the Booking Id */
    OwnerId;
    /**
     * @type {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 */
    ReferenceType;
    /**
     * @type {string}
     * @description The external data. Could be a Id or a JSON object or anything */
    ExternalData;
}

JavaScript UpdateReference 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.

PUT /references/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	OwnerId: 00000000-0000-0000-0000-000000000000,
	ReferenceType: String,
	ExternalData: String
}

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
		}
	}
}