الواجهة البرمجيّة للتطبيق (API)

الأفراد: مفاهيم أساسيّة

يربط تطبيق تينه المستخدم بالفرد و يضيف تفاصيل إضافيّة، كالصورة الشخصيّة و تاريخ الميلاد، و غيرها، و هذه الصفحة سوف تُخصّص لشرح وظائف الفرد من العائلة.

عرض معلومات الفرد

لعرض معلومات الفرد من العائلة، يُمكن للمستخدم الحاليّ استدعاء هذه الوظيفة من خلال الرابط التاليّ، و لكن ينبغي أن يكون للمستخدم الحاليّ إمكانيّة للوصول (لضمان الخصوصيّة) 200، و الإّ فسيُرجع الخادم خطأ يدلّ على أنه لا يملك الصلاحيّة لاستخدام هذا المورد 403، كذلك يجب أن يكون الفرد موجوداً في قاعدة البيانات، و إلاّ سُيرجع الخادم الخطأ 404.

الطلب
GET 
{{teenah_api_url}}/members/{id}
  • {id} (مطلوب) اسم الشبكة الاجتماعيّة المُرادة.

ردّ الخادم سيكون أحد الردود التالية:

الردود
200 
{
    "id": "2",
    "gender": "male",
    "name": "حسام",
    "fullname": null,
    "nickname": null,
    "dob": "1989-01-14",
    "pob": null,
    "dod": null,
    "pod": null,
    "age": "0",
    "is_alive": "1",
    "photo": null,
    "location": null,
    "mobile": "96655******",
    "email": null,
    "home_phone": null,
    "work_phone": null,
    "marital_status": "single",
    "blood_type": null,
    "is_root": "0",
    "tribe_id": null,
    "created_at": "2014-02-02 17:56:34",
    "updated_at": "2014-02-02 17:56:34",
    "social_medias": [],
    "updates_count": "0",
    "jobs": [],
    "educations": []
}
  • {id} رقم أو معرّف المستخدم الحاليّ.
  • {gender} جنس الفرد سواءً ذكراً أو أنثى: male أوَ female.
  • {name} اسم الفرد المرتبط بالمستخدم.
  • {fullname} الاسم الكامل للفرد المرتبط بالمستخدم.
  • {nickname} رسالة الخطأ التي يتم استقبالها من الخادم.
  • {dob} تاريخ ميلاد الفرد بالصياغة YYYYY-mm-dd.
  • {pob} مكان الميلاد للفرد المرتبط بالمستخدم.
  • {dod} تاريخ وفاة (لا سمح الله) الفرد بالصياغة YYYYY-mm-dd.
  • {pod} مكان الوفاة (لا سمح الله) للفرد المرتبط بالمستخدم.
  • {age} عمر الفرد بدءً من الصفر.
  • {is_alive} حالة نبض الفرد، حيّ يرزق أو أنّه متوفّى، 1 أو 0.
  • {photo} رابط الصورة الشخصيّة للفرد (إن وُجدت).
  • {location} مكان تواجد الفرد إن أحبب مشاركته.
  • {mobile} رقم جوّال الفرد المرتبط بالمستخدم.
  • {email} بريد الفرد الإلكترونيّ.
  • {home_phone} رقم هاتف المنزل للفرد (إن وُجد و إن أحبب مشاركته).
  • {work_phone} رقم هاتف العمل للفرد (إن وُجد و إن أحبب مشاركته).
  • {marital_status} الحالة الاجتماعيّة للفرد، أعزب (single)، متزوّج (married)، أرملة (widow) للأنثى أو طليقة (divorced).
  • {blood_type} فصيلة الدم بشكل إختياري و بالرمز الإنجليزي.
  • {is_root} هل هذا الفرد هو جدّ العائلة، 1: نعم، 0: لا.
  • {tribe_id} رقم الفرد الذي يمثّل جدّ العائلة (إن وُجد).
  • {created_at} تاريخ و وقت إنشاء المستخدم.
  • {updated_at} تاريخ و وقت آخر تحديث لهذا السجل.
  • {social_medias} مصفوفة من الشبكات الاجتماعيّة التي سجّل فيها الفرد.
  • {updates_count} عدد التحديثات الغير مقروءة.
  • {jobs} مصفوفة تحوي الوظائف التي عملها الفرد.
  • {educations} مصفوفة تحوي المستويات التعليميّة التي أتمّها الفرد.
403 
{
    "message": "Not authorized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "Cannot find the resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

تحديث معلومات الفرد

في حال أراد المستخدم الحاليّ تحديث معلومات فرد من الأفراد؛ فإنّه يُمكنه ذلك من خلال إرسال طلب إلى الرابط التالي، علماً أن ردود الخادم ستكون إمّا 204 أو 400 أو 403 أو 404.

الطلب
PUT 
{{teenah_api_url}}/members/{id}
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد تحديث معلوماته.
  • {marital_status} (في الرؤوس) الحالة الاجتماعيّة للفرد، أعزب (single)، متزوّج (married)، أرملة (widow) للأنثى أو طليقة (divorced).
  • {dob} (في الرؤوس) تاريخ ميلاد الفرد بالصياغة YYYYY-mm-dd.
  • {pob} (في الرؤوس) مكان الميلاد للفرد المرتبط بالمستخدم.
  • {dod} (في الرؤوس) تاريخ وفاة (لا سمح الله) الفرد بالصياغة YYYYY-mm-dd.
  • {pod} (في الرؤوس) مكان الوفاة (لا سمح الله) للفرد المرتبط بالمستخدم.
  • {email} (مطلوب) (في الرؤوس) بريد الفرد الإلكترونيّ.

بعد إرسال الطلب، سيسعى الخادم لتحديث معلومات الفرد المطلوب، و سيردّ بأحد الردود التالية:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authorized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "Cannot find the resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

رفع الصورة الشخصيّة

يُمكن للمستخدم الحاليّ أن يغيّر الصورة الشخصيّة لأيٍ فردٍ يمكنه الوصول إليه، من خلال إرسال طلب PUT إلى الرابط التاليّ مضمّناً محتوى الملف (الصورة) بصياغة base64 و كذلك امتداد الملف:

الطلب
PUT 
{{teenah_api_url}}/members/{member_id}/photos
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد تحديث معلوماته.
  • {data} (مطلوب) (في الرؤوس) محتوى الملف المُراد رفعه إلى الخادم بصيغة base64.
  • {extension} (مطلوب) (في الرؤوس) امتداد الملف المُراد، بفترض أن يكون من الصياغات: jpg,png,jpeg,gif.

و ستكون ردود الخادم كالتاليّ:

الردود
200 
{
    "url": "https://teenahapp.s3.amazonaws.com/uWd1twxG3VuWd7FHY9EMv6vXoV2Y14ohesH4Olco.png"
}
  • {url} رابط الصورة الشخصيّة بعد رفعها إلى الخادم.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authorized to access this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إضافة علاقة

العلاقات في نظام تينه هي أحد المقوّمات الرئيسة له، بها يمكن للفرد أن يتّصل بفردٍ أو أفرادٍ آخرين، فالفرد يضيف أباً له و ابناً و أخاً و أختاً إن وُجدوا، و لكي يتسنّى للفرد عمل ذلك، ينبغي أن يرسل الفرد طلباً باستخدام فعل POST إلى الرابط التاليّ:

الطلب
POST 
{{teenah_api_url}}/members/{member_a}/relations
  • {member_a} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد تحديث معلوماته.
  • {is_alive} (مطلوب) (في الرؤوس) نبض الفرد ما إذا كان حيّاً:1 أو ميّتاً:0.
  • {name} (مطلوب) (في الرؤوس) الاسم الأوّل للفرد المُراد الربط بعلاقةٍ معه.
  • {relation} (مطلوب) (في الرؤوس) العلاقة التي يمثّلها الفرد الجديد بالنسبة للفرد member_a، ينبّغى أن تكون ضمن: father, stepfather, father-in-law, mother, stepmother, mother-in-law, sister, brother, son, stepson, daughter, stepdaughter, son-in-law, daughter-in-law, wife, husband.
  • {is_root} (مطلوب) (في الرؤوس) هل هذا الفرد هو جدّ العائلة، 1: نعم، 0: لا.
  • {mobile} (في الرؤوس) رقم جوّال الفرد المرتبط بالمستخدم.
  • {dob} (في الرؤوس) تاريخ ميلاد الفرد بالصياغة YYYYY-mm-dd.

ستكون ردود الخادم كالتّالي إمّا 201 أو 400 أو 403 أو 404، و سيُرسل الخادم دعوةً للفرد الجديد بالانضمام إلى تطبيق تينه على هيئة رسالة قصيرة (SMS) إذا تمّ الطلب بنجاح:

الردود
201 
{
    "message": "Relationship has been created successfully.",
    "a-to-b": "brother",
    "b-to-a": "brother",
    "member_a": "2",
    "member_b": 3
}
  • {message} رسالة إتمام العملية من الخادم.
  • {a-to-b} نوع العلاقة بين الفرد الأول و الفرد الثاني.
  • {b-to-a} نوع العلاقة بين الفرد الثانيّ و الأول (العلاقة العكسيّة).
  • {member_a} رقم أو معرّف الفرد الأوّل.
  • {member_b} رقم أو معرّف الفرد الثانيّ.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authorized to access this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The member that is chosen cannot be found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

حذف علاقة

إذا أرد المستخدم حذف علاقة بين فردين، فيمكنه ذلك من خلال إرسال طلب DELETE إلى الرابط التاليّ مضمّناً رقم الفرد الأول و رقم الفرد الثاني:

الطلب
DELETE 
{{teenah_api_url}}/members/{member_a}/relations
  • {member_a} (مطلوب) (في الرابط) رقم أو معرّف الفرد الأوّل.
  • {member_b} (مطلوب) (في الرؤوس) رقم أو معرّف الفرد الثاني.

بعد إرسال الطلب، سيكون ردّ الخادم أحد الردود التالية: 204 أو 400 أو 403 أو 404 و تفصيلها كالتّالي:

الطلب
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authorized to access this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The member that is chosen cannot be found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إضافة معلومات التعليم

في حال رغبة المستخدم الحاليّ إضافة معلومات التعليم لفردٍ ما و ربّما لفسه فإن ذلك ممكناً جدّاً من خلال إرسال طلب POST إلى الرابط التالي:

الطلب
POST 
{{teenah_api_url}}/members/{id}/educations
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {degree} (مطلوب) (في الرؤوس) الدرجة العلمية، لابدّ أن تكون أحد التالي: بدون none, إبتدائي elementary, متوسّط intermediate, ثانوي secondary, دبلوم diploma, ليسانس licentiate, بكالوريوس bachelor, ماجستير master, دكتوراه doctorate.
  • {start_year} (في الرؤوس) سنة البدء في هذا المستوى التعليمي.
  • {finish_year} (في الرؤوس) سنة الانتهاء من هذا المستوى التعليمي إن وُجدت.
  • {status} (في الرؤوس) حالة الدراسة حاليّاً، و هي أحد التالي: جارية ongoing، منهية finished، معلّقة pending، متروكة dropped.
  • {major} (في الرؤوس) التخصّص في هذا المستوى التعليمي إن وُجد.

و ردّ الخادم سيكون أحد الردود التالية: 201 أو 400 أو 403:

الردود
201 
{
    "member_id": "2",
    "degree": "bachelor",
    "major_id": "1",
    "start_year": "2006",
    "finish_year": "2011",
    "status": "finished",
    "updated_at": "2014-02-06 21:58:34",
    "created_at": "2014-02-06 21:58:34",
    "id": 1
}
  • {member_id} رقم أو معرّف الفرد.
  • {degree} الدرجة العلمية.
  • {major_id} رقم التخصّص.
  • {start_year} سنة البدء في الدراسة.
  • {finish_year} سنة الانتهاء من الدراسة.
  • {status} حالة الدراسة حاليّاً.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {id} رقم أو معرّف المستوى التعليمي المُضاف.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

عرض معلومات التعليم

إذا أراد المستخدم الحاليّ عرض معلومات التعليم بتفصيلها لفردٍ ما يُمكنه الوصول إليه، فإن ذلك ممكناً من خلال إرسال طلب GET إلى الرابط التالي:

الطلب
GET 
{{teenah_api_url}}/members/{id}/educations
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.

و ردّ الخادم سيكون أحد الردود التالية، إمّا أن يكون مصفوفة من المستويات التعليميّة بالكود 200 أو 403 أو 404:

الردود
200 
[
    {
        "id": "1",
        "member_id": "2",
        "degree": "bachelor",
        "major_id": "1",
        "start_year": "2006",
        "finish_year": "2011",
        "status": "finished",
        "created_at": "2014-02-06 21:58:34",
        "updated_at": "2014-02-06 21:58:34",
        "major": {
            "id": "1",
            "name": "Computer Science",
            "created_at": "0000-00-00 00:00:00",
            "updated_at": "0000-00-00 00:00:00"
        }
    }
]
  • {id} رقم أو معرّف المستوى التعليمي المُضاف.
  • {member_id} رقم أو معرّف الفرد.
  • {degree} الدرجة العلمية.
  • {major_id} رقم التخصّص.
  • {start_year} سنة البدء في الدراسة.
  • {finish_year} سنة الانتهاء من الدراسة.
  • {status} حالة الدراسة حاليّاً.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {major} التخصّص و تفاصيله كمصفوفة فرعيّة.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The chosen member has not been found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

تحديث معلومات التعليم

إذا أراد المستخدم تحديث معلومات التعليم لفرد ما، فإنّ ذلك ممكناً من خلال إرسال طلب PUT إلى الرابط التاليّ مضمّناً رقم أو معرّف الفرد و كذلك رقم أو معرّف المستوى التعليمي التابع له:

الطلب
PUT 
{{teenah_api_url}}/members/{member_id}/educations/{education_id}
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {education_id} (مطلوب) (في الرابط) رقم أو معرّف المستوى التعليميّ التابع للفرد.
  • {degree} (مطلوب) (في الرؤوس) الدرجة العلمية، لابدّ أن تكون أحد التالي: بدون none, إبتدائي elementary, متوسّط intermediate, ثانوي secondary, دبلوم diploma, ليسانس licentiate, بكالوريوس bachelor, ماجستير master, دكتوراه doctorate.
  • {start_year} (في الرؤوس) سنة البدء في هذا المستوى التعليمي.
  • {finish_year} (في الرؤوس) سنة الانتهاء من هذا المستوى التعليمي إن وُجدت.
  • {status} (في الرؤوس) حالة الدراسة حاليّاً، و هي أحد التالي: جارية ongoing، منهية finished، معلّقة pending، متروكة dropped.
  • {major} (في الرؤوس) التخصّص في هذا المستوى التعليمي إن وُجد.

و ردّ الخادم سيكون أحد الردود التالية: إمّا 200 أو 400 أو 403:

الردود
200 
{
    "id": "1",
    "member_id": "2",
    "degree": "bachelor",
    "major_id": "1",
    "start_year": "2006",
    "finish_year": "2011",
    "status": "finished",
    "created_at": "2014-02-06 21:58:34",
    "updated_at": "2014-02-06 21:58:34",
    "major": {
        "id": "1",
        "name": "Computer Science",
        "created_at": "0000-00-00 00:00:00",
        "updated_at": "0000-00-00 00:00:00"
    }
}
  • {id} رقم أو معرّف المستوى التعليمي المُضاف.
  • {member_id} رقم أو معرّف الفرد.
  • {degree} الدرجة العلمية.
  • {major_id} رقم التخصّص.
  • {start_year} سنة البدء في الدراسة.
  • {finish_year} سنة الانتهاء من الدراسة.
  • {status} حالة الدراسة حاليّاً.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {major} التخصّص و تفاصيله كمصفوفة فرعيّة.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

حذف معلومات التعليم

كما يُمكن للمستخدم حذف مستوى تعليميّ من فردٍ من الأفراد الذين يمكنه الوصول إليهم؛ و ذلك من خلال إرسال طلب DELETE إلى الرابط التاليّ:

الطلب
DELETE 
{{teenah_api_url}}/members/{member_id}/educations/{education_id}
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {education_id} (مطلوب) (في الرابط) رقم أو معرّف المستوى التعليميّ التابع للفرد.

بعد إرسال الطلب إلى الخادم سيكون ردّ الخادم أحد التاليّ: إمّا 204 أو 400 أو 403:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إضافة وظيفة

يُمكن للمستخدم الحاليّ إضافة وظيفة لفردٍ ما يستطيع الوصول إليه من خلال إرسال طلب POST إلى الرابط التاليّ:

الطلب
POST 
{{teenah_api_url}}/members/{id}/jobs
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {title} (مطلوب) (في الرؤوس) المسمّى الوظيفي للفرد.
  • {start_year} (في الرؤوس) سنة البدء في هذه الوظيفة.
  • {finish_year} (في الرؤوس) سنة الانتهاء من هذه الوظيفة إن وُجدت.
  • {status} (في الرؤوس) حالة الوظيفة حاليّاً، و هي أحد التالي: جارية ongoing، منهية finished، معلّقة pending، متروكة dropped.
  • {company} (في الرؤوس) الشركة أو المؤسسة التي تتبع لها هذه الوظيفة إن وُجد.

و بالطّبع ردّ الخادم سيكون أحد الردود التالية: 201 أو 400 أو 403 أو 404:

الردود
201 
{
    "id": "1",
    "member_id": "2",
    "title": "Software Engineer",
    "company_id": "1",
    "start_year": "2006",
    "finish_year": null,
    "status": "ongoing",
    "created_at": "2014-02-07 16:25:51",
    "updated_at": "2014-02-07 16:25:51",
    "company": {
        "id": "1",
        "name": "SomeCompany",
        "category": null,
        "link": null,
        "logo": null,
        "created_at": "2014-02-07 16:25:51",
        "updated_at": "2014-02-07 16:25:51"
    }
}
  • {id} رقم أو معرّف الوظيفة المُضافة.
  • {member_id} رقم أو معرّف الفرد.
  • {title} المسمّى الوظيفي للفرد.
  • {company_id} رقم الشركة.
  • {start_year} سنة البدء في الوظيفة.
  • {finish_year} سنة الانتهاء من الوظيفة.
  • {status} حالة الوظيفة حاليّاً.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {company} الشركة و تفاصيلها كمصفوفة فرعيّة.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The chosen member has not been found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

عرض وظائف الفرد

إذا أراد المستخدم الحالي عرض الوظائف الخاصّة بفردٍ ما يمكنه الوصول إليه، فإن ذلك ممكناً جدّاً من خلال إرسال طلب GET إلى الرابط التالي:

الطلب
GET 
{{teenah_api_url}}/members/{id}/jobs
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.

و ردّ الخادم سيكون أحد الردود التالية: إمّا مصفوفة من الوظائف 200 أو 403 أو 404:

الردود
200 
[
    {
        "id": "1",
        "member_id": "2",
        "title": "Software Engineer",
        "company_id": "1",
        "start_year": "2006",
        "finish_year": null,
        "status": "ongoing",
        "created_at": "2014-02-07 16:25:51",
        "updated_at": "2014-02-07 16:25:51",
        "company": {
            "id": "1",
            "name": "SomeCompany",
            "category": null,
            "link": null,
            "logo": null,
            "created_at": "2014-02-07 16:25:51",
            "updated_at": "2014-02-07 16:25:51"
        }
    }
]
  • {id} رقم أو معرّف الوظيفة المُضافة.
  • {member_id} رقم أو معرّف الفرد.
  • {title} المسمّى الوظيفي للفرد.
  • {company_id} رقم الشركة.
  • {start_year} سنة البدء في الوظيفة.
  • {finish_year} سنة الانتهاء من الوظيفة.
  • {status} حالة الوظيفة حاليّاً.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {company} الشركة و تفاصيلها كمصفوفة فرعيّة.
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The chosen member has not been found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

تحديث وظيفة

إذا أراد المستخدم الحاليّ تحديث وظيفة لفردٍ ما يستطيع الوصول إليه، فإن ذلك يعتبر ممكناً من خلال إرسال طلب PUT إلى الرابط التالي:

الطلب
PUT 
{{teenah_api_url}}/members/{member_id}/jobs/{job_id}
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {job_id} (مطلوب) (في الرابط) رقم أو معرّف الوظيفة للفرد.
  • {title} (مطلوب) (في الرؤوس) المسمّى الوظيفي للفرد.
  • {start_year} (في الرؤوس) سنة البدء في هذه الوظيفة.
  • {finish_year} (في الرؤوس) سنة الانتهاء من هذه الوظيفة إن وُجدت.
  • {status} (في الرؤوس) حالة الوظيفة حاليّاً، و هي أحد التالي: جارية ongoing، منهية finished، معلّقة pending، متروكة dropped.
  • {company} (في الرؤوس) الشركة أو المؤسسة التي تتبع لها هذه الوظيفة إن وُجد.

و ردّ الخادم سيكون أحد الردود التالية: 200 أو 400 أو 403 أو 404:

الردود
200 
{
    "id": "1",
    "member_id": "2",
    "title": "Software Developer",
    "company_id": "1",
    "start_year": null,
    "finish_year": null,
    "status": "ongoing",
    "created_at": "2014-02-07 16:25:51",
    "updated_at": "2014-02-07 21:46:43",
    "company": {
        "id": "1",
        "name": "SomeCompany",
        "category": null,
        "link": null,
        "logo": null,
        "created_at": "2014-02-07 16:25:51",
        "updated_at": "2014-02-07 16:25:51"
    }
}
  • {id} رقم أو معرّف الوظيفة المُضافة.
  • {member_id} رقم أو معرّف الفرد.
  • {title} المسمّى الوظيفي للفرد.
  • {company_id} رقم الشركة.
  • {start_year} سنة البدء في الوظيفة.
  • {finish_year} سنة الانتهاء من الوظيفة.
  • {status} حالة الوظيفة حاليّاً.
  • {created_at} وقت و تاريخ إنشاء السجل.
  • {updated_at} آخر وقت و تاريخ لتحديث السجل.
  • {company} الشركة و تفاصيلها كمصفوفة فرعيّة.
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "The chosen member has not been found."
}
  • {message} رسالة الخطأ العائدة من الخادم.

حذف وظيفة

يُمكن للمستخدم الحاليّ حذف وظيفة لفردٍ ما يمكنه الوصول إليه، و ذلك من خلال إرسال طلب DELETE إلى الرابط التالي:

الطلب
DELETE 
{{teenah_api_url}}/members/{member_id}/jobs/{job_id}
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المطلوب.
  • {job_id} (مطلوب) (في الرابط) رقم أو معرّف الوظيفة للفرد.

و ردّ الخادم سيكون أحد الردود التالية: 204 أو 400 أو 403:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إعجابٌ (تقديرٌ) بفرد

يُمكن للمستخدم الحاليّ إبداء إعجابه (أو تقدريه) لفردٍ من الأفراد و ذلك من خلال إرسال طلب GET إلى الرابط التالي:

الطلب
GET 
{{teenah_api_url}}/members/{id}/like
  • {id} (مطلوب) رقم أو معرّف الفرد المُراد.

و ردّ الخادم سيكون أحد الردود التالية: إمّا 204 أو 403:

الردود
204
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

التعليق على فرد

يُمكن للمستخدم الحاليّ أن يعلّق على فردٍ من الأفراد الذين يمكنه الوصول إليهم من خلال إرسال طلب POST إلى الرابط التالي:

الطلب
POST 
{{teenah_api_url}}/members/{id}/comment
  • {id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد.
  • {comment} (مطلوب) (في الرؤوس) نص التعليق.

و ردّ الخادم سيكون أحد الردود التالية: إمّا 204 أو 400 أو 403:

الردود
204
400 
{
    "message": "Bad request."
}
  • {message} رسالة الخطأ العائدة من الخادم.
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

إعجابٌ بتعليقٍ لفرد

كما يُمكن للمستخدم الحاليّ الإعجاب بتعليق فردٍ من الأفراد على فردٍ ما من خلال إرسال طلب GET إلى الرابط التالي:

الطلب
GET 
{{teenah_api_url}}/members/{member_id}/comments/{comment_id}/like
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد.
  • {comment_id} (مطلوب) (في الرابط) رقم أو معرّف التعليق.

و ردّ الخادم سيكون أحد الردود التالية: إمّا 204 أو 403:

الردود
204
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.

عرض الشبكات الاجتماعيّة للفرد

يُمكن للمستخدم الحاليّ عرض الشبكات الاجتماعيّة الخاصّة بفردٍ من الأفراد ممّن يُمكنه الوصول إليهم من خلال إرسال طلب GET إلى الرابط التالي:

الطلب
GET 
{{teenah_api_url}}/members/{member_id}/socialmedias
  • {member_id} (مطلوب) (في الرابط) رقم أو معرّف الفرد المُراد.

و ردّ الخادم سيكون أحد الردود التالية: إمّا مصفوفة من الشبكات الاجتماعيّة 200 أو 403 أو 404:

الردود
200 
[
    {
        "id": "1",
        "social_media": "Twitter",
        "account": "hossamzee",
        "url": "https://twitter.com/hossamzee",
        "created_at": "2014-02-07 22:29:42",
        "updated_at": "2014-02-07 22:29:42"
    }
]
403 
{
    "message": "Not authroized to use this resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
404 
{
    "message": "Cannot find the resource."
}
  • {message} رسالة الخطأ العائدة من الخادم.
الشروع في الاستخدام المستخدمون الأفراد الدوائر المناسبات الوسائط المتعدّدة الرسائل الشبكات الاجتماعيّة الوكلاء الإكمال التلقائي