POST api/Affiliate

Create a new client under affiliate user, By passing userid value greater then zero means you want to update client detail

Request Information

URI Parameters

None.

Body Parameters

UserVM
NameDescriptionTypeAdditional information
userid

User id

integer

None.

fullname

User full name

string

Required

String length: inclusive between 3 and 2147483647

email

User email addess

string

Required

phone

User phone number

string

Required

firstName

string

None.

lastName

string

None.

genovaID

string

None.

password

User password It is an optional field. In case the API user is not enter the password then system will generate a new random password.

string

String length: inclusive between 4 and 200

active

It represents the user is active or not. By default the user is active.

boolean

None.

address1

Client's first address

string

Required

address2

Client's second address

string

None.

city

User's city

string

Required

state

User's state

string

Required

String length: inclusive between 2 and 2

zip

User's zip code

string

Required

country

Country name in case of international user

string

None.

companyname

User's company name

string

None.

specialty

User's speciality

string

None.

emails

It is a boolean field, if its true then the user will receives emails otherwise not.

boolean

None.

referedby

User refered by

string

None.

clientkey

Client's key

string

None.

clientsecret

Client's secret key

string

None.

apiuser

It represents the user is an API user or not.

boolean

None.

errormsgs

UserVM

None.

accesstocken

string

None.

RoleType

string

None.

TotalRecords

integer

None.

userStatus

string

None.

userVMs

Collection of UserVM

None.

AccountMangerName

string

None.

approveStatus

string

None.

isapprove

boolean

None.

IsError

boolean

None.

Message

string

None.

ReturnUrl

string

None.

ReturnId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "userid": 1,
  "fullname": "Tommy Martel",
  "email": "tommym@gmail.com",
  "phone": "7877788878",
  "firstName": null,
  "lastName": null,
  "genovaID": null,
  "password": "pa12reNd",
  "active": true,
  "address1": "507 Pulaski Avenue Linden, NJ 07036",
  "address2": "508 Pulaski Avenue Linden, NJ 09036",
  "city": "New York",
  "state": "LA",
  "zip": "94203",
  "country": null,
  "companyname": "United Health Group",
  "specialty": "Doctor",
  "emails": true,
  "referedby": "Refered by name",
  "clientkey": "cLdfapLRxCSz+7fdkHzJTsBdfkkM9Psa8CC0e2RS13I=",
  "clientsecret": "H6NO0B9y/Yvfdfd77Y7LZQci+nQ2ai+fdbyO/TFeL88A=",
  "apiuser": true,
  "errormsgs": null,
  "accesstocken": null,
  "roleType": null,
  "totalRecords": 0,
  "userStatus": null,
  "userVMs": null,
  "accountMangerName": null,
  "approveStatus": null,
  "isapprove": null,
  "isError": false,
  "message": null,
  "returnUrl": null,
  "returnId": 0
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserVM'.

Response Information

Resource Description

UserVM
NameDescriptionTypeAdditional information
userid

User id

integer

None.

fullname

User full name

string

Required

String length: inclusive between 3 and 2147483647

email

User email addess

string

Required

phone

User phone number

string

Required

firstName

string

None.

lastName

string

None.

genovaID

string

None.

password

User password It is an optional field. In case the API user is not enter the password then system will generate a new random password.

string

String length: inclusive between 4 and 200

active

It represents the user is active or not. By default the user is active.

boolean

None.

address1

Client's first address

string

Required

address2

Client's second address

string

None.

city

User's city

string

Required

state

User's state

string

Required

String length: inclusive between 2 and 2

zip

User's zip code

string

Required

country

Country name in case of international user

string

None.

companyname

User's company name

string

None.

specialty

User's speciality

string

None.

emails

It is a boolean field, if its true then the user will receives emails otherwise not.

boolean

None.

referedby

User refered by

string

None.

clientkey

Client's key

string

None.

clientsecret

Client's secret key

string

None.

apiuser

It represents the user is an API user or not.

boolean

None.

errormsgs

UserVM

None.

accesstocken

string

None.

RoleType

string

None.

TotalRecords

integer

None.

userStatus

string

None.

userVMs

Collection of UserVM

None.

AccountMangerName

string

None.

approveStatus

string

None.

isapprove

boolean

None.

IsError

boolean

None.

Message

string

None.

ReturnUrl

string

None.

ReturnId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "userid": 1,
  "fullname": "Tommy Martel",
  "email": "tommym@gmail.com",
  "phone": "7877788878",
  "firstName": null,
  "lastName": null,
  "genovaID": null,
  "password": "pa12reNd",
  "active": true,
  "address1": "507 Pulaski Avenue Linden, NJ 07036",
  "address2": "508 Pulaski Avenue Linden, NJ 09036",
  "city": "New York",
  "state": "LA",
  "zip": "94203",
  "country": null,
  "companyname": "United Health Group",
  "specialty": "Doctor",
  "emails": true,
  "referedby": "Refered by name",
  "clientkey": "cLdfapLRxCSz+7fdkHzJTsBdfkkM9Psa8CC0e2RS13I=",
  "clientsecret": "H6NO0B9y/Yvfdfd77Y7LZQci+nQ2ai+fdbyO/TFeL88A=",
  "apiuser": true,
  "errormsgs": null,
  "accesstocken": null,
  "roleType": null,
  "totalRecords": 0,
  "userStatus": null,
  "userVMs": null,
  "accountMangerName": null,
  "approveStatus": null,
  "isapprove": null,
  "isError": false,
  "message": null,
  "returnUrl": null,
  "returnId": 0
}