Download OpenAPI specification:Download
XML API used for interacting with Beeline Professional Edition
The Connect API is implemented on a RESTful basis with XML schema used to provide a formal definition of the request and response XML payloads. The resources to be accessed are business objects within Beeline Professional Edition representing either transactional (e.g. worker, engagement, invoice) or reference (e.g. cost center, supplier) data. Separate endpoints are provided for each of the resource types.
RESTful conventions mean that the API will typically support the following verbs for each of the resource endpoints:
At this time resource deletion can only be initiated via the Beeline Professional Edition Enterprise Application.
The following resources are currently supported - the API is being continually extended so please contact your Beeline Professional Edition support representative for the latest status.
A Worker represents a unique person in Beeline Professional Edition and includes information such as contact and identification details. A Worker can have a set of Engagements each of which encapsulates all information related to the “job” such as assigned organization, location, job profile, start/end dates and rate information. Note we use the term engagement rather than contract as an engagement can cover any classification of work (employee, staff augmentation, independent contractor, SOW or managed service). This 1:N association between Worker and Engagement allows Beeline Professional Edition to maintain a historical, consistent worker history across multiple Engagements. Workers can also have parallel Engagements.
The API provides access to all delivered and custom fields for a resource. Please see the Beeline Professional Edition XML Schema for details on field structure, naming and type definitions. Note that once introduced, a custom field will be available immediately on the API.
The optional revision history provides an audit trail of all updates to the resource including its custom fields.
It can be requested by setting the parameter includeRevisionHistory = true
in a GET request.
This will add a <RevisionHistory>
containing a set of <Revision>
elements to the returned resource data. Each revision includes:
Some entities, namely:
POST:/workers/queryRevisions
POST:/jobPostings/queryRevisions
POST:/jobApplications/queryRevisions
Provide dedicated revision history query endpoints. These endpoints allow for finer grain control of the revision history returned while still returning base entities and providing filtering seen in standard GET requests. The request body allows a consumer to specify what fields (custom or delivered) are displayed in the revision history.
An example request body would be:
<revisionQueries xmlns="http://connect.utmost.co/ns/1.0">
<revisionQuery>
<customFields>CUSTOM_FIELD_CODE_1</customFields>
<deliveredFields>status</deliveredFields>
<deliveredFields>legalName.first</deliveredFields>
<modifiedSince>2023-01-13T11:15:05</modifiedSince>
<modifiedTo>modifiedTo=2023-01-13T12:15:05</modifiedTo>
</revisionQuery>
</revisionQueries>
The above query will limit returned revisions to the time window denoted by modifiedSince
and modifiedTo
. If modifiedTo
is not supplied, the timestamp of the current
request will be used in place of modifiedTo
.
The above example will limit revisions on delivered fields, fields native to the entity, to only revisions that affect status
and legalName.first
. Dot(.
) notation
is used to specify sub fields. Not all fields are supported by the revision history at this time. If no delivered fields are specified then no revisions for delivered fields will
be returned.
The above example will limit revisions on custom fields, configured fields on the entity, to only revisions on the custom field with code
or reference Id
equal
to CUSTOM_FIELD_CODE_1
. If no value is provided for customFields
then no revisions for custom fields will be returned.
All Beeline Professional Edition resources have a unique identifier (UID) and this should be used to identify a particular instance. For convenience, in addition to UID, the GET actions also allow some resources to be identified via the more user-friendly referenceIds (e.g. company worker Id for a worker).
The modifiedSince
and modifiedTo
parameters can be used to facilitate efficient retrieval of delta updates.
Only those resources which have been modified within the window will be returned in the result set.
In addition the revision history will also be limited to changes within the timeframe.
When using the GET operation to retrieve large collections of resources, it is recommended to use pagination.
On the request, the page
and limit
parameters allow a specific page and number of items in the page to be specified.
The API will return the totalPages
to allow consuming applications to then easily iterate through the complete result set.
The following restrictions exist for pagination.
20
.1500
.Typically transactional resources such as Workers will have a status (e.g. active | inactive | deleted) and this can be used to filter the result set. For instance in the case of Worker only active resources are returned by default. Note that although deleted resources no longer appear within the Beeline Professional Edition Enterprise application, they are available via the API through filtering on the ‘deleted’ status.
An OAuth Client Credentials flow should first be used to obtain a bearer token which must be included in all API calls in order to authenticate the request.
To request a token, the client must POST to the /api/integration/client/oauth/token
endpoint on their Beeline Professional Edition tenant
specifying a client_id and client_secret. The grant_type should be set to client_credentials.
The client_id is configured per integration via the Beeline Professional Edition Enterprise Application by the system administrator. It will be configured with one or more ABAC (Attribute-Based Access Control) policies which will determine which actions (Create/Read/Update/Delete) can be performed on which resources right down to a field level.
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (WorkerXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <workers xmlns="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <worker xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <applicantId> <source>string</source> <type>string</type> <value>string</value> </applicantId> <personalDetails> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </preferredName> <email>string</email> <personalEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </personalEmail> <phone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phone> <gender> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </gender> <dateOfBirth> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>2023-01-04</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </dateOfBirth> <countryOfBirth> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </countryOfBirth> <countryOfBirthISO2> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </countryOfBirthISO2> <highestEducationLevel>string</highestEducationLevel> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <emergencyContact> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <phone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phone> <email>string</email> <relationship>string</relationship> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </emergencyContact> <nationalId> <primary>true</primary> <country>string</country> <countryISO2>string</countryISO2> <type>string</type> <value>string</value> <validUntil>2023-01-04</validUntil> </nationalId> <revisionHistory> <revisions> <timestamp>2023-01-04T15:53:34.252Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <rehireEligibility>string</rehireEligibility> <citizenship> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <country> <name>string</name> <code>string</code> </country> <type>string</type> </citizenship> <genderModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> </genderModel> </personalDetails> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-04</originalStartDate> <startDate>2023-01-04</startDate> <endDate>2023-01-04</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-04T15:53:34.252Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-04</startDate> <endDate>2023-01-04</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement> <deleted>false</deleted> <tenureStartDate> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>2023-01-04</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </tenureStartDate> <lastModified>2023-01-04T15:53:34.252Z</lastModified> <status>ACTIVE</status> </worker> </workers>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7BworkerUid%7D/engagements'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (EngagementXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:engagements xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-09</originalStartDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-09T11:16:28.578Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement> </connect:engagements>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (RevisionQueryXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/queryRevisions?params=SOME_OBJECT_VALUE'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
engagementUid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
primary | boolean |
status | string Enum: "PRE_HIRE" "ONBOARDING" "ONBOARDED" "OFFBOARDING" "OFFBOARDED" "DRAFT" |
object (ExternalStatusXmlModel) | |
object (JobProfileReferenceXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (UtmostReferenceEntityXmlModel) | |
object (BusinessSiteXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
originalStartDate | string <date> |
startDate | string <date> |
endDate | string <date> |
offboardOnEndDate | boolean |
object (AmountXmlModel) | |
billRatePeriod | string Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "OTHER" "ON_INVOICE" |
Array of objects (CustomFieldXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
object (JAXBElementString) | |
object (JAXBElementString) | |
Array of objects (PhoneNumberXmlModel) | |
isManager | boolean Default: false |
object (ManagerDetailsXmlModel) | |
object (RevisionHistoryXmlModel) | |
terminationReason | string |
title | string |
engagementId | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (ComplexRateModelXmlModel) | |
object (TerminationReasonXmlModel) | |
submitsTimesheet | boolean |
timeEntryType | string Enum: "HOURS" "CLOCK" |
object (AddressXmlModel) | |
workLocationType | string Enum: "ON_SITE" "REMOTE" |
workCity | string |
workProvince | string |
object (EngagementAppendixRequestXmlModel) | |
object (EngagementChangeRequestXmlModel) | |
badgeId | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (ProjectPositionXmlModel) | |
lastModified | string <date-time> |
created | string <date-time> |
workdayPositionId | string |
<?xml version="1.0" encoding="UTF-8"?> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-09</originalStartDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-09T11:17:46.936Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
engagementUid required | string |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7BworkerUid%7D/engagements/%7BengagementUid%7D/primary'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
includeRevisionHistory | boolean Default: false |
idsOnly | string Return lean models with only worker's and engagement's id and uid |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7Buid%7D?includeRevisionHistory=SOME_BOOLEAN_VALUE&idsOnly=SOME_STRING_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
object (WorkerIdXmlModel) | |
object (ExternalIdXmlModel) | |
object (PersonalDetailsXmlModel) | |
Array of objects (EngagementXmlModel) | |
deleted | boolean Default: false |
object (JAXBElementLocalDate) | |
lastModified | string <date-time> |
created | string <date-time> |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
<?xml version="1.0" encoding="UTF-8"?> <worker xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <applicantId> <source>string</source> <type>string</type> <value>string</value> </applicantId> <personalDetails> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </preferredName> <email>string</email> <personalEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </personalEmail> <phone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phone> <gender> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </gender> <dateOfBirth> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>2023-01-09</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </dateOfBirth> <countryOfBirth> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </countryOfBirth> <countryOfBirthISO2> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </countryOfBirthISO2> <highestEducationLevel>string</highestEducationLevel> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <emergencyContact> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <phone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phone> <email>string</email> <relationship>string</relationship> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </emergencyContact> <nationalId> <primary>true</primary> <country>string</country> <countryISO2>string</countryISO2> <type>string</type> <value>string</value> <validUntil>2023-01-09</validUntil> </nationalId> <revisionHistory> <revisions> <timestamp>2023-01-09T11:22:14.857Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <rehireEligibility>string</rehireEligibility> <citizenship> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <country> <name>string</name> <code>string</code> </country> <type>string</type> </citizenship> <genderModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> </genderModel> </personalDetails> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-09</originalStartDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-09T11:22:14.858Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement> <deleted>false</deleted> <tenureStartDate> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>2023-01-09</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </tenureStartDate> <lastModified>2023-01-09T11:22:14.858Z</lastModified> <status>ACTIVE</status> </worker>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
downloadLinkExpiration | string Example: downloadLinkExpiration=PT2H40M How long media download link will remain valid, e.g. PT2H40M for 2 hours 40 min |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7Buid%7D/profilePicture?downloadLinkExpiration=PT2H40M'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7BworkerUid%7D/engagements'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (EngagementXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:engagements xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-09</originalStartDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-09T11:16:28.578Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement> </connect:engagements>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
engagementUid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
primary | boolean |
status | string Enum: "PRE_HIRE" "ONBOARDING" "ONBOARDED" "OFFBOARDING" "OFFBOARDED" "DRAFT" |
object (ExternalStatusXmlModel) | |
object (JobProfileReferenceXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (UtmostReferenceEntityXmlModel) | |
object (BusinessSiteXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
originalStartDate | string <date> |
startDate | string <date> |
endDate | string <date> |
offboardOnEndDate | boolean |
object (AmountXmlModel) | |
billRatePeriod | string Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "OTHER" "ON_INVOICE" |
Array of objects (CustomFieldXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
object (JAXBElementString) | |
object (JAXBElementString) | |
Array of objects (PhoneNumberXmlModel) | |
isManager | boolean Default: false |
object (ManagerDetailsXmlModel) | |
object (RevisionHistoryXmlModel) | |
terminationReason | string |
title | string |
engagementId | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (ComplexRateModelXmlModel) | |
object (TerminationReasonXmlModel) | |
submitsTimesheet | boolean |
timeEntryType | string Enum: "HOURS" "CLOCK" |
object (AddressXmlModel) | |
workLocationType | string Enum: "ON_SITE" "REMOTE" |
workCity | string |
workProvince | string |
object (EngagementAppendixRequestXmlModel) | |
object (EngagementChangeRequestXmlModel) | |
badgeId | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (ProjectPositionXmlModel) | |
lastModified | string <date-time> |
created | string <date-time> |
workdayPositionId | string |
<?xml version="1.0" encoding="UTF-8"?> <engagement xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <primary>true</primary> <status>PRE_HIRE</status> <externalStatus> <name>string</name> <value>string</value> <source>string</source> </externalStatus> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <originalStartDate>2023-01-09</originalStartDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <offboardOnEndDate>true</offboardOnEndDate> <billRateAmount> <currency>string</currency> <amount>0</amount> </billRateAmount> <billRatePeriod>HOURLY</billRatePeriod> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <poNumber> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </poNumber> <workEmail> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </workEmail> <workPhone> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </workPhone> <isManager>false</isManager> <managerDetails> <workerId> <source>string</source> <type>string</type> <value>string</value> </workerId> <legalName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </legalName> <preferredName> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </preferredName> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> <jobTitle>string</jobTitle> <email>string</email> </managerDetails> <revisionHistory> <revisions> <timestamp>2023-01-09T11:17:46.936Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <terminationReason>string</terminationReason> <title>string</title> <engagementId>string</engagementId> <accountablePerson> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </accountablePerson> <holidaySchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </holidaySchedule> <workSchedule> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </workSchedule> <rateModel> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rateModel> <terminationReasonModel> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <onExportMapTo>string</onExportMapTo> <eligibleForRehire>true</eligibleForRehire> </terminationReasonModel> <submitsTimesheet>true</submitsTimesheet> <timeEntryType>HOURS</timeEntryType> <remoteWorkAddress> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </remoteWorkAddress> <workLocationType>ON_SITE</workLocationType> <workCity>string</workCity> <workProvince>string</workProvince> <appendixRequest> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> </appendixRequest> <badgeId>string</badgeId> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobApplication> </engagement>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
workerUid required | string |
engagementUid required | string |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workers/%7BworkerUid%7D/engagements/%7BengagementUid%7D/primary'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/engagements/%7BengagementUid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workerQualifications?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (WorkerQualificationXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workerQualifications'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workerQualifications/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
object (WorkerCertificationXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workerQualifications/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workRequests?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (WorkRequestXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workRequests'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workRequests/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "PENDING" "IN_PROGRESS" "CANCELLED" "FILLED" "DELETED" "APPROVED" "REJECTED" |
description | string |
reason | string |
poNumber | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
workLocationType | string Enum: "ON_SITE" "REMOTE" |
object (UtmostReferenceEntityXmlModel) | |
object (AddressXmlModel) | |
projectedCost | number <double> |
Array of objects (UtmostReferenceEntityXmlModel) | |
created | string <date-time> |
modified | string <date-time> |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
Array of objects (CustomFieldXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/workRequests/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/users?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (UserXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <connect:users xmlns:connect="http://connect.utmost.co/ns/1.0"> <user> <referenceId>string</referenceId> <name> <first>string</first> <last>string</last> </name> <email>string</email> <type>TENANT_USER</type> <msp> <referenceId>string</referenceId> </msp> <sendEmail>true</sendEmail> </user> </connect:users>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/users/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
object (NameXmlModel) | |
string | |
status | string Enum: "DELETED" "DISABLED" "ENABLED" |
type | string Enum: "TENANT_ADMIN" "TENANT_USER" "SUPPORT_USER" "MSP_ADMIN" "MSP_USER" "EXTERNAL_APPROVER" "SYSTEM_TENANT_ADMIN" "INTEGRATION_CLIENT" "UNKNOWN" |
object (UtmostReferenceEntityXmlModel) | |
created | string <date-time> |
modified | string <date-time> |
lastLogin | string <date-time> |
sendEmail | boolean |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <connect:user xmlns:connect="http://connect.utmost.co/ns/1.0"> <status>ENABLED</status> <type>TENANT_USER</type> <msp> <referenceId>string</referenceId> </msp> </connect:user>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/timesheets?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (TimesheetXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:timesheets xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <timesheet> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <engagement> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </engagement> <person> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </person> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <lineItem> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <workday>2023-01-09</workday> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <timeCode> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <default>true</default> </timeCode> <hours>0</hours> <amount> <currency>string</currency> <amount>0</amount> </amount> <clockInTime> <hour>0</hour> <minute>0</minute> <second>0</second> <nano>0</nano> </clockInTime> <clockOutTime> <hour>0</hour> <minute>0</minute> <second>0</second> <nano>0</nano> </clockOutTime> <rate> <currency>string</currency> <amount>0</amount> </rate> </lineItem> <created>2023-01-09</created> <modified>2023-01-09</modified> </timesheet> </connect:timesheets>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/timesheets/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
semanticVersion | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
startDate | string <date> |
endDate | string <date> |
Array of objects (TimesheetLineItemXmlModel) | |
created | string <date> |
modified | string <date> |
approvalDate | string <date-time> |
type | string Enum: "PAY" "BILL" "CORE" "NONE" |
timesheetStatus | string Enum: "WAITING_FOR_SUBMISSION" "PENDING" "REJECTED" "OVERDUE" "APPROVED" "INVOICED" "DELETED" |
object (UtmostReferenceEntityXmlModel) | |
notes | string |
<?xml version="1.0" encoding="UTF-8"?> <timesheet xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <engagement> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </engagement> <person> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </person> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <lineItem> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <workday>2023-01-09</workday> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <timeCode> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <default>true</default> </timeCode> <hours>0</hours> <amount> <currency>string</currency> <amount>0</amount> </amount> <clockInTime> <hour>0</hour> <minute>0</minute> <second>0</second> <nano>0</nano> </clockInTime> <clockOutTime> <hour>0</hour> <minute>0</minute> <second>0</second> <nano>0</nano> </clockOutTime> <rate> <currency>string</currency> <amount>0</amount> </rate> </lineItem> <created>2023-01-09</created> <modified>2023-01-09</modified> </timesheet>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/suppliers?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (SupplierXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:suppliers xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <generalContact> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> </generalContact> <contacts> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> <primary>true</primary> </contacts> <website>string</website> <description>string</description> <invoiceUploadEmail>string</invoiceUploadEmail> <parentSupplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parentSupplier> <legalInformation> <legalBusinessName>string</legalBusinessName> <businessLicense>string</businessLicense> <incorporationType>SOLE_PROPRIETORSHIP</incorporationType> <dba>string</dba> </legalInformation> <taxInformation> <taxId>string</taxId> <ein>string</ein> </taxInformation> <insuranceDetails> <insuranceProvider>string</insuranceProvider> <insuranceNumber>string</insuranceNumber> </insuranceDetails> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </supplier> </connect:suppliers>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/suppliers/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (ContactXmlModel) | |
Array of objects (SupplierContactXmlModel) | |
website | string |
description | string |
invoiceUploadEmail | string |
object (UtmostReferenceEntityXmlModel) | |
object (LegalInformationXmlModel) | |
object (TaxInformationXmlModel) | |
object (InsuranceDetailsXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <supplier xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <generalContact> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> </generalContact> <contacts> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> <primary>true</primary> </contacts> <website>string</website> <description>string</description> <invoiceUploadEmail>string</invoiceUploadEmail> <parentSupplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parentSupplier> <legalInformation> <legalBusinessName>string</legalBusinessName> <businessLicense>string</businessLicense> <incorporationType>SOLE_PROPRIETORSHIP</incorporationType> <dba>string</dba> </legalInformation> <taxInformation> <taxId>string</taxId> <ein>string</ein> </taxInformation> <insuranceDetails> <insuranceProvider>string</insuranceProvider> <insuranceNumber>string</insuranceNumber> </insuranceDetails> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </supplier>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/rateCards?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (RateCardXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:rateCards xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <rateCard> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <supplier xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <generalContact> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> </generalContact> <contacts> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> <primary>true</primary> </contacts> <website>string</website> <description>string</description> <invoiceUploadEmail>string</invoiceUploadEmail> <parentSupplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parentSupplier> <legalInformation> <legalBusinessName>string</legalBusinessName> <businessLicense>string</businessLicense> <incorporationType>SOLE_PROPRIETORSHIP</incorporationType> <dba>string</dba> </legalInformation> <taxInformation> <taxId>string</taxId> <ein>string</ein> </taxInformation> <insuranceDetails> <insuranceProvider>string</insuranceProvider> <insuranceNumber>string</insuranceNumber> </insuranceDetails> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </supplier> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <rates> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rates> </rateCard> </connect:rateCards>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/rateCards/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (JobProfileReferenceXmlModel) | |
object (SupplierXmlModel) | |
Array of objects (BusinessSiteXmlModel) | |
Array of objects (ComplexRateModelXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <rateCard xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <supplier xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <generalContact> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> </generalContact> <contacts> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <email>string</email> <primary>true</primary> </contacts> <website>string</website> <description>string</description> <invoiceUploadEmail>string</invoiceUploadEmail> <parentSupplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parentSupplier> <legalInformation> <legalBusinessName>string</legalBusinessName> <businessLicense>string</businessLicense> <incorporationType>SOLE_PROPRIETORSHIP</incorporationType> <dba>string</dba> </legalInformation> <taxInformation> <taxId>string</taxId> <ein>string</ein> </taxInformation> <insuranceDetails> <insuranceProvider>string</insuranceProvider> <insuranceNumber>string</insuranceNumber> </insuranceDetails> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </supplier> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <rates> <code>string</code> <name>string</name> <staticRateModel> <amount>0</amount> <currency>string</currency> <frequency>HOURLY</frequency> </staticRateModel> <formulaRateModel> <multiplier>0</multiplier> <baseRateModelCode>string</baseRateModelCode> </formulaRateModel> <type>STATIC</type> </rates> </rateCard>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projects?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ProjectXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:projects xmlns:ns2="http://connect.utmost.co/ns/1.0"> <project> <referenceId>ppRefId-V7urK3pgv7Uc</referenceId> <status>active</status> <number>0</number> <manager> <uid>UID</uid> <referenceId>COMPANY_WORKER_ID</referenceId> </manager> <controller> <uid>UID</uid> <referenceId>COMPANY_WORKER_ID</referenceId> </controller> <customer> <uid>UID</uid> <referenceId>REFERENCE_ID</referenceId> </customer> <projectPlan> <uid>UID</uid> <referenceId>REFERENCE_ID</referenceId> </projectPlan> <description>STRING</description> </project> </ns2:projects>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projects/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
number | integer <int64> |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (UtmostReferenceEntityXmlModel) | |
description | string |
Array of objects (CustomFieldXmlModel) | |
object (RevisionHistoryXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:project xmlns:ns2="http://connect.utmost.co/ns/1.0"> <referenceId>ppRefId-V7urK3pgv7Uc</referenceId> <status>active</status> <number>0</number> <manager> <uid>UID</uid> <referenceId>COMPANY_WORKER_ID</referenceId> </manager> <controller> <uid>UID</uid> <referenceId>COMPANY_WORKER_ID</referenceId> </controller> <customer> <uid>UID</uid> <referenceId>REFERENCE_ID</referenceId> </customer> <projectPlan> <uid>UID</uid> <referenceId>REFERENCE_ID</referenceId> </projectPlan> <description>STRING</description> </ns2:project>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectRoles?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ProjectRoleXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:ProjectRoles xmlns:ns2="http://connect.utmost.co/ns/1.0"> <projectRole> <referenceId>prRefId-V7urK3pgv7Uc</referenceId> <status>active</status> <description>This role is responsible for X, Y, Z</description> <displayName>Example Role</displayName> </projectRole> </ns2:ProjectRoles>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectRoles/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
description | string |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectRoles/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectPositions?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ProjectPositionXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:ProjectPositions xmlns:ns2="http://connect.utmost.co/ns/1.0"> <projectPosition> <referenceId>ppRefId-zhFpWJZvC9Zr</referenceId> <startDate>2014-01-02</startDate> <endDate>2023-03-04</endDate> <project> <uid>PRJ5c19e079-844c-4deb-bf1f-c3a9e89759d0</uid> </project> <projectRole> <uid>PRJRae859581-6689-4551-9b00-d16e6ab93191</uid> </projectRole> <rate> <code>bill_rate-ZSfJBA</code> <name>PEgljJ6h5k0v</name> <staticRateModel> <amount>31</amount> <currency>EUR</currency> <frequency>daily</frequency> </staticRateModel> <type>static</type> </rate> </projectPosition> </ns2:ProjectPositions>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectPositions/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
startDate | string <date> |
endDate | string <date> |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (ComplexRateModelXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:projectPosition xmlns:ns2="http://connect.utmost.co/ns/1.0"> <referenceId>ppRefId-zhFpWJZvC9Zr</referenceId> <startDate>2014-01-02</startDate> <endDate>2023-03-04</endDate> <project> <uid>PRJ5c19e079-844c-4deb-bf1f-c3a9e89759d0</uid> </project> <projectRole> <uid>PRJRae859581-6689-4551-9b00-d16e6ab93191</uid> </projectRole> <rate> <code>bill_rate-ZSfJBA</code> <name>PEgljJ6h5k0v</name> <staticRateModel> <amount>31</amount> <currency>EUR</currency> <frequency>daily</frequency> </staticRateModel> <type>static</type> </rate> </ns2:projectPosition>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectPlans?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ProjectPlanXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:ProjectPlans xmlns:ns2="http://connect.utmost.co/ns/1.0"> <projectPlan> <referenceId>ppRefId-V7urK3pgv7Uc</referenceId> <status>active</status> <project> <uid>PRJ08f5fcd8-d529-4fba-aa0f-a9b7a9ee8967</uid> </project> <projectPhase> <displayName>project-plan-phase-gS46rIFJtRpL</displayName> <referenceId>pppRefId-yBGyMWUPq9Fq</referenceId> <status>active</status> <projectTask> <displayName>project-plan-phase-task-Lvis5oHYbRu6</displayName> <referenceId>ppptRefId-9xcZqURFtXHJ</referenceId> <status>active</status> </projectTask> <projectTask> <displayName>project-plan-phase-task-55tJWz8Vhvtb</displayName> <referenceId>ppptRefId-N2UbNwXdeK33</referenceId> <status>active</status> </projectTask> </projectPhase> <projectPhase> <displayName>project-plan-phase-dMXmwxO234LU</displayName> <referenceId>pppRefId-WkzjucfwtHyy</referenceId> <status>active</status> </projectPhase> </projectPlan> </ns2:ProjectPlans>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectPlans/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (ProjectPhaseXmlModel) |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ns2:ProjectPlan xmlns:ns2="http://connect.utmost.co/ns/1.0"> <referenceId>ppRefId-V7urK3pgv7Uc</referenceId> <status>active</status> <project> <uid>PRJ08f5fcd8-d529-4fba-aa0f-a9b7a9ee8967</uid> </project> <projectPhase> <displayName>project-plan-phase-gS46rIFJtRpL</displayName> <referenceId>pppRefId-yBGyMWUPq9Fq</referenceId> <status>active</status> <projectTask> <displayName>project-plan-phase-task-Lvis5oHYbRu6</displayName> <referenceId>ppptRefId-9xcZqURFtXHJ</referenceId> <status>active</status> </projectTask> <projectTask> <displayName>project-plan-phase-task-55tJWz8Vhvtb</displayName> <referenceId>ppptRefId-N2UbNwXdeK33</referenceId> <status>active</status> </projectTask> </projectPhase> <projectPhase> <displayName>project-plan-phase-dMXmwxO234LU</displayName> <referenceId>pppRefId-WkzjucfwtHyy</referenceId> <status>active</status> </projectPhase> </ns2:ProjectPlan>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectCustomers?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ProjectCustomerXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectCustomers'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectCustomers/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
name | string |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/projectCustomers/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organizations?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (OrganizationXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organizations'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organisations?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (OrganizationXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organisations'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organisations/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organisations/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organizations/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/organizations/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/milestones?query=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (MilestoneXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/milestones'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/milestones/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
id | integer <int64> |
referenceId | string |
object (MilestoneParentXmlModel) | |
status | string Enum: "NOT_STARTED" "IN_PROGRESS" "SUBMITTED" |
order | integer <int32> |
description | string |
acceptanceCriteria | string |
dueDate | string <date> |
completedDate | string <date> |
object (AmountXmlModel) | |
created | string <date-time> |
modified | string <date-time> |
Array of objects (CustomFieldXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/milestones/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
entity required | string |
uid required | string |
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/%7Bentity%7D/%7Buid%7D/milestones?query=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobProfiles?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (JobProfileXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:jobProfiles xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile> </connect:jobProfiles>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobProfiles/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
title | string |
summary | string |
object (UtmostReferenceEntityXmlModel) | |
description | string |
Array of objects (UtmostReferenceEntityXmlModel) | |
Array of objects (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
Array of objects (JobProfileCountryXmlModel) | |
Array of objects (JobProfileEligibilityRequirementXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <jobProfile xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> <description>string</description> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamily> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <country> <code>string</code> </country> </jobProfile>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (RevisionQueryXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobPostings/queryRevisions?params=SOME_OBJECT_VALUE'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobPostings/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
requestedWorkerCount | integer |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
billRatePeriod | string Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "OTHER" "ON_INVOICE" |
paymentBasis | string Enum: "TIME" "TIME_AND_MATERIALS" "SOW" |
object (AmountXmlModel) | |
object (JobProfileReferenceXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (BusinessSiteXmlModel) | |
startDate | string <date> |
endDate | string <date> |
expiryDate | string <date> |
Array of objects (CommentXmlModel) | |
Array of objects (UtmostReferenceEntityXmlModel) | |
object (JobRequestSummaryXmlModel) | |
externalTitle | string |
externalDescription | string |
status | string Enum: "PENDING" "IN_PROGRESS" "CANCELLED" "FILLED" "DELETED" "DRAFT" "REJECTED" "REOPENED" |
created | string <date-time> |
modified | string <date-time> |
object (UserReferenceXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
object (RevisionHistoryXmlModel) | |
jobSummary | string |
<?xml version="1.0" encoding="UTF-8"?> <jobPosting xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <requestedWorkerCount>0</requestedWorkerCount> <minimumBillRate> <currency>string</currency> <amount>0</amount> </minimumBillRate> <maximumBillRate> <currency>string</currency> <amount>0</amount> </maximumBillRate> <billRatePeriod>HOURLY</billRatePeriod> <paymentBasis>TIME</paymentBasis> <projectedCost> <currency>string</currency> <amount>0</amount> </projectedCost> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <expiryDate>2023-01-09</expiryDate> <comment> <created>2023-01-09T12:09:09.653Z</created> <commenter> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <companyWorkerId>string</companyWorkerId> </commenter> <text>string</text> </comment> <suppliers> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </suppliers> <summary> <totalCandidateCount>0</totalCandidateCount> <rejectedCandidateCount>0</rejectedCandidateCount> <filledCount>0</filledCount> </summary> <externalTitle>string</externalTitle> <externalDescription>string</externalDescription> <status>PENDING</status> <created>2023-01-09T12:09:09.653Z</created> <modified>2023-01-09T12:09:09.653Z</modified> <creator> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <companyWorkerId>string</companyWorkerId> </creator> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> <revisionHistory> <revisions> <timestamp>2023-01-09T12:09:09.653Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> </jobPosting>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobPostings?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobFamilyGroups?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (JobFamilyGroupXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:jobFamilyGroups xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <summary>string</summary> </jobFamilyGroup> </connect:jobFamilyGroups>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobFamilyGroups/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
summary | string |
<?xml version="1.0" encoding="UTF-8"?> <jobFamilyGroup xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <summary>string</summary> </jobFamilyGroup>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobFamilies?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (JobFamilyXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:jobFamilies xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <jobFamily> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <summary>string</summary> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> </jobFamily> </connect:jobFamilies>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobFamilies/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
summary | string |
object (UtmostReferenceEntityXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <jobFamily xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <summary>string</summary> <jobFamilyGroup> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </jobFamilyGroup> </jobFamily>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobApplications?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (JobApplicationXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:jobApplications xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <jobApplication> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <jobPostingId>string</jobPostingId> <source>string</source> <email>string</email> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <gender>string</gender> <nationalId> <primary>true</primary> <country>string</country> <countryISO2>string</countryISO2> <type>string</type> <value>string</value> <validUntil>2023-01-09</validUntil> </nationalId> <dateOfBirth>2023-01-09</dateOfBirth> <preferredStartDate>2023-01-09</preferredStartDate> <preferredEndDate>2023-01-09</preferredEndDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenters xmlns="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <costCenter xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> </costCenters> <workdayApplicantId>string</workdayApplicantId> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <stage>string</stage> <jobApplicationStatus>APPROVED</jobApplicationStatus> <shortlisted>true</shortlisted> <created>2023-01-09T11:41:36.184Z</created> <modified>2023-01-09T11:41:36.184Z</modified> <revisionHistory> <revisions> <timestamp>2023-01-09T11:41:36.184Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <billRate> <currency>string</currency> <amount>0</amount> </billRate> <payRate> <currency>string</currency> <amount>0</amount> </payRate> <ratePeriod>HOURLY</ratePeriod> <rateType>TIME</rateType> <rateMarkup>0</rateMarkup> <rejectionReason>string</rejectionReason> <rejectionComment>string</rejectionComment> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </jobApplication> </connect:jobApplications>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
downloadLinkExpiration | string Example: downloadLinkExpiration=PT2H40M How long media download link will remain valid, e.g. PT2H40M for 2 hours 40 min |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobApplications/%7Buid%7D/attachments?downloadLinkExpiration=PT2H40M'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
file required | string File to upload |
filename required | string Uploaded file name |
mediaType required | string Supported media types: RESUME |
const FormData = require('form-data'); const fetch = require('node-fetch'); const formData = new FormData(); formData.append('file', 'string'); formData.append('filename', 'string'); formData.append('mediaType', 'string'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobApplications/%7Buid%7D/attachments'; let options = { method: 'POST', headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'} }; options.body = formData; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (RevisionQueryXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobApplications/queryRevisions?params=SOME_OBJECT_VALUE'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/jobApplications/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
jobPostingId | string |
source | string |
string | |
object (PhoneNumberXmlModel) | |
object (AddressXmlModel) | |
object (NameXmlModel) | |
gender | string |
Array of objects (NationalIdXmlModel) | |
dateOfBirth | string <date> |
preferredStartDate | string <date> |
preferredEndDate | string <date> |
startDate | string <date> |
endDate | string <date> |
object (JobProfileReferenceXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (BusinessSiteXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (CostCentersXmlModel) | |
workdayApplicantId | string |
object (UtmostReferenceEntityXmlModel) | |
stage | string |
jobApplicationStatus | string Enum: "APPROVED" "REJECTED" "RESCINDED" "IN_PROGRESS" "DELETED" "FAILED" "SUPPLIER_DRAFT" |
shortlisted | boolean |
created | string <date-time> |
modified | string <date-time> |
object (RevisionHistoryXmlModel) | |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
ratePeriod | string Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "OTHER" "ON_INVOICE" |
rateType | string Enum: "TIME" "TIME_AND_MATERIALS" "SOW" |
rateMarkup | number |
rejectionReason | string |
rejectionComments | Array of strings |
object (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) | |
Array of objects (CustomFieldXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <jobApplication xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <jobPostingId>string</jobPostingId> <source>string</source> <email>string</email> <phoneNumber> <primary>true</primary> <type>string</type> <deviceType>string</deviceType> <countryCode>string</countryCode> <areaCode>string</areaCode> <number>string</number> </phoneNumber> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <name> <first>string</first> <middle> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </middle> <last>string</last> <secondaryLast> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </secondaryLast> </name> <gender>string</gender> <nationalId> <primary>true</primary> <country>string</country> <countryISO2>string</countryISO2> <type>string</type> <value>string</value> <validUntil>2023-01-09</validUntil> </nationalId> <dateOfBirth>2023-01-09</dateOfBirth> <preferredStartDate>2023-01-09</preferredStartDate> <preferredEndDate>2023-01-09</preferredEndDate> <startDate>2023-01-09</startDate> <endDate>2023-01-09</endDate> <jobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <title>string</title> <summary>string</summary> <mappedExportJobProfile> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </mappedExportJobProfile> </jobProfile> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </classification> <supervisoryOrganization> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supervisoryOrganization> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> <company> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </company> <costCenters xmlns="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <costCenter xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> </costCenters> <workdayApplicantId>string</workdayApplicantId> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <stage>string</stage> <jobApplicationStatus>APPROVED</jobApplicationStatus> <shortlisted>true</shortlisted> <created>2023-01-09T11:41:49.160Z</created> <modified>2023-01-09T11:41:49.160Z</modified> <revisionHistory> <revisions> <timestamp>2023-01-09T11:41:49.160Z</timestamp> <changes> <type>CREATED</type> <fieldPath>string</fieldPath> <value> </value> <previousValue> </previousValue> </changes> </revisions> </revisionHistory> <billRate> <currency>string</currency> <amount>0</amount> </billRate> <payRate> <currency>string</currency> <amount>0</amount> </payRate> <ratePeriod>HOURLY</ratePeriod> <rateType>TIME</rateType> <rateMarkup>0</rateMarkup> <rejectionReason>string</rejectionReason> <rejectionComment>string</rejectionComment> <msp> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </msp> <customField> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <type> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>STRING</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </type> <value>string</value> <objectValue> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value> <name> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </name> <code> <name> <namespaceURI>string</namespaceURI> <localPart>string</localPart> <prefix>string</prefix> </name> <value>string</value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </code> <customFields>string</customFields> </value> <nil>true</nil> <globalScope>true</globalScope> <typeSubstituted>true</typeSubstituted> </objectValue> </customField> </jobApplication>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
Query the invoices
with support for pagination, search and sort
required | object Examples:
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/invoices?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (InvoiceXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/invoices'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/invoices/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
downloadLinkExpiration | string Example: downloadLinkExpiration=PT2H40M How long media download link will remain valid, e.g. PT2H40M for 2 hours 40 min |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/invoices/%7Buid%7D/attachments?downloadLinkExpiration=PT2H40M'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenses?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ExpenseXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:expenses xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <expense> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <engagement> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </engagement> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <number>0</number> <created>2023-01-09T11:44:50.749Z</created> <modified>2023-01-09T11:44:50.749Z</modified> <amount> <currency>string</currency> <amount>0</amount> </amount> <fee> <currency>string</currency> <amount>0</amount> </fee> <tax> <currency>string</currency> <amount>0</amount> </tax> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <description>string</description> <expenseStatus>PENDING</expenseStatus> <rejectReason>string</rejectReason> <person> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </person> <approver> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </approver> <approvalDate>2023-01-09T11:44:50.749Z</approvalDate> <spentDate>2023-01-09</spentDate> <vendor>string</vendor> <notes>string</notes> <previousExpense> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </previousExpense> <semanticVersion>string</semanticVersion> <expenseCategory> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <name>string</name> <expenseCategoryStatus>ENABLED</expenseCategoryStatus> </expenseCategory> <workerVisible>true</workerVisible> </expense> </connect:expenses>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenses/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
number | integer |
created | string <date-time> |
modified | string <date-time> |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
object (AmountXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
description | string |
expenseStatus | string Enum: "PENDING" "REJECTED" "APPROVED" "INVOICED" "DELETED" "DRAFT" |
rejectReason | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
approvalDate | string <date-time> |
spentDate | string <date> |
vendor | string |
notes | string |
object (UtmostReferenceEntityXmlModel) | |
semanticVersion | string |
object (ExpenseCategoryXmlModel) | |
workerVisible | boolean |
<?xml version="1.0" encoding="UTF-8"?> <expense xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <engagement> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </engagement> <supplier> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </supplier> <number>0</number> <created>2023-01-09T11:45:57.222Z</created> <modified>2023-01-09T11:45:57.222Z</modified> <amount> <currency>string</currency> <amount>0</amount> </amount> <fee> <currency>string</currency> <amount>0</amount> </fee> <tax> <currency>string</currency> <amount>0</amount> </tax> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> <description>string</description> <expenseStatus>PENDING</expenseStatus> <rejectReason>string</rejectReason> <person> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </person> <approver> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </approver> <approvalDate>2023-01-09T11:45:57.222Z</approvalDate> <spentDate>2023-01-09</spentDate> <vendor>string</vendor> <notes>string</notes> <previousExpense> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </previousExpense> <semanticVersion>string</semanticVersion> <expenseCategory> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <name>string</name> <expenseCategoryStatus>ENABLED</expenseCategoryStatus> </expenseCategory> <workerVisible>true</workerVisible> </expense>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenseCategories?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ExpenseCategoryXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenseCategories'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenseCategories/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
name | string |
expenseCategoryStatus | string Enum: "ENABLED" "DISABLED" "DELETED" |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/expenseCategories/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/costCenters?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (CostCenterXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:costCenters xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <costCenter> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter> </connect:costCenters>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/costCenters/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
<?xml version="1.0" encoding="UTF-8"?> <costCenter xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </costCenter>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/contracts?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ContractXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/contracts'; let options = {method: 'POST'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/contracts/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
id | integer <int64> |
referenceId | string |
status | string Enum: "DRAFT" "PENDING" "PRE_START" "ACTIVE" "CLOSED" |
sourceName | string |
description | string |
object (UtmostReferenceEntityXmlModel) | |
type | string Enum: "MSA" "SOW" "FREELANCE" |
object (ContractingPartyXmlModel) | |
startDate | string <date> |
endDate | string <date> |
currency | string |
totalBudget | number |
poNumber | string |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
object (ContractPrimaryDocumentXmlModel) | |
Array of objects (MediaXmlModel) | |
object (UtmostReferenceEntityXmlModel) | |
created | string <date-time> |
modified | string <date-time> |
engagementCount | integer |
Array of objects (UtmostReferenceEntityXmlModel) | |
Array of objects (CustomFieldXmlModel) |
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/contracts/%7Buid%7D'; let options = {method: 'PATCH'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/companies?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (CompanyXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:companies xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <company xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <currency>string</currency> <subType>string</subType> </company> </connect:companies>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/companies/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
assignable | boolean |
currency | string |
subType | string |
<?xml version="1.0" encoding="UTF-8"?> <company xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <currency>string</currency> <subType>string</subType> </company>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/classifications?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (ClassificationXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:classifications xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <classification> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <description>string</description> <wid>string</wid> <externalName>string</externalName> <type>EMPLOYEE</type> </classification> </connect:classifications>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/classifications/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
assignable | boolean |
description | string |
wid | string |
externalName | string |
type | string Enum: "EMPLOYEE" "NON_EMPLOYEE" "UNKNOWN" |
<?xml version="1.0" encoding="UTF-8"?> <classification xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <assignable>true</assignable> <description>string</description> <wid>string</wid> <externalName>string</externalName> <type>EMPLOYEE</type> </classification>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/businessSites?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
totalCount | integer <int32> |
totalPages | integer <int32> |
required | Array of objects (BusinessSiteXmlModel) |
<?xml version="1.0" encoding="UTF-8"?> <connect:businessSites xmlns:connect="http://connect.utmost.co/ns/1.0"> <totalCount>0</totalCount> <totalPages>0</totalPages> <businessSite> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite> </connect:businessSites>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/businessSites/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
uid required | string |
uid | string |
referenceCode | string |
Array of objects (ExternalIdXmlModel) | |
displayName | string |
referenceId | string |
status | string Enum: "ACTIVE" "INACTIVE" "DELETED" |
object (AddressXmlModel) | |
object (GeoLocationXmlModel) | |
Array of objects (LocationHierarchyReferenceXmlModel) | |
type | string Enum: "LOCATION_HIERARCHY" "BUSINESS_SITE" "UNKNOWN" |
object (UtmostReferenceEntityXmlModel) | |
assignable | boolean |
source | string |
<?xml version="1.0" encoding="UTF-8"?> <businessSite xmlns="http://connect.utmost.co/ns/1.0"> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> <address> <line1>string</line1> <line2>string</line2> <municipality>string</municipality> <subMunicipality>string</subMunicipality> <region>string</region> <regionCode>string</regionCode> <subRegion>string</subRegion> <postCode>string</postCode> <countryCode>string</countryCode> <countryCodeISO2>string</countryCodeISO2> </address> <geolocation> <latitude>0</latitude> <longitude>0</longitude> </geolocation> <locationHierarchyReference> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <subType>string</subType> </locationHierarchyReference> <type>LOCATION_HIERARCHY</type> <parent> <uid>string</uid> <referenceCode>string</referenceCode> <externalId> <source>string</source> <type>string</type> <value>string</value> </externalId> <displayName>string</displayName> <referenceId>string</referenceId> <status>ACTIVE</status> </parent> <assignable>true</assignable> <source>string</source> </businessSite>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
processUid required | string |
correlationId required | string |
status | string Enum: "COMPLETED" "FAILED" |
source | string |
content | string |
<?xml version="1.0" encoding="UTF-8"?> <connect:taskResolution xmlns:connect="http://connect.utmost.co/ns/1.0"> <status>COMPLETED</status> <source>string</source> <content>string</content> </connect:taskResolution>
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
entity required | string Supported entity types: engagements, timesheets, expenses, workRequests, jobPostings, jobApplications |
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/events/%7Bentity%7D?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
entity required | string Supported entity types: engagements, timesheets, expenses, workRequests, jobPostings, jobApplications |
uid required | string |
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/events/%7Bentity%7D/%7Buid%7D?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
required | object
|
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/eligibilityRequirements?params=SOME_OBJECT_VALUE'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>
const fetch = require('node-fetch'); let url = 'https://tenant.utmost.co/uc/api/connect/v1/eligibilityRequirements/%7Buid%7D'; let options = {method: 'GET'}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
<?xml version="1.0" encoding="UTF-8"?> <connect:errors xmlns:connect="http://connect.utmost.co/ns/1.0"> <error> <code>string</code> <message>string</message> </error> </connect:errors>