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


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

// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateReference 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 Id of the reference */
    // @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
    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;

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

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

PUT /references/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <ExternalData>String</ExternalData>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <ReferenceType>String</ReferenceType>
</UpdateReference>

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

<ReferenceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <ExternalData>String</ExternalData>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <OwnerId>00000000-0000-0000-0000-000000000000</OwnerId>
  <ReferenceType>String</ReferenceType>
  <ReferenceTypeId>0</ReferenceTypeId>
  <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>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
</ReferenceQueryResponse>