SMS Pharma API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

public

appointments > list

GET /api/v1/public/appointments/

Public ViewSet for Appointment

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`patient__practitioner`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public appointments list -p page=... -p per_page=... -p patient__practitioner=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "appointments &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    patient__practitioner: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "appointments &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "patient__practitioner": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

appointments > create

POST /api/v1/public/appointments/

Public ViewSet for Appointment

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`patient` required
`next_appointment_date`
`hemoglobin_level` required
`ferritin_level`
`observations`

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public appointments create -p patient=... -p next_appointment_date=... -p hemoglobin_level=... -p ferritin_level=... -p observations=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "appointments &gt; create"]
var params = {
    patient: ...,
    next_appointment_date: ...,
    hemoglobin_level: ...,
    ferritin_level: ...,
    observations: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "appointments &gt; create"]
params = {
    "patient": ...,
    "next_appointment_date": ...,
    "hemoglobin_level": ...,
    "ferritin_level": ...,
    "observations": ...,
}
result = client.action(schema, action, params=params)

appointments > read

GET /api/v1/public/appointments/{id}/

Public ViewSet for Appointment

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`patient__practitioner`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public appointments read -p id=... -p patient__practitioner=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "appointments &gt; read"]
var params = {
    id: ...,
    patient__practitioner: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "appointments &gt; read"]
params = {
    "id": ...,
    "patient__practitioner": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

auth > access

POST /api/v1/public/auth/access/

ViewSet for Auth

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`password` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public auth access -p email=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "auth &gt; access"]
var params = {
    email: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "auth &gt; access"]
params = {
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

auth > refresh

POST /api/v1/public/auth/refresh/

ViewSet for Auth

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`refresh` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public auth refresh -p refresh=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "auth &gt; refresh"]
var params = {
    refresh: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "auth &gt; refresh"]
params = {
    "refresh": ...,
}
result = client.action(schema, action, params=params)

cities > list

GET /api/v1/public/cities/

Public viewset for City

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public cities list -p page=... -p per_page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "cities &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "cities &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

hospitals > list

GET /api/v1/public/hospitals/

Public viewset for Hospital

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`city`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public hospitals list -p page=... -p per_page=... -p city=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "hospitals &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    city: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "hospitals &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "city": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

hospitals > create

POST /api/v1/public/hospitals/

Public viewset for Hospital

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`city` required
`name` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public hospitals create -p city=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "hospitals &gt; create"]
var params = {
    city: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "hospitals &gt; create"]
params = {
    "city": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

password > confirm

POST /api/v1/public/password/confirm/

ViewSet for Passwords

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`user_id` required
`token` required
`password` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public password confirm -p user_id=... -p token=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "password &gt; confirm"]
var params = {
    user_id: ...,
    token: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "password &gt; confirm"]
params = {
    "user_id": ...,
    "token": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

password > reset

POST /api/v1/public/password/reset/

ViewSet for Passwords

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public password reset -p email=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "password &gt; reset"]
var params = {
    email: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "password &gt; reset"]
params = {
    "email": ...,
}
result = client.action(schema, action, params=params)

patients > list

GET /api/v1/public/patients/

Viewset for Patients

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`practitioner`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public patients list -p page=... -p per_page=... -p practitioner=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "patients &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    practitioner: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "patients &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "practitioner": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

patients > create

POST /api/v1/public/patients/

Viewset for Patients

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`practitioner` required
`first_name` required
`last_name_initial` required
`age` required
`gender` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public patients create -p practitioner=... -p first_name=... -p last_name_initial=... -p age=... -p gender=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "patients &gt; create"]
var params = {
    practitioner: ...,
    first_name: ...,
    last_name_initial: ...,
    age: ...,
    gender: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "patients &gt; create"]
params = {
    "practitioner": ...,
    "first_name": ...,
    "last_name_initial": ...,
    "age": ...,
    "gender": ...,
}
result = client.action(schema, action, params=params)

patients > read

GET /api/v1/public/patients/{id}/

Viewset for Patients

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`practitioner`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public patients read -p id=... -p practitioner=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "patients &gt; read"]
var params = {
    id: ...,
    practitioner: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "patients &gt; read"]
params = {
    "id": ...,
    "practitioner": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

practitioners > list

GET /api/v1/public/practitioners/

Public viewset for Practitioners

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`sales_representative`
`is_approved`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public practitioners list -p page=... -p per_page=... -p sales_representative=... -p is_approved=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "practitioners &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    sales_representative: ...,
    is_approved: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "practitioners &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "sales_representative": ...,
    "is_approved": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

practitioners > create

POST /api/v1/public/practitioners/

Public viewset for Practitioners

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`first_name` required
`father_last_name` required
`mother_last_name`
`email` required
`city` required
`hospital` required
`sales_representative` required
`specialty` required
`medical_license` required
`phone_number` required
`password` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public practitioners create -p first_name=... -p father_last_name=... -p mother_last_name=... -p email=... -p city=... -p hospital=... -p sales_representative=... -p specialty=... -p medical_license=... -p phone_number=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "practitioners &gt; create"]
var params = {
    first_name: ...,
    father_last_name: ...,
    mother_last_name: ...,
    email: ...,
    city: ...,
    hospital: ...,
    sales_representative: ...,
    specialty: ...,
    medical_license: ...,
    phone_number: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "practitioners &gt; create"]
params = {
    "first_name": ...,
    "father_last_name": ...,
    "mother_last_name": ...,
    "email": ...,
    "city": ...,
    "hospital": ...,
    "sales_representative": ...,
    "specialty": ...,
    "medical_license": ...,
    "phone_number": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

practitioners > verify

POST /api/v1/public/practitioners/verify/

Public viewset for Practitioners

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`user_id` required
`token` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public practitioners verify -p user_id=... -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "practitioners &gt; verify"]
var params = {
    user_id: ...,
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "practitioners &gt; verify"]
params = {
    "user_id": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

practitioners > read

GET /api/v1/public/practitioners/{id}/

Public viewset for Practitioners

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`sales_representative`
`is_approved`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public practitioners read -p id=... -p sales_representative=... -p is_approved=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "practitioners &gt; read"]
var params = {
    id: ...,
    sales_representative: ...,
    is_approved: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "practitioners &gt; read"]
params = {
    "id": ...,
    "sales_representative": ...,
    "is_approved": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

salesrepresentatives > list

GET /api/v1/public/salesrepresentatives/

Public viewset for Sales Representative with minimum data

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`city`
`specialty`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public salesrepresentatives list -p page=... -p per_page=... -p city=... -p specialty=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "salesrepresentatives &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    city: ...,
    specialty: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "salesrepresentatives &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "city": ...,
    "specialty": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

salesrepresentatives > create

POST /api/v1/public/salesrepresentatives/

Public viewset for Sales Representative with minimum data

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`phone_number` required
`first_name` required
`father_last_name` required
`city` required
`password` required
`specialty` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public salesrepresentatives create -p email=... -p phone_number=... -p first_name=... -p father_last_name=... -p city=... -p password=... -p specialty=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "salesrepresentatives &gt; create"]
var params = {
    email: ...,
    phone_number: ...,
    first_name: ...,
    father_last_name: ...,
    city: ...,
    password: ...,
    specialty: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "salesrepresentatives &gt; create"]
params = {
    "email": ...,
    "phone_number": ...,
    "first_name": ...,
    "father_last_name": ...,
    "city": ...,
    "password": ...,
    "specialty": ...,
}
result = client.action(schema, action, params=params)

salesrepresentatives > read

GET /api/v1/public/salesrepresentatives/{id}/

Public viewset for Sales Representative with minimum data

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`city`
`specialty`
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public salesrepresentatives read -p id=... -p city=... -p specialty=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "salesrepresentatives &gt; read"]
var params = {
    id: ...,
    city: ...,
    specialty: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "salesrepresentatives &gt; read"]
params = {
    "id": ...,
    "city": ...,
    "specialty": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

salesrepresentatives > update

PUT /api/v1/public/salesrepresentatives/{id}/

Public viewset for Sales Representative with minimum data

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`city`
`specialty`
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required
`phone_number` required
`first_name` required
`father_last_name` required
`city` required
`password` required
`specialty` required

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public salesrepresentatives update -p id=... -p email=... -p phone_number=... -p first_name=... -p father_last_name=... -p city=... -p password=... -p specialty=... -p city=... -p specialty=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "salesrepresentatives &gt; update"]
var params = {
    id: ...,
    email: ...,
    phone_number: ...,
    first_name: ...,
    father_last_name: ...,
    city: ...,
    password: ...,
    specialty: ...,
    city: ...,
    specialty: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "salesrepresentatives &gt; update"]
params = {
    "id": ...,
    "email": ...,
    "phone_number": ...,
    "first_name": ...,
    "father_last_name": ...,
    "city": ...,
    "password": ...,
    "specialty": ...,
    "city": ...,
    "specialty": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

salesrepresentatives > partial_update

PATCH /api/v1/public/salesrepresentatives/{id}/

Public viewset for Sales Representative with minimum data

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`city`
`specialty`
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email`
`phone_number`
`first_name`
`father_last_name`
`city`
`password`
`specialty`

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public salesrepresentatives partial_update -p id=... -p email=... -p phone_number=... -p first_name=... -p father_last_name=... -p city=... -p password=... -p specialty=... -p city=... -p specialty=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "salesrepresentatives &gt; partial_update"]
var params = {
    id: ...,
    email: ...,
    phone_number: ...,
    first_name: ...,
    father_last_name: ...,
    city: ...,
    password: ...,
    specialty: ...,
    city: ...,
    specialty: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "salesrepresentatives &gt; partial_update"]
params = {
    "id": ...,
    "email": ...,
    "phone_number": ...,
    "first_name": ...,
    "father_last_name": ...,
    "city": ...,
    "password": ...,
    "specialty": ...,
    "city": ...,
    "specialty": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

specialties > list

GET /api/v1/public/specialties/

Public viewset for Specialties

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public specialties list -p page=... -p per_page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "specialties &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "specialties &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

users > whoami

GET /api/v1/public/users/whoami/

ViewSet for User

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action public users whoami

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["public", "users &gt; whoami"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["public", "users &gt; whoami"]
result = client.action(schema, action)

sales

practitioners > list

GET /api/v1/sales/practitioners/

Sales representative viewset for Practitioner

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`per_page`	Number of results to return per page.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.dev.smsproyects.com.mx/docs/

# Interact with the API endpoint
$ coreapi action sales practitioners list -p page=... -p per_page=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sales", "practitioners &gt; list"]
var params = {
    page: ...,
    per_page: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.dev.smsproyects.com.mx/docs/")

# Interact with the API endpoint
action = ["sales", "practitioners &gt; list"]
params = {
    "page": ...,
    "per_page": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)