Smartcvapi

• swap_horiz /cv-upload/api/<int:pk>/

  GET PUT PATCH DELETE OPTIONS

  Retrieve Update Destroy C V Upload Request

  Copy to clipboard Copy Link

  Open Link  

  ---

  • Description
  • Authentication
  • Permissions

  No description provided by developer

  Action is allowed if any of these auth types is provided(logic OR)

  Type	Description
  OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
  SessionAuthentication	Use Django's session framework for authentication.

  Action is allowed when all of conditions are satisfied(logic AND)

  Type	Description
  AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

  
  

  Request Fields:

  {

  • job_title: CharField, Required
  • company: CharField, Required
  • location: CharField, Required
  • job_description: CharField, Required
  • full_name: CharField,
  • phone_number: CharField,
  • email: EmailField, Required
  • uploaded_cv: FileField, Required
  • cover_letter_creativity: IntegerField, Help Text
  • processing_started_at: DateTimeField,
  • processing_completed_at: DateTimeField,
  • failure_reason: CharField,
  • optimized_cv: FileField,
  • cover_letter: FileField,
  • payment_confirmed: BooleanField, Help Text
  • payment_reference: CharField, Help Text
  • payment_amount: FloatField, Help Text

  }

  
  

  Response Fields:

  {

  • id: IntegerField,
  • job_title: CharField,
  • company: CharField,
  • location: CharField,
  • job_description: CharField,
  • full_name: CharField,
  • phone_number: CharField,
  • email: EmailField,
  • uploaded_cv: FileField,
  • cover_letter_creativity: IntegerField, Help Text
  • status: CharField,
  • processing_started_at: DateTimeField,
  • processing_completed_at: DateTimeField,
  • failure_reason: CharField,
  • optimized_cv: FileField,
  • cover_letter: FileField,
  • payment_confirmed: BooleanField, Help Text
  • payment_reference: CharField, Help Text
  • payment_amount: FloatField, Help Text
  • created_at: DateTimeField,
  • updated_at: DateTimeField

  }

• swap_horiz /cv-upload/api/<int:upload_id>/initiate-payment/

  OPTIONS POST

  Initiate Payment

  Copy to clipboard Copy Link

  Open Link  

  ---

  • Description
  • Authentication
  • Permissions

  Initiate payment for an existing CV upload request

  Action is allowed if any of these auth types is provided(logic OR)

  Type	Description
  OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
  SessionAuthentication	Use Django's session framework for authentication.

  Action is allowed when all of conditions are satisfied(logic AND)

  Type	Description
  AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

  
  

  Request Fields:

  No input data specified

  
  

  Response Fields:

  No output data specified

• swap_horiz /cv-upload/api/<int:upload_id>/verify-payment/

  OPTIONS POST

  Verify Payment

  Copy to clipboard Copy Link

  Open Link  

  ---

  • Description
  • Authentication
  • Permissions

  Verify payment for a CV upload request

  Action is allowed if any of these auth types is provided(logic OR)

  Type	Description
  OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
  SessionAuthentication	Use Django's session framework for authentication.

  Action is allowed when all of conditions are satisfied(logic AND)

  Type	Description
  AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

  
  

  Request Fields:

  No input data specified

  
  

  Response Fields:

  No output data specified

• swap_horiz /cv-upload/api/

  GET POST OPTIONS

  List Create C V Upload Requests

  Copy to clipboard Copy Link

  Open Link  

  ---

  • Description
  • Authentication
  • Permissions
  • Filters

  No description provided by developer

  Action is allowed if any of these auth types is provided(logic OR)

  Type	Description
  OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
  SessionAuthentication	Use Django's session framework for authentication.

  Action is allowed when all of conditions are satisfied(logic AND)

  Type	Description
  AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

  Param name	Description
  MyDjangoFilterBackend	None

  
  

  Request Fields:

  {

  • job_title: CharField, Required
  • company: CharField, Required
  • location: CharField, Required
  • job_description: CharField, Required
  • full_name: CharField,
  • phone_number: CharField,
  • email: EmailField, Required
  • uploaded_cv: FileField, Required
  • cover_letter_creativity: IntegerField, Help Text
  • processing_started_at: DateTimeField,
  • processing_completed_at: DateTimeField,
  • failure_reason: CharField,
  • optimized_cv: FileField,
  • cover_letter: FileField,
  • payment_confirmed: BooleanField, Help Text
  • payment_reference: CharField, Help Text
  • payment_amount: FloatField, Help Text

  }

  
  

  Response Fields:

  {

  • id: IntegerField,
  • job_title: CharField,
  • company: CharField,
  • location: CharField,
  • job_description: CharField,
  • full_name: CharField,
  • phone_number: CharField,
  • email: EmailField,
  • uploaded_cv: FileField,
  • cover_letter_creativity: IntegerField, Help Text
  • status: CharField,
  • processing_started_at: DateTimeField,
  • processing_completed_at: DateTimeField,
  • failure_reason: CharField,
  • optimized_cv: FileField,
  • cover_letter: FileField,
  • payment_confirmed: BooleanField, Help Text
  • payment_reference: CharField, Help Text
  • payment_amount: FloatField, Help Text
  • created_at: DateTimeField,
  • updated_at: DateTimeField

  }

• swap_horiz /api/v1/exports/

  GET OPTIONS

  List Exports

  Copy to clipboard Copy Link

  Open Link  

  ---

  • Description
  • Authentication
  • Permissions
  • Filters

  No description provided by developer

  Action is allowed if any of these auth types is provided(logic OR)

  Type	Description
  OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
  SessionAuthentication	Use Django's session framework for authentication.

  Action is allowed when all of conditions are satisfied(logic AND)

  Type	Description
  IsAuthenticated	Allows access only to authenticated users.

  Param name	Description
  created	Created
  modified	Modified
  name	Name
  custom_report_name	Custom Report Name
  title	Title
  description	Description
  status	Status
  rows_count	Rows Count
  exported_rows_count	Exported Rows Count
  args	Args
  type	Type
  start_time	Start Time
  end_time	End Time
  user	User
  errors	Errors
  is_custom	Is Custom
  start_date	Start Date
  end_date	End Date
  list_size	List Size

  
  

  Request Fields:

  No input data specified

  
  

  Response Fields:

  {

  • id: IntegerField,
  • status_display: CharField,
  • completed_percentage: ReadOnlyField,
  • rows_count: MyCustomSerializerField,
  • exported_rows_count: MyCustomSerializerField,
  • duration: ReadOnlyField,
  • created: DateTimeField,
  • modified: DateTimeField,
  • name: CharField,
  • custom_report_name: CharField,
  • title: CharField,
  • description: CharField,
  • status: ChoiceField,
    Choices

    Value	Meaning
    Q	Queued
    E	Exporting...
    P	Preparing Download...
    F	Failed
    D	Click To Download

  • args: CharField,
  • type: ChoiceField,
    Choices

    Value	Meaning
    C	CSV
    P	PDF

  • file: FileField,
  • start_time: DateTimeField,
  • end_time: DateTimeField,
  • errors: CharField,
  • is_custom: BooleanField,
  • start_date: DateField,
  • end_date: DateField,
  • list_size: ChoiceField,
    Choices

    Value	Meaning
    5	5
    10	10
    20	20
    50	50
    100	100
    300	300
    500	500
    800	800
    1000	1000
    10000	10000

  • user: PrimaryKeyRelatedField Help Text

  }

users

• • swap_horiz /api/v1/users/

    GET POST OPTIONS

    List Create Clients

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    Signup response includes an access token

    
    

    {
   "profile":{response fields below},
   "token":{..}
 }

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsSuperAdminOrPOSTOnly	The request is authenticated as a user, or is a read-only request.

    Param name	Description
    password	Password
    last_login	Last Login
    is_superuser	Is Superuser
    groups	Groups
    user_permissions	User Permissions
    username	Username
    first_name	First Name
    last_name	Last Name
    is_staff	Is Staff
    is_active	Is Active
    date_joined	Date Joined
    last_activity	Last Activity
    role	Role
    phone	Phone
    google_profile_image	Google Profile Image
    confirm_code	Confirm Code
    reset_code	Reset Code
    old_password	Old Password
    changed_password	Changed Password
    verified	Verified
    dummy	Dummy
    available	Available
    email	Email
    dob	Dob
    gender	Gender
    allow_messages_import	Allow Messages Import
    filter_args	Filter Args
    last_response_id	Last Response Id
    can_update_history	Can Update History

    
    

    Request Fields:

    {

    • image: Base64ImageField,
    • password: CharField, Required
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • email: EmailField, Required
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • image: Base64ImageField,
    • profile_image: SerializerMethodField,
    • full_name: CharField,
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • available: BooleanField,
    • email: EmailField,
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }
• • swap_horiz /api/v1/users/me/

    GET PUT PATCH OPTIONS

    Retrieve Update Client

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • image: Base64ImageField,
    • password: CharField, Required
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • email: EmailField, Required
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • image: Base64ImageField,
    • profile_image: SerializerMethodField,
    • full_name: CharField,
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • available: BooleanField,
    • email: EmailField,
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }
• • swap_horiz /api/v1/users/technicians/

    GET OPTIONS

    List Technicians

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.
    IsSafariNjemaCustomerCareOrAdmin	A base class from which all permission classes should inherit.

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    {

    • id: IntegerField,
    • image: Base64ImageField,
    • profile_image: SerializerMethodField,
    • full_name: CharField,
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • available: BooleanField,
    • email: EmailField,
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }
• • swap_horiz /api/v1/users/me/profile/

    GET PUT PATCH OPTIONS

    Retrieve Client

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • image: Base64ImageField,
    • password: CharField, Required
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • email: EmailField, Required
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • image: Base64ImageField,
    • profile_image: SerializerMethodField,
    • full_name: CharField,
    • last_login: DateTimeField,
    • username: CharField, Help Text
    • first_name: CharField,
    • last_name: CharField,
    • date_joined: DateTimeField,
    • role: ChoiceField,
      Choices

      Value	Meaning
      N	Normal
      A	Admin
      C	Customer Care
      T	Technician

    • phone: CharField,
    • google_profile_image: URLField,
    • verified: BooleanField,
    • dummy: BooleanField,
    • available: BooleanField,
    • email: EmailField,
    • dob: DateField,
    • gender: ChoiceField,
      Choices

      Value	Meaning
      M	Male
      F	Female
      RNS	Rather Not Say

    • allow_messages_import: BooleanField,
    • filter_args: CharField,
    • last_response_id: CharField,
    • conversation_history: JSONField,
    • can_update_history: BooleanField

    }
• • swap_horiz /api/v1/users/forgot-password

    POST OPTIONS

    Clients Forgot Password

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    No output data specified

• • swap_horiz /api/v1/users/reset-password

    POST PUT PATCH OPTIONS

    Clients Reset Password

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    
    

    Request Fields:

    {

    • reset_code: IntegerField, Required
    • new_password: CharField Required

    }

    
    

    Response Fields:

    {

    • reset_code: IntegerField,
    • new_password: CharField

    }

translation-locales

• • swap_horiz /api/v1/translation-locales/

    GET POST OPTIONS

    List Create Translation Locales

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    Param name	Description
    created	Created
    modified	Modified
    created_by	Created By
    updated_by	Updated By
    name	Name
    country_code	Country Code
    language_code	Language Code
    version	Version
    active	Active

    
    

    Request Fields:

    {

    • name: CharField, Required
    • country_code: CharField, Required
    • language_code: CharField, Required
    • translations: JSONField,
    • active: BooleanField,

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • name: CharField,
    • country_code: CharField,
    • language_code: CharField,
    • translations: JSONField,
    • version: CharField,
    • active: BooleanField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/translation-locales/flutter/

    GET OPTIONS

    List Flutter Formatted Translation Locales

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    DjangoModelPermissionsOrAnonReadOnly	Similar to DjangoModelPermissions, except that anonymous users are allowed read-only access.

    Param name	Description
    created	Created
    modified	Modified
    created_by	Created By
    updated_by	Updated By
    name	Name
    country_code	Country Code
    language_code	Language Code
    version	Version
    active	Active

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • name: CharField,
    • country_code: CharField,
    • language_code: CharField,
    • translations: JSONField,
    • version: CharField,
    • active: BooleanField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/translation-locales/<int:pk>/

    GET PUT PATCH DELETE OPTIONS

    Retrieve Update Destroy Translation Locale

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • name: CharField, Required
    • country_code: CharField, Required
    • language_code: CharField, Required
    • translations: JSONField,
    • active: BooleanField,

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • name: CharField,
    • country_code: CharField,
    • language_code: CharField,
    • translations: JSONField,
    • version: CharField,
    • active: BooleanField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField Help Text

    }

translation-texts

• • swap_horiz /api/v1/translation-texts/

    GET POST OPTIONS

    List Create Translation Texts

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    Param name	Description
    created	Created
    modified	Modified
    created_by	Created By
    updated_by	Updated By
    title	Title
    description	Description
    active	Active

    
    

    Request Fields:

    {

    • title: CharField, Required
    • example: JSONField,
    • description: CharField,
    • active: BooleanField,

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • title: CharField,
    • example: JSONField,
    • description: CharField,
    • active: BooleanField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/translation-texts/<int:pk>/

    GET PUT PATCH DELETE OPTIONS

    Retrieve Update Destroy Translation Text

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • title: CharField, Required
    • example: JSONField,
    • description: CharField,
    • active: BooleanField,

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • title: CharField,
    • example: JSONField,
    • description: CharField,
    • active: BooleanField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField Help Text

    }

locale-translation-texts

• • swap_horiz /api/v1/locale-translation-texts/

    GET POST OPTIONS

    List Create Locale Translation Texts

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    Param name	Description
    created	Created
    modified	Modified
    created_by	Created By
    updated_by	Updated By
    locale	Locale
    text	Text
    translated_text	Translated Text
    not_translated	Not Translated
    original	Original

    
    

    Request Fields:

    {

    • translated_text: CharField,
    • locale: PrimaryKeyRelatedField, Required Help Text
    • text: PrimaryKeyRelatedField Required Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • translated_text: CharField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField, Help Text
    • locale: PrimaryKeyRelatedField, Help Text
    • text: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/locale-translation-texts/stats/<str:type>/

    GET OPTIONS

    List Dynamic Locale Translation Texts Statistics

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    Group statistics by:
    `type` = {stat_types}
    

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    Param name	Description
    created	Created
    modified	Modified
    created_by	Created By
    updated_by	Updated By
    locale	Locale
    text	Text
    translated_text	Translated Text
    not_translated	Not Translated
    original	Original

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    {

    • id: IntegerField,
    • language: ReadOnlyField,
    • country_code: ReadOnlyField,
    • language_code: ReadOnlyField,
    • original: ReadOnlyField,
    • original_description: ReadOnlyField,
    • translated: ReadOnlyField,
    • is_translated: SerializerMethodField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • translated_text: CharField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField, Help Text
    • locale: PrimaryKeyRelatedField, Help Text
    • text: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/locale-translation-texts/<int:pk>/

    GET PUT PATCH DELETE OPTIONS

    Retrieve Update Destroy Locale Translation Text

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • translated_text: CharField,
    • locale: PrimaryKeyRelatedField, Required Help Text
    • text: PrimaryKeyRelatedField Required Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • created: DateTimeField,
    • modified: DateTimeField,
    • translated_text: CharField,
    • created_by: PrimaryKeyRelatedField, Help Text
    • updated_by: PrimaryKeyRelatedField, Help Text
    • locale: PrimaryKeyRelatedField, Help Text
    • text: PrimaryKeyRelatedField Help Text

    }

chat-messages

• • swap_horiz /api/v1/chat-messages/<int:pk>/

    GET PUT PATCH DELETE OPTIONS

    Retrieve Update Destroy Chat Message

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    
    

    Request Fields:

    {

    • session_id: CharField, Required
    • message: CharField,
    • sender: ChoiceField,
      Choices

      Value	Meaning
      user	User
      ai	AI

    • message_id: CharField,
    • sent: BooleanField,
    • user: PrimaryKeyRelatedField Required Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • session_id: CharField,
    • message: CharField,
    • sender: ChoiceField,
      Choices

      Value	Meaning
      user	User
      ai	AI

    • timestamp: DateTimeField,
    • message_id: CharField,
    • sent: BooleanField,
    • user: PrimaryKeyRelatedField Help Text

    }
• • swap_horiz /api/v1/chat-messages/

    GET POST OPTIONS

    List Create Chat Messages

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    IsAuthenticated	Allows access only to authenticated users.

    Param name	Description
    user	User
    session_id	Session Id
    message	Message
    sender	Sender
    timestamp	Timestamp
    message_id	Message Id
    sent	Sent

    
    

    Request Fields:

    {

    • session_id: CharField, Required
    • message: CharField,
    • sender: ChoiceField,
      Choices

      Value	Meaning
      user	User
      ai	AI

    • message_id: CharField,
    • sent: BooleanField,
    • user: PrimaryKeyRelatedField Required Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • session_id: CharField,
    • message: CharField,
    • sender: ChoiceField,
      Choices

      Value	Meaning
      user	User
      ai	AI

    • timestamp: DateTimeField,
    • message_id: CharField,
    • sent: BooleanField,
    • user: PrimaryKeyRelatedField Help Text

    }

cv-upload-requests

• • swap_horiz /api/v1/cv-upload-requests/<int:pk>/

    GET PUT PATCH DELETE OPTIONS

    Retrieve Update Destroy C V Upload Request

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

    
    

    Request Fields:

    {

    • job_title: CharField, Required
    • company: CharField, Required
    • location: CharField, Required
    • job_description: CharField, Required
    • full_name: CharField,
    • phone_number: CharField,
    • email: EmailField, Required
    • uploaded_cv: FileField, Required
    • cover_letter_creativity: IntegerField, Help Text
    • processing_started_at: DateTimeField,
    • processing_completed_at: DateTimeField,
    • failure_reason: CharField,
    • optimized_cv: FileField,
    • cover_letter: FileField,
    • payment_confirmed: BooleanField, Help Text
    • payment_reference: CharField, Help Text
    • payment_amount: FloatField, Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • job_title: CharField,
    • company: CharField,
    • location: CharField,
    • job_description: CharField,
    • full_name: CharField,
    • phone_number: CharField,
    • email: EmailField,
    • uploaded_cv: FileField,
    • cover_letter_creativity: IntegerField, Help Text
    • status: CharField,
    • processing_started_at: DateTimeField,
    • processing_completed_at: DateTimeField,
    • failure_reason: CharField,
    • optimized_cv: FileField,
    • cover_letter: FileField,
    • payment_confirmed: BooleanField, Help Text
    • payment_reference: CharField, Help Text
    • payment_amount: FloatField, Help Text
    • created_at: DateTimeField,
    • updated_at: DateTimeField

    }
• • swap_horiz /api/v1/cv-upload-requests/<int:upload_id>/initiate-payment/

    OPTIONS POST

    Initiate Payment

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    Initiate payment for an existing CV upload request

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    No output data specified

• • swap_horiz /api/v1/cv-upload-requests/<int:upload_id>/verify-payment/

    OPTIONS POST

    Verify Payment

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions

    Verify payment for a CV upload request

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

    
    

    Request Fields:

    No input data specified

    
    

    Response Fields:

    No output data specified

• • swap_horiz /api/v1/cv-upload-requests/

    GET POST OPTIONS

    List Create C V Upload Requests

    Copy to clipboard Copy Link

    Open Link  

    ---

    • Description
    • Authentication
    • Permissions
    • Filters

    No description provided by developer

    Action is allowed if any of these auth types is provided(logic OR)

    Type	Description
    OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
    SessionAuthentication	Use Django's session framework for authentication.

    Action is allowed when all of conditions are satisfied(logic AND)

    Type	Description
    AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

    Param name	Description
    MyDjangoFilterBackend	None

    
    

    Request Fields:

    {

    • job_title: CharField, Required
    • company: CharField, Required
    • location: CharField, Required
    • job_description: CharField, Required
    • full_name: CharField,
    • phone_number: CharField,
    • email: EmailField, Required
    • uploaded_cv: FileField, Required
    • cover_letter_creativity: IntegerField, Help Text
    • processing_started_at: DateTimeField,
    • processing_completed_at: DateTimeField,
    • failure_reason: CharField,
    • optimized_cv: FileField,
    • cover_letter: FileField,
    • payment_confirmed: BooleanField, Help Text
    • payment_reference: CharField, Help Text
    • payment_amount: FloatField, Help Text

    }

    
    

    Response Fields:

    {

    • id: IntegerField,
    • job_title: CharField,
    • company: CharField,
    • location: CharField,
    • job_description: CharField,
    • full_name: CharField,
    • phone_number: CharField,
    • email: EmailField,
    • uploaded_cv: FileField,
    • cover_letter_creativity: IntegerField, Help Text
    • status: CharField,
    • processing_started_at: DateTimeField,
    • processing_completed_at: DateTimeField,
    • failure_reason: CharField,
    • optimized_cv: FileField,
    • cover_letter: FileField,
    • payment_confirmed: BooleanField, Help Text
    • payment_reference: CharField, Help Text
    • payment_amount: FloatField, Help Text
    • created_at: DateTimeField,
    • updated_at: DateTimeField

    }