The ReferralContacts API from Alleva — 14 operation(s) for referralcontacts.
openapi: 3.2.0
info:
title: Alleva Rest Referral Contacts API
version: '1.0'
security:
- Bearer: []
tags:
- name: ReferralContacts
paths:
/referral-contacts:
post:
tags:
- ReferralContacts
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
get:
tags:
- ReferralContacts
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
/v{version}/referral-contacts:
post:
tags:
- ReferralContacts
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
get:
tags:
- ReferralContacts
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
/referral-contacts/{id}:
patch:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
get:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
/v{version}/referral-contacts/{id}:
patch:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
get:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralContact'
/referral-contacts/{contactId}/notes/{noteId}:
get:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
put:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
patch:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
/v{version}/referral-contacts/{contactId}/notes/{noteId}:
get:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
put:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
patch:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: noteId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
/referral-contacts/{contactId}/notes:
get:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
/v{version}/referral-contacts/{contactId}/notes:
get:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
post:
tags:
- ReferralContacts
parameters:
- name: contactId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralNoteCreationApiStruct'
responses:
'200':
description: Success
/referral-contacts/notes:
get:
tags:
- ReferralContacts
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/v{version}/referral-contacts/notes:
get:
tags:
- ReferralContacts
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
/referral-contacts/{id}/image:
post:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/referral-contacts/{id}/image:
post:
tags:
- ReferralContacts
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ReferralLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/referral-contacts/bulk:
post:
tags:
- ReferralContacts
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
/v{version}/referral-contacts/bulk:
post:
tags:
- ReferralContacts
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/ReferralContact'
components:
schemas:
JToken:
type: array
items:
$ref: '#/components/schemas/JToken'
ReferralContact:
type: object
properties:
id:
type: integer
format: int32
href:
type:
- string
- 'null'
readOnly: true
referralCompanyId:
type: integer
format: int32
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
dateOfBirth:
type:
- string
- 'null'
format: date-time
gender:
type:
- string
- 'null'
email:
type:
- string
- 'null'
category:
type:
- string
- 'null'
phone:
$ref: '#/components/schemas/Phone'
address:
$ref: '#/components/schemas/Address'
createdById:
type: integer
format: int32
writeOnly: true
externalId:
$ref: '#/components/schemas/ExternalData'
additionalProperties: false
ReferralLogoData:
type: object
properties:
fileName:
type:
- string
- 'null'
base64String:
type:
- string
- 'null'
additionalProperties: false
UpdateOperationResult:
enum:
- 0
- 1
- 2
- 3
type: integer
format: int32
ReferralNoteCreationApiStruct:
type: object
properties:
type:
type:
- string
- 'null'
level:
type:
- string
- 'null'
content:
type:
- string
- 'null'
noteDate:
type: string
format: date-time
authorId:
type: integer
format: int32
creatorId:
type: integer
format: int32
writeOnly: true
modifierId:
type: integer
format: int32
writeOnly: true
additionalProperties: false
ExternalData:
type: object
properties:
externalId:
type:
- string
- 'null'
externalIdType:
type:
- string
- 'null'
serviceIdentifier:
type:
- string
- 'null'
serviceId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
Address:
type: object
properties:
line1:
type:
- string
- 'null'
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
state:
type:
- string
- 'null'
stateAbbr:
type:
- string
- 'null'
country:
type:
- string
- 'null'
zipCode:
type:
- string
- 'null'
additionalProperties: false
Phone:
type: object
properties:
home:
type:
- string
- 'null'
office:
type:
- string
- 'null'
other:
type:
- string
- 'null'
number:
type:
- string
- 'null'
fax:
type:
- string
- 'null'
additionalProperties: false
UpdateResult:
type: object
properties:
operationResult:
$ref: '#/components/schemas/UpdateOperationResult'
success:
type: boolean
id:
type: integer
format: int64
messages:
type:
- array
- 'null'
items:
type: string
reason:
type:
- string
- 'null'
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then\
\ your token in the text input below.\n\nExample: Bearer 12345abcdef"
name: Authorization
in: header
servers:
- url: https://api.helloalleva.com
description: Base URL reconciled from apis.yml