services/persons/{uid}/services/{svcid}

Gets full details of a service of a user/person.

A service is typically a source language, target language, type of work and some unit price information.

URL

(GET) /api/services/persons/{uid}/services/{svcid}

PARAMETERS

URL parameters are:

uid

The ID of a user/person. This must be an inhouse user or a user attached to a client.

Integer, Mandatory

svcid

The service ID

Integer, Mandatory


RESULTS

The service properties are:

id


string 

svcid

The unique service ID.

int

plid

Internal users only: The default price list of the master company ("My company").

With external users this value is null.

int?

id

A unique identifier that concatenates price list ID and service ID. The format is:

  • P{user ID}-{service ID}

This ID is redundant. We show it in Wordbee Translator for convenience for the user.


cid

The company of the person.

int

pid

The user/person id.

int?




src

The source language code of the service.

The special code "*" is a placeholder for any language: The service can be used for any source language.

To discover all languages see settings/languages

string

trg

The target language code of the service.

The special code "*" is a placeholder for any language: The service can be used for any source language.

string

srct

The source language title

string

trgt

The target language title

string

task

The service task code such as TR for translation or RV for revision. To discover all task types, see 

settings/tasks/codes

string

taskt

The task print title, such as "Translation", "Revision", etc.

string




comments

Optional internal comments (never visible to external users or unauthorized internals)

string?

rating

A user defined service rating from 0 (not set) to 6 (best).

int

ratingManager

The average rating given by managers and over the past weeks. This information is automatically populated from the Wordbee business analytics tools and the rating features.

0 means no data available. 1 is the lowest and 6 the highest rating.

decimal




unit

The unit that will be costed. Such as WD (words) or CH (characters). See this API to obtain a list of all units: 

Price units

string

unitt

The unit print title.

string

unitsCount

Indicates the number of units (unit) that the service amount includes.

In most cases this will be 1, but not in all, see below:

Examples: "20 cents per 1 word", "20 cents per 15 characters", etc.

int

amount

The service amount. It can be null if no amount is specified.

decimal?

amountt

A user friendly text with the service price. Null if amount is null.

For example:

  • "EUR 0.01 per Word"

  • "USD 0.2 per 50 Characters"

string?

currency

The three letter currency code such as EUR or USD.

string

currencySymbol

The currency symbol such as $.

string





Deadline calculation


leadHours

Used for deadline calculation. Defines the number of hours upon transmission of a request until the time in hours the work typically starts.

0 if not set or no lead time.

int

unitsPerDay

Used for deadline calculation. Defines the number of units the service provider can do in a work day.

0 if not set or no lead time.

int





Discounts


discountMode

Person services are very limited compared to company-level services. There is no possibility to customize discounts.

Where costing requires fuzzy intervals or discounts these are taken from the pricelist referenced by property plid.

With client user services, any cost related properties are not used (since services provided by clients are never costed in the system). 

Constant value of: PriceList

string

discountModeType

Constant value of: null

int?





Changes


changeUserId

The user who created or last updated this service.

int

changeDate

Date of last change of this service.

datetime




rights

Access rights details. Specifies the exact actions permitted on the service.

object


EXAMPLES

A typical result for an inhouse translator:

{
    "id": "P564-348",
    "svcid": 348,
    "plid": 221,
    "cid": 1321,
    "pid": 564,
    "src": "en",
    "trg": "ar",
    "srct": "English (en)",
    "trgt": "Arabic (ar)",
    "task": "TR",
    "taskt": "Translation",
    "unit": "WD",
    "unitt": "Word(s)",
    "currency": "EUR",
    "currencySymbol": "€",
    "unitsCount": 1,
    "amount": 0.1000,
    "amountText": "EUR 0.10 per Character",
    "leadHours": 1,
    "unitsPerDay": 5000,
    "discountMode": "PriceList",
    "discountModeType": null,
    "comments": "",
    "rating": 3,
    "ratingManager": 0.00,
    "changeUserId": 511,
    "changeDate": "2020-08-28T11:07:36.67Z"
}



ACCESS RIGHTS

See Services.