| 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 | Yes | The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system |
| ReferenceTypeId | body | int? | No | External reference type id - can we fetched from /externalreferencestypes endpoint. ReferenceTypeId = 99 is other and should be used for all other types |
| ExternalData | body | string | Yes | The external data. Could be a Id or a JSON object or anything |
| CreatedBy | body | datetime | Yes | Will show who created the reference. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | |
| Id | form | Guid | No | |
| OwnerId | form | Guid | No | |
| ReferenceType | form | string | Yes | |
| ReferenceTypeId | form | int | No | |
| ExternalData | form | string | Yes | |
| Updated | form | DateTime | No | |
| Created | form | DateTime | No | |
| CreatedBy | form | string | Yes | |
| UpdatedBy | form | string | Yes | |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /references HTTP/1.1
Host: testapi.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","ReferenceType":"String","ReferenceTypeId":0,"ExternalData":"String","CreatedBy":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}