Skip to content
/
Get client memberships

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get communication preferences

Request

Returns communication preferences for a given client number

Security
BasicAuthCredentials
Query
clientnumberstringrequired
Examples:
clientnumber=0000000004
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/commprefs?clientnumber=string'

Responses

Client Communication Preferences

Bodyapplicaiton/json
allowboolean
Example: true
emailboolean
Example: true
cellVoiceboolean
Example: true
cellTextboolean
Example: true
homePhoneboolean
Example: true
workPhoneboolean
Example: true
mailboolean
Example: true
Response
applicaiton/json
{
  "allow": true,
  "email": true,
  "cellVoice": true,
  "cellText": true,
  "homePhone": true,
  "workPhone": true,
  "mail": true
}

Get client memberships

Request

Returns a list of EFT and non-eft memberships for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/clientmemberships?clientnumber=stringstri'

Responses

Get Client Memberships

Bodyapplicaiton/json
membershipsArray of objects(clientMembershipInfo)
Response
applicaiton/json
{
  "memberships": [
    { … }
  ]
}

Get client packages

Request

Returns a list of packages for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/clientpackages?clientnumber=stringstri'

Responses

Get Client Packages

Bodyapplicaiton/json
packagesArray of objects(clientPackageInfo)
Response
applicaiton/json
{
  "packages": [
    { … }
  ]
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations