COLONY REST API

Authentication

OAuth 2.0

Product API

Description:

Provides the ability to list and create Order

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/congrats/orders/

Description:

Provides the ability to retrieve Order

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "company": "int", 
    "id": "int", 
    "created_by": "int"
}

/congrats/orders/orderitem/<pk>/

GET OPTIONS

description model

Description:

Provides the ability to retrieve OrderLine

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "prize_type": "string", 
    "created_by": "int", 
    "qty": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "products": "list", 
    "date_created": "datetime", 
    "order": "int", 
    "id": "int"
}

Description:

Returns an annotated dict object of prizes in the system.

returns:

returns:	{ 'apps.congrats.prizes.backends.bluelabel.airtime.BlueLabelAirtime': { 'name': 'Prepaid Instant Airtime', 'prize_groups': [ System Message: ERROR/3 (`<string>`, line 9) Unexpected indentation. 'currency': 'ZAR', 'category': 'Airtime', 'name': 5.000000, 'available_count': 30, 'won_count': 7, System Message: WARNING/2 (`<string>`, line 14) Block quote ends without a blank line; unexpected unindent. ] System Message: WARNING/2 (`<string>`, line 15) Definition list ends without a blank line; unexpected unindent. }, 'apps.congrats.prizes.backends.bluelabel.electricity.BlueLabelElectricity': { 'name': 'Prepaid Electricity Token', 'prize_groups': [ System Message: ERROR/3 (`<string>`, line 20) Unexpected indentation. 'currency': 'ZAR', 'category': 'Electricity', 'name': 50.000000, 'available_count': 50, 'won_count': 30, System Message: WARNING/2 (`<string>`, line 25) Block quote ends without a blank line; unexpected unindent. ] System Message: WARNING/2 (`<string>`, line 26) Definition list ends without a blank line; unexpected unindent. }, System Message: WARNING/2 (`<string>`, line 27) Definition list ends without a blank line; unexpected unindent. }

{

'apps.congrats.prizes.backends.bluelabel.airtime.BlueLabelAirtime':

{

'name': 'Prepaid Instant Airtime', 'prize_groups': [

System Message: ERROR/3 (<string>, line 9)

Unexpected indentation.

'currency': 'ZAR', 'category': 'Airtime', 'name': 5.000000, 'available_count': 30, 'won_count': 7,

System Message: WARNING/2 (<string>, line 14)

Block quote ends without a blank line; unexpected unindent.

]

System Message: WARNING/2 (<string>, line 15)

Definition list ends without a blank line; unexpected unindent.

'apps.congrats.prizes.backends.bluelabel.electricity.BlueLabelElectricity':

{

'name': 'Prepaid Electricity Token', 'prize_groups': [

System Message: ERROR/3 (<string>, line 20)

Unexpected indentation.

'currency': 'ZAR', 'category': 'Electricity', 'name': 50.000000, 'available_count': 50, 'won_count': 30,

System Message: WARNING/2 (<string>, line 25)

Block quote ends without a blank line; unexpected unindent.

]

System Message: WARNING/2 (<string>, line 26)

Definition list ends without a blank line; unexpected unindent.

System Message: WARNING/2 (<string>, line 27)

Definition list ends without a blank line; unexpected unindent.

}

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/stats/

Description:

Allows for a summary of total prizes assigned to a closed campaign.

Model:

{}

Description:

Provides the ability to un-reserve on cpp

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/notify/

Description:

Lists all Electricity prizes.

Model:

{
    "token_extra_info": "string", 
    "updated_by": "int", 
    "token_customer_msg": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "token_vat_no": "string", 
    "token_receipt": "string", 
    "currency": "string", 
    "token_utility": "string", 
    "token_reference": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "token_customer_address": "string", 
    "token_units": "string", 
    "token_no": "string", 
    "token_amount": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "amount": "unknown", 
    "token_customer_name": "string", 
    "date_created": "datetime", 
    "token_tax": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/electricity/

/congrats/prizes/electricity/count/

GET OPTIONS

description model test

Description:

Model:

{
    "token_extra_info": "string", 
    "updated_by": "int", 
    "token_customer_msg": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "token_vat_no": "string", 
    "token_receipt": "string", 
    "currency": "string", 
    "token_utility": "string", 
    "token_reference": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "token_customer_address": "string", 
    "token_units": "string", 
    "token_no": "string", 
    "token_amount": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "amount": "unknown", 
    "token_customer_name": "string", 
    "date_created": "datetime", 
    "token_tax": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/electricity/count/

/congrats/prizes/electricity/assign/

POST OPTIONS

description model test

Description:

Assign electricity to a prize pool.

Model:

{
    "token_extra_info": "string", 
    "updated_by": "int", 
    "token_customer_msg": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "token_vat_no": "string", 
    "token_receipt": "string", 
    "currency": "string", 
    "token_utility": "string", 
    "token_reference": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "token_customer_address": "string", 
    "token_units": "string", 
    "token_no": "string", 
    "token_amount": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "amount": "unknown", 
    "token_customer_name": "string", 
    "date_created": "datetime", 
    "token_tax": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/electricity/assign/

/congrats/prizes/electricity/<pk>/

GET PUT PATCH OPTIONS

description model

Description:

Gets the details of a FNB eWallet prizes.

Model:

{
    "token_extra_info": "string", 
    "updated_by": "int", 
    "token_customer_msg": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "token_vat_no": "string", 
    "token_receipt": "string", 
    "currency": "string", 
    "token_utility": "string", 
    "token_reference": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "token_customer_address": "string", 
    "token_units": "string", 
    "token_no": "string", 
    "token_amount": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "amount": "unknown", 
    "token_customer_name": "string", 
    "date_created": "datetime", 
    "token_tax": "string"
}

Description:

Lists all Airtime prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/

/congrats/prizes/airtime/count/

GET OPTIONS

description model test

Description:

Lists all Airtime prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/count/

/congrats/prizes/airtime/group/

GET OPTIONS

description model test

Description:

Lists all Airtime prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/group/

/congrats/prizes/airtime/assign/

POST OPTIONS

description model test

Description:

Assign airtime to a prize pool.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/assign/

/congrats/prizes/airtime/focusgroup/reserve/

POST OPTIONS

description model test

Description:

Reserves Airtime for focus groups

{: {amount: 100, quantity: 5},

System Message: WARNING/2 (<string>, line 5)

Definition list ends without a blank line; unexpected unindent.

}

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/focusgroup/reserve/

/congrats/prizes/airtime/focusgroup/award/

POST OPTIONS

description model test

Description:

Awards Airtime for a completed focus groups {

System Message: ERROR/3 (<string>, line 3)

Unexpected indentation.

{amount: 100, quantity: 5},

System Message: WARNING/2 (<string>, line 4)

Block quote ends without a blank line; unexpected unindent.

}

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/focusgroup/award/

/congrats/prizes/airtime/award/

POST OPTIONS

description model test

Description:

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtime/award/

/congrats/prizes/airtime/<pk>/

GET PUT PATCH OPTIONS

description model

Description:

Gets the details of a FNB eWallet prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Description:

Lists all Data prizes.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/data/

Description:

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/data/count/

Description:

Assign Data to a prize pool.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/data/assign/

Description:

Gets the details of a Data prizes.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

/congrats/prizes/data/products/

GET OPTIONS

description model test

Description:

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/data/products/

Description:

Lists all Data prizes.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "selected": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtimedata/

/congrats/prizes/airtimedata/count/

GET OPTIONS

description model test

Description:

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "selected": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtimedata/count/

/congrats/prizes/airtimedata/assign/

POST OPTIONS

description model test

Description:

Assign Data to a prize pool.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "selected": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/airtimedata/assign/

/congrats/prizes/airtimedata/<pk>/

GET PUT PATCH OPTIONS

description model

Description:

Gets the details of a Data prizes.

Model:

{
    "mtn_product_code": "string", 
    "updated_by": "int", 
    "telkom_product_code": "string", 
    "date_updated": "datetime", 
    "company": "int", 
    "selected": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "cellc_product_code": "string", 
    "id": "int", 
    "pool": "int", 
    "vodacom_product_code": "string"
}

Description:

Lists all FNB eWallet prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/fnbewallet/

/congrats/prizes/fnbewallet/count/

GET OPTIONS

description model test

Description:

Lists all Airtime prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/fnbewallet/count/

/congrats/prizes/fnbewallet/assign/

POST OPTIONS

description model test

Description:

Assign electricity to a prize pool.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/fnbewallet/assign/

/congrats/prizes/fnbewallet/<pk>/

GET PUT PATCH OPTIONS

description model

Description:

Gets the details of a FNB eWallet prizes.

Model:

{
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "currency": "string", 
    "amount": "unknown", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int"
}

Description:

Provides the ability to list and create PhysicalPrizes

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/

/congrats/prizes/physical/count/

GET OPTIONS

description model test

Description:

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/count/

/congrats/prizes/physical/assign/

POST OPTIONS

description model test

Description:

Assign electricity to a prize pool.

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/assign/

/congrats/prizes/physical/assign/agent/

GET OPTIONS

description model test

Description:

Used for agents to fetch an unassigned physical prize and assign it to themselves. Assigns automatically to the logged in user.

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/assign/agent/

/congrats/prizes/physical/agent/prize/award/

GET POST OPTIONS

description model test

Description:

Used for agents to fetch prizes grouped by name i.e T-Shirts Large, T-Shirts Small Agents can also award prizes to entrants that are already in the system

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/agent/prize/award/

/congrats/prizes/physical/agent/prize/count/<pk>/

GET OPTIONS

description model

Description:

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

/congrats/prizes/physical/upload/

POST OPTIONS

description model test

Description:

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/physical/upload/

/congrats/prizes/physical/upload/bulk/

GET POST OPTIONS

description model test

Description:

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/physical/upload/bulk/

/congrats/prizes/physical/group/

GET OPTIONS

description model test

Description:

Lists all grouped physical prizes.

Model:

{
    "status": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "recipient_add_code": "string", 
    "company": "int", 
    "recipient_name": "string", 
    "recipient_add_2": "string", 
    "recipient_work_no": "string", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "delivery_backend": "string", 
    "name": "string", 
    "stock_item": "int", 
    "recipient_company": "string", 
    "recipient_cell_no": "string", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "waybill_no": "string", 
    "delivery_instructions": "string", 
    "recipient_add_3": "string", 
    "date_created": "datetime", 
    "recipient_add_1": "string", 
    "recipient_home_no": "string", 
    "fulfillment_agent": "int", 
    "recipient_add_4": "string"
}

Test:

You can test this API using the link below.

{
    "voucher_number": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/voucher/

/congrats/prizes/voucher/count/

GET OPTIONS

description model test

Description:

Lists all Voucher prizes.

Model:

{
    "voucher_number": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/voucher/count/

/congrats/prizes/voucher/assign/

POST OPTIONS

description model test

Description:

Assign voucher to a prize pool.

Model:

{
    "voucher_number": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/voucher/assign/

/congrats/prizes/voucher/<pk>/

GET PUT PATCH OPTIONS

description model

Description:

Gets the details of a Voucher prize.

Model:

{
    "voucher_number": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "name": "string"
}

/congrats/prizes/voucher/upload/bulk/

GET POST OPTIONS

description model test

Description:

Model:

{
    "voucher_number": "string", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "company": "int", 
    "date_allocated": "datetime", 
    "created_by": "int", 
    "date_created": "datetime", 
    "availability_status": "int", 
    "message": "int", 
    "id": "int", 
    "pool": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/voucher/upload/bulk/

Description:

Provides the ability to list and create Vaults for prize pools.

Model:

{
    "ignore_odds": "boolean", 
    "unique_winners": "boolean", 
    "updated_by": "int", 
    "campaign": "unknown", 
    "award_prizes_from": "datetime", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "award_prizes_to": "datetime", 
    "id": "int", 
    "created_by": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/vaults/

Description:

Provides the ability to get and put a Vault.

Model:

{
    "ignore_odds": "boolean", 
    "unique_winners": "boolean", 
    "updated_by": "int", 
    "campaign": "unknown", 
    "award_prizes_from": "datetime", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "award_prizes_to": "datetime", 
    "id": "int", 
    "created_by": "int"
}

Description:

Provides the ability to list and create PrizePools

Model:

{
    "category": "int", 
    "award_dates": "unknown", 
    "ussd_option": "boolean", 
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "total_count": "int", 
    "is_active": "boolean", 
    "prize_type": "string", 
    "created_by": "int", 
    "start_date": "datetime", 
    "avail_count": "int", 
    "vault": "int", 
    "date_created": "datetime", 
    "id": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/pools/

/congrats/prizes/pools/<pk>/

GET PUT PATCH DELETE OPTIONS

description model

Description:

Provides the ability to get and put a PrizePool

Model:

{
    "category": "int", 
    "award_dates": "unknown", 
    "ussd_option": "boolean", 
    "updated_by": "int", 
    "end_date": "datetime", 
    "title": "string", 
    "date_updated": "datetime", 
    "total_count": "int", 
    "is_active": "boolean", 
    "prize_type": "string", 
    "created_by": "int", 
    "start_date": "datetime", 
    "avail_count": "int", 
    "vault": "int", 
    "date_created": "datetime", 
    "id": "int"
}

Description:

Provides the ability to get a PrizePoolCategory

Model:

{
    "rght": "int", 
    "updated_by": "int", 
    "parent": "unknown", 
    "level": "int", 
    "date_updated": "datetime", 
    "created_by": "int", 
    "lft": "int", 
    "tree_id": "int", 
    "date_created": "datetime", 
    "id": "int", 
    "name": "string"
}

Test:

You can test this API using the link below.

/congrats/prizes/categories/

/congrats/prizes/categories/<pk>/

GET OPTIONS

description model

Description:

Provides the ability to list PrizePoolCategory

Model:

{
    "rght": "int", 
    "updated_by": "int", 
    "parent": "unknown", 
    "level": "int", 
    "date_updated": "datetime", 
    "created_by": "int", 
    "lft": "int", 
    "tree_id": "int", 
    "date_created": "datetime", 
    "id": "int", 
    "name": "string"
}

Description:

Provides the ability to see which prize types are available within the system.

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/types/

Description:

Provides the ability to list the number of winners for a prize

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/winners/

Description:

Allows the ability to list and create call logs

Model:

{
    "reason": "string", 
    "campaign": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "message": "int", 
    "id": "int", 
    "fulfillment_agent": "int"
}

Test:

You can test this API using the link below.

/congrats/prizes/logcall/

/congrats/prizes/downloadprizewinners/

POST OPTIONS

description model test

Description:

Provides the ability to launch a task to create a csv file within filebox with prize winners.

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/downloadprizewinners/

/congrats/prizes/downloadmanualprizewinners/

POST OPTIONS

description model test

Description:

Provides the ability to launch a task to create a csv file within filebox with prize winners.

Model:

{}

Test:

You can test this API using the link below.

/congrats/prizes/downloadmanualprizewinners/

Description:

Direct Prizes instantly gets awarded once a code is used, a direct prize is linked between a unique code batch and a prize pool, so that when a direct prize request is received for a valid code a prize will be given instantly from the assigned prize pool.

Model:

{
    "pool": "int", 
    "updated_by": "int", 
    "date_updated": "datetime", 
    "date_created": "datetime", 
    "id": "int", 
    "created_by": "int", 
    "batch": "int"
}

Test:

You can test this API using the link below.

GET POST OPTIONS

description model test

Description:

Provides the ability to see which prize types are available within the system.

Model:

{
    "campaign": "int", 
    "company": "int", 
    "prize_type": "int", 
    "prize_count": "int", 
    "currency": "string", 
    "amount": "int", 
    "date_created": "datetime", 
    "pool_category_name": "string", 
    "stat_type": "int", 
    "id": "int", 
    "day": "datetime"
}

Test:

You can test this API using the link below.

/congrats/prizestats/stats/