NextGen APIs

Resources: Revision 1 (2024 W1)

Disclaimer on Loans

Loans are currently not handled by the Resources APIs. Please make use of the Operations Center attribute filter to handle Resources that might have Loans.

Resource Fields

PII

SI

Field

Description

Format



id (resourceId)

The "id" refers to the identifier of a specific entity within the context of the API. It is automatically generated, does not change, and can only be accessed in read mode. It serves as a search filter to locate data based on a list of values.

This field is also named “resourceId“ when used as path parameter.

 

warning


surname

surname

 Max Lenght: 40

warning


name

name

 Max Lenght: 40

warning


birthDate

birth date

Date object



startDate

start date

Date object



endDate

end date

Date object

warning


email

email

Max Lenght: 255

Format: RFC 5322 email address format



operationCenterId

operation center id

Operation Centers: Revision 1 (2024 W1)

 

warning


mobilePhone

mobile phone number

 Max Length: 20



startAddressId

start address Id

Resource Address: Revision 1 (2024 W1)

 



endAddressId

end address id

Resource Address: Revision 1 (2024 W1)

 

warning


identificationNumber

unique code identifying the resource within the enterprise

Max Length: 40



resourceTypeId

resource type id

Resource Types: Revision 1 (2024 W1)

 



color

resource color to represent it on the daily plan

Max Length: 10

Format: Hexadecimal i.e. #FF990C



vehicleId

vehicle id

Vehicles: Revision 1 (2024 W1)

 



order

ordering

Max Length: 10



singleTeamId

single team id connected to the resource

Teams: Revision 1 (2024 W1)

 



workCenterId

work center id

Work Centers: Revision 1 (2024 W1)

 



loan

A flag that checks whether the Resource is on loan. When true then the Resource is a copy and it’s assigned to an Operations Center different than the original Resource. When false or null then the Resource is the original Resource with its native Operations Center.




loanSourceId

Id of the original resource from which the loan is made




copyCompetencies

Flag that checks whether the competencies need to be copied from the original source to all the related resource on loan


API list