10BC0 GitHub - BookHouseEffect/HomeFixService: API based web service used as a helper for a mobile application development for a school project. It contains the web service code including a database scripts based on a code-first approach. The application will be used for registering and searching people that are capable of doing goods for the society, such as electrician, house cleaners, windows fixer, etc.
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Nov 17, 2022. It is now read-only.
/ HomeFixService Public archive

API based web service used as a helper for a mobile application development for a school project. It contains the web service code including a database scripts based on a code-first approach. The application will be used for registering and searching people that are capable of doing goods for the society, such as electrician, house cleaners, win…

1 star 2 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

BookHouseEffect/HomeFixService

BranchesTags

Repository files navigation

HomeFixService

API based web service used as a helper for a mobile application development for a school project. It contains the web service code including a database scripts based on a code-first approach. The application will be used for registering and searching people that are capable of doing goods for the society, such as electrician, house cleaners, windows fixer, etc.

API Usage Description

*Note: << Domain name >> will be used instead of domain name.

Registering an user

Method type: POST
Route: << Domain name >>/api/account/register
Headers: Content-Type application/json
Body Context: JSON object: 
{
	"FirstName": <<string>>,
	"LastName": <<string>>,
	"UserName": <<string>>,
	"Password": <<string>>
}
The returned result: JSON object: 
{
	"UserFirstName": <<string>>,
	"UserLastName": <<string>>,
	"RatingSum": <<integer>>,
	"RatingCount": <<integer>>,
	"Id": <<integer>>
}
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting a token

Method type: POST
Route: << Domain name >>/token
Headers: Content-Type application/x-www-form-urlencoded
x-www-form-urlencoded parameters: grant_type password
username <<string>>
password <<string>>
The returned result: JSON object: 
{
    "access_token": <<string>>
    "token_type": "bearer",
    "expires_in": <<integer>>
}
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting info about the user

Method type: GET
Route: << Domain name >>/api/account/user
URI Parameters: userId <<integer>>
The returned result: JSON object: 
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
}
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Updating user info

Method type: POST
Route: << Domain name >>/api/account/user
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"FirstName":<<string>>,
	"LastName":<<string>>
}
The returned result: JSON object: 
{
	"UserFirstName": <<string>>,
	"UserLastName": <<string>>,
	"RatingSum": <<integer>>,
	"RatingCount": <<integer>>,
	"Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Changing a password

Method type: POST
Route: << Domain name >>/api/account/changePassword
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"Username":<<string>>,
	"OldPassword":<<string>>,
	"NewPassword":<<string>>
}
The returned result: Plain text: 
true
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.

Removing user

Method type: DELETE
Route: << Domain name >>/api/account/user
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"Username":<<string>>,
	"Password":<<string>>
}
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.

Adding a contact number

Method type: POST
Route: << Domain name >>/api/contact/number
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"PhoneNumber": <<string>>
}
The returned result: JSON object: 
{
    "PhoneNumber": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting contact numbers for user

Method type: GET
Route: << Domain name >>/api/contact/number
URI Parameters: userId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "PhoneNumber": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "PhoneNumber": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Updating a contact number

Method type: PUT
Route: << Domain name >>/api/contact/number
Headers: Content-Type application/json
Authorization bearer <<token value>>
URI Parameters: id <<integer>>
Body Context: JSON object: 
{
	"PhoneNumber": <<string>>
}
The returned result: JSON object: 
{
    "PhoneNumber": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Removing a contact number

Method type: DELETE
Route: << Domain name >>/api/contact/number
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Adding a contact address

Method type: POST
Route: << Domain name >>/api/contact/address
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: D6F2 JSON object: 
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>, 
    "Longitude": <<decimal>>
}
The returned result: JSON object: 
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>,
    "Longitude": <<decimal>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Getting contact addresses for user

Method type: GET
Route: << Domain name >>/api/contact/address
URI Parameters: userId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>,
    "Longitude": <<decimal>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>,
    "Longitude": <<decimal>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Updating a contact address

Method type: PUT
Route: << Domain name >>/api/contact/address
Headers: Content-Type application/json
Authorization bearer <<token value>>
URI Parameters: id <<integer>>
Body Context: JSON object: 
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>, 
    "Longitude": <<decimal>>
}
The returned result: JSON object: 
{
    "StreetName": <<string>>,
    "City": <<string>>,
    "Country": <<string>>,
    "Latitude": <<decimal>>,
    "Longitude": <<decimal>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Removing a contact address

Method type: DELETE
Route: << Domain name >>/api/contact/address
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting build-in enumerated professions list

Method type: GET
Route: << Domain name >>/api/profession/professionList
The returned result: JSON array of zero or more JSON objects: 
[
{
    "ProfessionName": <<string>>,
    "ProfessionDescription": <<string>>,
    "Id": <<integer>>
},
{
    "ProfessionName": <<string>>,
    "ProfessionDescription": <<string>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Assigning profession to user

Method type: POST
Route: << Domain name >>/api/profession/type
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"ProfessionToAssign":<<integer>>
}
The returned result: JSON object: 
{
    "UserId": <<integer>>,
    "ProfessionId": <<integer>>,
    "TheProfession": {
        "ProfessionName": <<string>>,
        "ProfessionDescription": <<string>>,
        "Id": <<integer>>
    },
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting assigned profession for user

Method type: GET
Route: << Domain name >>/api/profession/type
URI Parameters: userId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "UserId": <<integer>>,
    "ProfessionId": <<integer>>,
    "TheProfession": {
        "ProfessionName": <<string>>,
        "ProfessionDescription": <<string>>,
        "Id": <<integer>>
    },
    "Id": <<integer>>
},
{
    "UserId": <<integer>>,
    "ProfessionId": <<integer>>,
    "TheProfession": {
        "ProfessionName": <<string>>,
        "ProfessionDescription": <<string>>,
        "Id": <<integer>>
    },
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Removing assigned profession from user

Method type: DELETE
Route: << Domain name >>api/profession/type
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting build-in enumerated currency list

Method type: GET
Route: << Domain name >>/api/profession/currencyList
The returned result: JSON array of zero or more JSON objects: 
[
{
    "CurrencySign": <<string>>,
    "CurrencyFullName": <<string>>,
    "Id": <<integer>>
},
{
    "CurrencySign": <<string>>,
    "CurrencyFullName": <<string>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Adding a service for a profession assigned to user

Method type: POST
Route: << Domain name >>/api/profession/service
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
        "UserProfessionId":<<integer>>,
        "ServiceName":<<string>>,
        "ServiceUnit":<<string>>,
        "ServiceUnitPrice":<<decimal>>,
        "Currency":<<integer>>
}
The returned result: JSON object: 
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Getting list of services about a profession for user

Method type: GET
Route: << Domain name >>/api/profession/service
URI Parameters: userId <<integer>>
professionId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Getting full list of services for user independent from profession

Method type: GET
Route: << Domain name >>/api/profession/service
URI Parameters: userId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Updating a service offered by user

Method type: PUT
Route: << Domain name >>/api/profession/service
Headers: Content-Type application/json
Authorization bearer <<token value>>
URI Parameters: id <<integer>>
Body Context: JSON object: 
{
    "ServiceName":<<string>>,
    "ServiceUnit":<<string>>,
    "ServiceUnitPrice":<<decimal>>,
    "Currency":<<integer>>
}
The returned result: JSON object: 
{
    "ServiceName": <<string>>,
    "ServiceUnit": <<string>>,
    "ServiceUnitPrice": <<decimal>>,
    "ServiceUnitId": <<integer>>,
    "TheCurrencyUsed": {
        "CurrencySign": <<string>>,
        "CurrencyFullName": <<string>>,
        "Id": <<integer>>
    },
    "UserProfessionId": <<integer>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Removing a service offered by user

Method type: DELETE
Route: << Domain name >>/api/profession/service
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Adding a work timeschedule for user

Method type: POST
Route: << Domain name >>/api/schedule/work
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"UtcHours":<<integer>>,
	"UtcMinutes":<<integer>>,
	"StartDay":<<integer>>,
	"StartHours":<<integer>>, 
	"StartMinutes":<<integer>>, 
	"EndDay":<<integer>>,
	"EndHours":<<integer>>,
	"EndMinutes":<<integer>>
}
The returned result: JSON object: 
{
    "StartDay": <<integer>>,
    "StartTime": <<string>>,
    "EndDay": <<integer>>,
    "EndTime": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting work timeschedules for user

Method type: GET
Route: << Domain name >>/api/schedule/work
URI Parameters: userId <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "StartDay": <<integer>>,
    "StartTime": <<string>>,
    "EndDay": <<integer>>,
    "EndTime": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "StartDay": <<integer>>,
    "StartTime": <<string>>,
    "EndDay": <<integer>>,
    "EndTime": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Updating a work timeschedule for user

Method type: PUT
Route: << Domain name >>/api/schedule/work
Headers: Content-Type application/json
Authorization bearer <<token value>>
URI Parameters: id <<integer>>
Body Context: JSON object: 
{
	"UtcHours":<<integer>>,
	"UtcMinutes":<<integer>>,
	"StartDay":<<integer>>,
	"StartHours":<<integer>>, 
	"StartMinutes":<<integer>>, 
	"EndDay":<<integer>>,
	"EndHours":<<integer>>,
	"EndMinutes":<<integer>>
}
The returned result: JSON object: 
{
    "StartDay": <<integer>>,
    "StartTime": <<string>>,
    "EndDay": <<integer>>,
    "EndTime": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Removing a work timeschedule for user

Method type: DELETE
Route: << Domain name >>/api/schedule/work
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Adding a unavailable period for user

Method type: POST
Route: << Domain name >>/api/schedule/busy
Headers: Content-Type application/json
Authorization bearer <<token value>>
Body Context: JSON object: 
{
	"UtcHours":<<integer>>,
	"UtcMinutes":<<integer>>,
	"StartYear":<<integer>>,
	"StartMonth":<<integer>>,
	"StartDay":<<integer>>,
	"StartHours":<<integer>>,
	"StartMinutes":<<integer>>,
	"EndYear":<<integer>>,
	"EndMonth":<<integer>>,
	"EndDay":<<integer>>,
	"EndHours":<<integer>>,
	"EndMinutes":<<integer>>
}
The returned result: JSON object: 
{
    "BusyPeriodStartOn": <<string>>,
    "BusyPeriodEndsOn": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting unavailable periods for user in a given interval

Method type: GET
Route: << Domain name >>/api/schedule/busy
URI Parameters: userId <<integer>>
UtcHours <<integer>>
StartYear <<integer>>
StartMonth <<integer>>
StartDay <<integer>>
StartHours <<integer>>
StartMinutes <<integer>>
EndYear <<integer>>
EndMonth <<integer>>
EndDay <<integer>>
EndHours <<integer>>
EndMinutes <<integer>>
The returned result: JSON array of zero or more JSON objects: 
[
{
    "BusyPeriodStartOn": <<string>>,
    "BusyPeriodEndsOn": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
},
{
    "BusyPeriodStartOn": <<string>>,
    "BusyPeriodEndsOn": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Updating unavailable period for user

Method type: PUT
Route: << Domain name >>/api/schedule/busy
Headers: Content-Type application/json
Authorization bearer <<token value>>
URI Parameters: id <<integer>>
Body Context: JSON object: 
{
	"UtcHours":<<integer>>,
	"UtcMinutes":<<integer>>,
	"StartYear":<<integer>>,
	"StartMonth":<<integer>>,
	"StartDay":<<integer>>,
	"StartHours":<<integer>>,
	"StartMinutes":<<integer>>,
	"EndYear":<<integer>>,
	"EndMonth":<<integer>>,
	"EndDay":<<integer>>,
	"EndHours":<<integer>>,
	"EndMinutes":<<integer>>
}
The returned result: JSON object: 
{
    "BusyPeriodStartOn": <<string>>,
    "BusyPeriodEndsOn": <<string>>,
    "UserId": <<integer>>,
    "Id": <<integer>>
}
<<token value>> means that the API is expecting an access_token value.
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Removing unavailable period for user

Method type: DELETE
Route: << Domain name >>/api/schedule/busy
Headers: Authorization bearer <<token value>>
URI Parameters: id <<integer>>
The returned result: Plain Text: 
true
<<token value>> means that the API is expecting an access_token value.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Rating a user

Method type: POST
Route: << Domain name >>/api/feedback/rate
Headers: Content-Type application/json
Body Context: JSON object: 
{
	"UserId":<<integer>>,
	"Points":<<integer>>
}
The returned result: JSON object: 
{
    "Key": {
        "FeedbackDateTime": <<string>>,
        "FeedbackPoints": <<integer>>,
        "UserId": <<integer>>,
        "Id": <<integer>>
    },
    "Value": <<integer>>
}
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.

Getting the user rating

Method type: GET
Route: << Domain name >>/api/feedback/rate
URI Parameters: userId <<integer>>
The returned result: Plain Text: 
<<decimal>>
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<decimal>> means that the API is expecting or returning a 32-bit floating 34CE point number.

Getting list of Countries

Method type: GET
Route: << Domain name >>/api/search/listCountry
URI Parameters: countryCriteria <<string>> <<optional>>>>
The returned result: JSON array of zero or mode strings: 
[
	<<string>>,
	<<string>>
]
<<string>> means that the API is expecting or returning a string object.
<<optional>> means that the API can accept empty string as value.

Getting list of Cities for a given country

Method type: GET
Route: << Domain name >>/api/search/listCityForCountry
URI Parameters: countryName <<string>>
cityCriteria <<string>> <<optional>>
The returned result: JSON array of zero or mode strings: 
[
	<<string>>,
	<<string>>
]
<<string>> means that the API is expecting or returning a string object.
<<optional>> means that the API can accept empty string as value.

Searching users by country name and city name

Method type: GET
Route: << Domain name >>/api/search/searchByCountryAndCity
URI Parameters: CountryName <<string>>
CityName <<string>>
SearchTerm <<string>> <<optional>>
PageSize <<integer>>
PageNumber <<integer>>
The returned result: JSON array of zero or mode JSON objects: 
[
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
},
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<optional>> means that the API can accept empty string as value.

Searching users by profession

Method type: GET
Route: << Domain name >>/api/search/searchByProfession
URI Parameters: Profession <<integer>>
CurrentLatitude <<decimal>>
CurrentLongitude <<decimal>>
SearchTerm <<string>> <<optional>>
PageSize <<integer>>
PageNumber <<integer>>
The returned result: JSON array of zero or mode JSON objects: 
[
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
},
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<optional>> means that the API can accept empty string as value.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

Searching users by global filter

Method type: GET
Route: << Domain name >>/api/search/generalSearch
URI Parameters: CurrentLatitude <<decimal>>
CurrentLongitude <<decimal>>
SearchTerm <<string>> <<optional>>
PageSize <<integer>>
PageNumber <<integer>>
The returned result: JSON array of zero or mode JSON objects: 
[
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
},
{
    "UserFirstName": <<string>>,
    "UserLastName": <<string>>,
    "RatingSum": <<integer>>,
    "RatingCount": <<integer>>,
    "Id": <<integer>>
}
]
<<string>> means that the API is expecting or returning a string object.
<<integer>> means that the API is expecting or returning a 32-bit integer.
<<optional>> means that the API can accept empty string as value.
<<decimal>> means that the API is expecting or returning a 32-bit floating point number.

About

API based web service used as a helper for a mobile application development for a school project. It contains the web service code including a database scripts based on a code-first approach. The application will be used for registering and searching people that are capable of doing goods for the society, such as electrician, house cleaners, win…

Resources

Readme
Activity

Stars

1 star

Watchers

2 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages
0