Api latest docs

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

# Install the Python client library
$ pip install coreapi

sim-card

list

GET /api/sim-card/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card list -p cursor=...

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 = ["sim-card", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/sim-card/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Request Body

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

Parameter	Description
`serial_number` required
`current_device`
`phone_number` required	Must be in format of E164
`network_country_iso`
`country_iso`
`sim_operator`
`sim_operator_name`
`sim_serial_number`
`software_version`
`voice_mail_number`
`roaming`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card create -p serial_number=... -p current_device=... -p phone_number=... -p network_country_iso=... -p country_iso=... -p sim_operator=... -p sim_operator_name=... -p sim_serial_number=... -p software_version=... -p voice_mail_number=... -p roaming=...

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 = ["sim-card", "create"]
var params = {
    serial_number: ...,
    current_device: ...,
    phone_number: ...,
    network_country_iso: ...,
    country_iso: ...,
    sim_operator: ...,
    sim_operator_name: ...,
    sim_serial_number: ...,
    software_version: ...,
    voice_mail_number: ...,
    roaming: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "create"]
params = {
    "serial_number": ...,
    "current_device": ...,
    "phone_number": ...,
    "network_country_iso": ...,
    "country_iso": ...,
    "sim_operator": ...,
    "sim_operator_name": ...,
    "sim_serial_number": ...,
    "software_version": ...,
    "voice_mail_number": ...,
    "roaming": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/sim-card/{id}/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this Sim Card.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card read -p id=...

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 = ["sim-card", "read"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/sim-card/{id}/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this Sim Card.

Request Body

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

Parameter	Description
`serial_number` required
`current_device`
`phone_number` required	Must be in format of E164
`network_country_iso`
`country_iso`
`sim_operator`
`sim_operator_name`
`sim_serial_number`
`software_version`
`voice_mail_number`
`roaming`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card update -p id=... -p serial_number=... -p current_device=... -p phone_number=... -p network_country_iso=... -p country_iso=... -p sim_operator=... -p sim_operator_name=... -p sim_serial_number=... -p software_version=... -p voice_mail_number=... -p roaming=...

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 = ["sim-card", "update"]
var params = {
    id: ...,
    serial_number: ...,
    current_device: ...,
    phone_number: ...,
    network_country_iso: ...,
    country_iso: ...,
    sim_operator: ...,
    sim_operator_name: ...,
    sim_serial_number: ...,
    software_version: ...,
    voice_mail_number: ...,
    roaming: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "update"]
params = {
    "id": ...,
    "serial_number": ...,
    "current_device": ...,
    "phone_number": ...,
    "network_country_iso": ...,
    "country_iso": ...,
    "sim_operator": ...,
    "sim_operator_name": ...,
    "sim_serial_number": ...,
    "software_version": ...,
    "voice_mail_number": ...,
    "roaming": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/sim-card/{id}/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this Sim Card.

Request Body

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

Parameter	Description
`serial_number`
`current_device`
`phone_number`	Must be in format of E164
`network_country_iso`
`country_iso`
`sim_operator`
`sim_operator_name`
`sim_serial_number`
`software_version`
`voice_mail_number`
`roaming`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card partial_update -p id=... -p serial_number=... -p current_device=... -p phone_number=... -p network_country_iso=... -p country_iso=... -p sim_operator=... -p sim_operator_name=... -p sim_serial_number=... -p software_version=... -p voice_mail_number=... -p roaming=...

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 = ["sim-card", "partial_update"]
var params = {
    id: ...,
    serial_number: ...,
    current_device: ...,
    phone_number: ...,
    network_country_iso: ...,
    country_iso: ...,
    sim_operator: ...,
    sim_operator_name: ...,
    sim_serial_number: ...,
    software_version: ...,
    voice_mail_number: ...,
    roaming: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "partial_update"]
params = {
    "id": ...,
    "serial_number": ...,
    "current_device": ...,
    "phone_number": ...,
    "network_country_iso": ...,
    "country_iso": ...,
    "sim_operator": ...,
    "sim_operator_name": ...,
    "sim_serial_number": ...,
    "software_version": ...,
    "voice_mail_number": ...,
    "roaming": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/sim-card/{id}/

Display an individual :model:sms.SimCard.

Context

SimCard An instance of :model:sms.SimCard.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this Sim Card.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sim-card delete -p id=...

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 = ["sim-card", "delete"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sim-card", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

sms-in

list

GET /api/sms-in/

SmsIn

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in list -p cursor=...

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 = ["sms-in", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/sms-in/

SmsIn

Request Body

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

Parameter	Description
`sim_card` required
`from_number` required	The phone number on which the sms was originally sent out.
`text` required	The received message (sms).
`received_at` required	The datetime at which the message was received with the device.
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in create -p sim_card=... -p from_number=... -p text=... -p received_at=... -p updated_counter=... -p created_at=...

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 = ["sms-in", "create"]
var params = {
    sim_card: ...,
    from_number: ...,
    text: ...,
    received_at: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "create"]
params = {
    "sim_card": ...,
    "from_number": ...,
    "text": ...,
    "received_at": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/sms-in/{id}/

SmsIn

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms in.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in read -p id=...

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 = ["sms-in", "read"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/sms-in/{id}/

SmsIn

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms in.

Request Body

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

Parameter	Description
`sim_card` required
`from_number` required	The phone number on which the sms was originally sent out.
`text` required	The received message (sms).
`received_at` required	The datetime at which the message was received with the device.
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in update -p id=... -p sim_card=... -p from_number=... -p text=... -p received_at=... -p updated_counter=... -p created_at=...

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 = ["sms-in", "update"]
var params = {
    id: ...,
    sim_card: ...,
    from_number: ...,
    text: ...,
    received_at: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "update"]
params = {
    "id": ...,
    "sim_card": ...,
    "from_number": ...,
    "text": ...,
    "received_at": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/sms-in/{id}/

SmsIn

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms in.

Request Body

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

Parameter	Description
`sim_card`
`from_number`	The phone number on which the sms was originally sent out.
`text`	The received message (sms).
`received_at`	The datetime at which the message was received with the device.
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in partial_update -p id=... -p sim_card=... -p from_number=... -p text=... -p received_at=... -p updated_counter=... -p created_at=...

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 = ["sms-in", "partial_update"]
var params = {
    id: ...,
    sim_card: ...,
    from_number: ...,
    text: ...,
    received_at: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "partial_update"]
params = {
    "id": ...,
    "sim_card": ...,
    "from_number": ...,
    "text": ...,
    "received_at": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/sms-in/{id}/

SmsIn

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms in.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-in delete -p id=...

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 = ["sms-in", "delete"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-in", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

sms-out

list

GET /api/sms-out/

SmsOut

Query Parameters

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

Parameter	Description
`cursor`	The pagination cursor value.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out list -p cursor=...

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 = ["sms-out", "list"]
var params = {
    cursor: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "list"]
params = {
    "cursor": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/sms-out/

SmsOut

Request Body

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

Parameter	Description
`sim_card` required
`to_number` required	Receiver phone number
`text` required	Message
`sent_out_updated_at`
`sent_out_state`
`max_delivery_date`
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out create -p sim_card=... -p to_number=... -p text=... -p sent_out_updated_at=... -p sent_out_state=... -p max_delivery_date=... -p updated_counter=... -p created_at=...

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 = ["sms-out", "create"]
var params = {
    sim_card: ...,
    to_number: ...,
    text: ...,
    sent_out_updated_at: ...,
    sent_out_state: ...,
    max_delivery_date: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "create"]
params = {
    "sim_card": ...,
    "to_number": ...,
    "text": ...,
    "sent_out_updated_at": ...,
    "sent_out_state": ...,
    "max_delivery_date": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/sms-out/{id}/

SmsOut

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms out.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out read -p id=...

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 = ["sms-out", "read"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /api/sms-out/{id}/

SmsOut

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms out.

Request Body

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

Parameter	Description
`sim_card` required
`to_number` required	Receiver phone number
`text` required	Message
`sent_out_updated_at`
`sent_out_state`
`max_delivery_date`
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out update -p id=... -p sim_card=... -p to_number=... -p text=... -p sent_out_updated_at=... -p sent_out_state=... -p max_delivery_date=... -p updated_counter=... -p created_at=...

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 = ["sms-out", "update"]
var params = {
    id: ...,
    sim_card: ...,
    to_number: ...,
    text: ...,
    sent_out_updated_at: ...,
    sent_out_state: ...,
    max_delivery_date: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "update"]
params = {
    "id": ...,
    "sim_card": ...,
    "to_number": ...,
    "text": ...,
    "sent_out_updated_at": ...,
    "sent_out_state": ...,
    "max_delivery_date": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/sms-out/{id}/

SmsOut

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms out.

Request Body

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

Parameter	Description
`sim_card`
`to_number`	Receiver phone number
`text`	Message
`sent_out_updated_at`
`sent_out_state`
`max_delivery_date`
`updated_counter`
`created_at`

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out partial_update -p id=... -p sim_card=... -p to_number=... -p text=... -p sent_out_updated_at=... -p sent_out_state=... -p max_delivery_date=... -p updated_counter=... -p created_at=...

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 = ["sms-out", "partial_update"]
var params = {
    id: ...,
    sim_card: ...,
    to_number: ...,
    text: ...,
    sent_out_updated_at: ...,
    sent_out_state: ...,
    max_delivery_date: ...,
    updated_counter: ...,
    created_at: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "partial_update"]
params = {
    "id": ...,
    "sim_card": ...,
    "to_number": ...,
    "text": ...,
    "sent_out_updated_at": ...,
    "sent_out_state": ...,
    "max_delivery_date": ...,
    "updated_counter": ...,
    "created_at": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/sms-out/{id}/

SmsOut

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this sms out.

# Load the schema document
$ coreapi get /api/

# Interact with the API endpoint
$ coreapi action sms-out delete -p id=...

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 = ["sms-out", "delete"]
var params = {
    id: ...,
}
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("/api/")

# Interact with the API endpoint
action = ["sms-out", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)