POST | /references | Add reference | Add reference |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
OwnerId | body | Guid | No | Internal Id of the reference. Example could be the Booking Id |
ReferenceType | body | string | No | The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system |
ExternalData | body | string | No | The external data. Could be a Id or a JSON object or anything |
CreatedBy | body | datetime | No | Will show who created the reference. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id |
Id | form | Guid | No | Id of the reference |
OwnerId | form | Guid | No | Internal Id of the reference. Example could be the Booking Id |
ReferenceType | form | string | No | The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system |
ExternalData | form | string | No | The external data. Could be a Id or a JSON object or anything |
Updated | form | datetime | No | Will show when the reference was updated. |
Created | form | datetime | No | Will show when the reference was created. |
CreatedBy | form | datetime | No | Will show who created the reference. |
UpdatedBy | form | datetime | No | Will show who update the reference. |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ReferenceType: String,
ExternalData: String,
CreatedBy: 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 } } }