Directory API Developer Guide

Directory Search (Global)

The service retrieves the details of all users who match the given search parameters.

Note: User details are retrieved from the Global Directory.

URL structure

HTTP GET: https://{hostname}/api/directory?queryparams

Parameters

Interface

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/directory?org_name=consulting&division=east&jobtitle=admin&given_name=mary&family_name=smith

Response Fields

The number of *'s indicate the parent-child depth.

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<DirectorySearch TotalResults="12">
    <SearchResults>
        <Directory>
            <DivisionName>Administration</DivisionName>
            <Mobile>0412345678</Mobile>
            <OrganizationId>1879048492</OrganizationId>
            <OrganizationName>Majestic Project &amp; Construction
                Management Limited</OrganizationName>
            <TradingName>Majestic Builders</TradingName>
            <JobTitle>Project Coordinator</JobTitle>
            <ProjectAddress>190-210 High Street Buckhurst Grange
                Clearwater Bay New Devonshire 9000, Australia</ProjectAddress>
            <ProjectFax>61922221111</ProjectFax>
            <ProjectPhone>61933332222</ProjectPhone>
            <SearchResultType>USER_TYPE</SearchResultType>
            <UserId>1879049257</UserId>
            <UserName>Ho Tran</UserName>
            <Email>hotran@majestic.com</Email>
        </Directory>
        <Directory>
            <DivisionName>Administration</DivisionName>
            <Mobile>0412345438</Mobile>
            <OrganizationId>1879048511</OrganizationId>
            <OrganizationName>Rand Resources (Pty) Ltd</OrganizationName>
            <TradingName>Rand Resources</TradingName>
            <JobTitle>Project Administrator</JobTitle>
            <ProjectAddress>1564 Miseshi Rd Parklands Kitwe
                2016, Zambia</ProjectAddress>
            <ProjectFax>2602211167</ProjectFax>
            <ProjectPhone>2602211192</ProjectPhone>
            <SearchResultType>USER_TYPE</SearchResultType>
            <UserId>1879049339</UserId>
            <UserName>Mary Karinkis</UserName>
        </Directory>
    </SearchResults>
</DirectorySearch>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The authorizing user (specified in the request header) must have the secured asset to access the Global Directory.

Preferences/Module Setup

Not applicable.

Constraints

As with the Aconex GUI, the service returns only the details of users who are visible to the authorizing user. For example, disabled users will not be returned in the response message.

Directory Search (Project)

The service retrieves the details of all groups and users who match the given search parameters.

Note: Group and user details are retrieved from the specified project's directory.

URL structure

HTTP GET: https://{hostname}/api/projects/{projectid}/directory?{parameters}

Parameters

Interface

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/projects/1879048400/directory?org_name=splice&division=aus&jobtitle=manager&given_name=tim&family_name=jones&show_groups=true

Response Fields

The number of *'s indicate the parent-child depth.

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<DirectorySearch TotalResults="12">
    <SearchResults>
        <Directory>
            <GroupId>1879048371</GroupId>
            <GroupName>Design Meeting Group</GroupName>
            <SearchResultType>GROUP_TYPE</SearchResultType>
        </Directory>
        <Directory>
            <DivisionName>Structural</DivisionName>
            <Mobile>0412345678</Mobile>
            <OrganizationId>1879048494</OrganizationId>
            <OrganizationName>Enzice Consulting Engineers</OrganizationName>
            <TradingName>Enzice Consulting</TradingName>
            <JobTitle>Senior Project Manager</JobTitle>
            <ProjectAddress>21 Spring Street Winchester New
                Devonshire 652141, Australia</ProjectAddress>
            <ProjectFax>61944443333</ProjectFax>
            <ProjectPhone>61955554444</ProjectPhone>
            <SearchResultType>USER_TYPE</SearchResultType>
            <UserId>1879049138</UserId>
            <UserName>William Chadstone</UserName>
            <Email>willam@enzice.com</Email>
        </Directory>
        <Directory>
            <DivisionName>Mechanical</DivisionName>
            <Mobile>0412345679</Mobile>
            <OrganizationId>1879048494</OrganizationId>
            <OrganizationName>Enzice Consulting Engineers</OrganizationName>
            <TradingName>Enzice Consulting</TradingName>
            <JobTitle>Drafter</JobTitle>
            <ProjectAddress>21 Spring Street Winchester New
                Devonshire 652141, Australia</ProjectAddress>
            <ProjectFax>61944443333</ProjectFax>
            <ProjectPhone>61955554444</ProjectPhone>
            <SearchResultType>USER_TYPE</SearchResultType>
            <UserId>1879049256</UserId>
            <UserName>Ahmed Jaffer</UserName>
        </Directory>
    </SearchResults>
</DirectorySearch>

Error Codes Specific to the Service

Prerequisites

Required Permissions

There are no required permissions to use this service.

Preferences/Module Setup

Not Applicable.

Constraints

As with the Aconex GUI, the service returns only the details of users who are visible to the authorizing user. For example, disabled users will not be returned in the response message.

View User Information (Global)

The service retrieves the details of a specified user in the global directory.

Notes:

1. This service differs from the project level user retrieval in that one can request the information of a user that exists within that Aconex instance that the request is being directed to irrespective of the project that the target user is on.
2. The client making the request must also have the necessary secured asset to access the global directory to be able to perform the request.

URL structure

GET https://{hostname}/api/users/{userid}

Parameters

Interface

Request Fields

Not applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/users/1879048221

Response Fields

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<User>
    <Division/>
    <Fax>61396001111</Fax>
    <Mobile/>
    <OrganizationId>1879048570</OrganizationId>
    <OrganizationName>LockedOrg</OrganizationName>
    <OrganizationPostalAddressLine>696 Bourke St</OrganizationPostalAddressLine>
    <OrganizationPostalCity>Melbs</OrganizationPostalCity>
    <OrganizationPostalCountry>Australia</OrganizationPostalCountry>
    <OrganizationPostalPostCode>3000</OrganizationPostalPostCode>
    <OrganizationPostalState>VIC</OrganizationPostalState>
    <Phone>61396001111</Phone>
    <JobTitle/>
    <UserPostalAddressLine>696 Bourke St</PostalAddressLine>
    <UserPostalCity>Melbs</PostalCity>
    <UserPostalCountry>Australia</PostalCountry>
    <UserPostalPostCode>3000</PostalPostCode>
    <UserPostalState>VIC</PostalState>
    <UserFirstName>Locked</UserFirstName>
    <UserId>1879049450</UserId>
    <UserLastName>Organization</UserLastName>
    <UserTitle>Mr</UserTitle>
</User>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The authorizing user (specified in the request header) must have the secured asset to view user details in the global directory.

Preferences/Module Setup

Not applicable.

Constraints

As with the Aconex GUI, the service returns only the details of users who are visible to the authorizing user. For example, details of a disabled user will not be returned in the response message.

View User Information (Project)

The service retrieves the details of a specified user in the project directory.

Note: This request differs from the global level user retrieval in that the project that the user must be specified and the user making the request must have access to the specified project.

URL structure

HTTP GET: https://{hostname}/api/projects/{projectid}/users/{userid}

Parameters

Interface

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/projects/1879048400/users/1879048221

Response Fields

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<User>
    <Division/>
    <Fax>61396001111</Fax>
    <Mobile/>
    <OrganizationId>1879048570</OrganizationId>
    <OrganizationName>LockedOrg</OrganizationName>
    <OrganizationPostalAddressLine>696 Bourke St</OrganizationPostalAddressLine>
    <OrganizationPostalCity>Melbs</OrganizationPostalCity>
    <OrganizationPostalCountry>Australia</OrganizationPostalCountry>
    <OrganizationPostalPostCode>3000</OrganizationPostalPostCode>
    <OrganizationPostalState>VIC</OrganizationPostalState>
    <Phone>61396001111</Phone>
    <JobTitle/>
    <UserPostalAddressLine>696 Bourke St</UserPostalAddressLine>
    <UserPostalCity>Melbs</UserPostalCity>
    <UserPostalCountry>Australia</UserPostalCountry>
    <UserPostalPostCode>3000</UserPostalPostCode>
    <UserPostalState>VIC</UserPostalState>
    <UserFirstName>Locked</UserFirstName>
    <UserId>1879049450</UserId>
    <UserLastName>Organization</UserLastName>
    <UserTitle>Mr</UserTitle>
</User>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The user performing the request must have access to the project that the target user is on.

Preferences/Module Setup

Not applicable.

Constraints

As with the Aconex GUI, the service returns only the details of users who are visible to the authorizing user. For example, details of a disabled user will not be returned in the response message.

View Own User Information

The service retrieves the details of the user making a request.

Notes:

1. By using the username provided in the authentication credentials, the API will retrieve the details of the authenticated user and return them in the format provided by other View User API services (with additional username).
2. This service may be useful when you have access to only a user's credentials, and require more details to construct API requests, e.g. userId.
3. Another use case for this call is when you have access token and want to discover corresponding username.

URL structure

HTTP GET: https://{hostname}/api/user

Parameters

Interface

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/user

Response Fields

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<User>
    <Division/>
    <Fax>61396001111</Fax>
    <Mobile/>
    <OrganizationId>1879048570</OrganizationId>
    <OrganizationName>LockedOrg</OrganizationName>
    <OrganizationPostalAddressLine>696 Bourke St</OrganizationPostalAddressLine>
    <OrganizationPostalCity>Melbs</OrganizationPostalCity>
    <OrganizationPostalCountry>Australia</OrganizationPostalCountry>
    <OrganizationPostalPostCode>3000</OrganizationPostalPostCode>
    <OrganizationPostalState>VIC</OrganizationPostalState>
    <Phone>61396001111</Phone>
    <JobTitle/>
    <UserPostalAddressLine>696 Bourke St</UserPostalAddressLine>
    <UserPostalCity>Melbs</UserPostalCity>
    <UserPostalCountry>Australia</UserPostalCountry>
    <UserPostalPostCode>3000</UserPostalPostCode>
    <UserPostalState>VIC</UserPostalState>
    <UserFirstName>Locked</UserFirstName>
    <UserId>1879049450</UserId>
    <UserLastName>Organization</UserLastName>
    <UserTitle>Mr</UserTitle>
    <UserName>poleary</UserName>
</User>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The user performing the request must have access to API web services.

Preferences/Module Setup

Not applicable.

Constraints

Not applicable.

View Organization Information

The service retrieves the details of an organization.

Note: Organization details are retrieved from the Global Directory.

URL structure

HTTP GET: https://{hostname}/api/organizations/{organizationid}

Parameters

None.

Interface

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/organizations/1879048221

Response Fields

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<Organization>
    <ABN>2223334444</ABN>
    <DeliveryAddressLine>27 Short Street</DeliveryAddressLine>
    <DeliveryCity>Spring Hill</DeliveryCity>
    <DeliveryCountry>Australia</DeliveryCountry>
    <DeliveryPostcode>4003</DeliveryPostcode>
    <DeliveryState>Queensland</DeliveryState>
    <OrganizationDivisions/>
    <EmailAddress>info@aconex.com</EmailAddress>
    <Fax>07554555555</Fax>
    <OrganizationCode>Briscon</OrganizationCode>
    <OrganizationId>1879048221</OrganizationId>
    <OrganizationName>Brisbane Concretors PL</OrganizationName>
    <Phone>07554555555</Phone>
    <PostalAddressLine>27 Short Street</PostalAddressLine>
    <PostalCity>Spring Hill</PostalCity>
    <PostalCountry>Australia</PostalCountry>
    <PostalPostCode>4003</PostalPostCode>
    <PostalState>Queensland</PostalState>
    <OrganizationRoles>
        <Role>Consultant</Role>
        <Role>Subcontractor</Role>
    </OrganizationRoles>
    <TradingName>Brisbane Concretors</TradingName>
    <WebsiteAddress/>
</Organization>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The authorizing user (specified in the request header) must have the secured asset to View Organization Details in the Global Directory.

Preferences/Module Setup

Not applicable.

Constraints

As with the Aconex GUI, the service returns only the details of organizations that are visible to the authorizing user. For example, details of a disabled organization will not be returned in the response message.

List Users in Group

The service retrieves the details of users who belong to a project group.

URL structure

HTTP GET: https://{hostname}/api/projects/{projectid}/groups/{groupid}

Parameters

Interface

Request Fields

Not applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/organizations/1879048221

Response Fields

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<UserResults TotalResults="2">
    <SearchResults>
        <User>
            <Division/>
            <Fax>61944443333</Fax>
            <Mobile/>
            <OrganizationId>1879048494</OrganizationId>
            <OrganizationName>Enzice Consulting Engineers</OrganizationName>
            <OrganizationPostalAddressLine>21 Spring Street
            </OrganizationPostalAddressLine>
            <OrganizationPostalCity>Winchester</OrganizationPostalCity>
            <OrganizationPostalCountry>Australia</OrganizationPostalCountry>
            <OrganizationPostalPostCode>9000</OrganizationPostalPostCode>
            <OrganizationPostalState>New Devonshire</OrganizationPostalState>
            <Phone>61955554444</Phone>
            <JobTitle>Lead Engineer</JobTitle>
            <UserFirstName>Alice</UserFirstName>
            <UserId>1879049134</UserId>
            <UserLastName>Templeton</UserLastName>
            <UserPostalAddressLine>21 Spring Street </UserPostalAddressLine>
            <UserPostalCity>Winchester</UserPostalCity>
            <UserPostalCountry>Australia</UserPostalCountry>
            <UserPostalPostCode>652141</UserPostalPostCode>
            <UserPostalState>New Devonshire</UserPostalState>
            <UserTitle>Ms</UserTitle>
        </User>
        <User>
            <Division>Developer</Division>
            <Fax>61922223333</Fax>
            <Mobile/>
            <OrganizationId>1879048491</OrganizationId>
            <OrganizationName>VIP Group</OrganizationName>
            <OrganizationPostalAddressLine>P.O. Box 35</OrganizationPostalAddressLine>
            <OrganizationPostalCity>Clearwater Bay</OrganizationPostalCity>
            <OrganizationPostalCountry>Australia</OrganizationPostalCountry>
            <OrganizationPostalPostCode>658811</OrganizationPostalPostCode>
            <OrganizationPostalState>New Devonshire</OrganizationPostalState>
            <Phone>61911112222</Phone>
            <JobTitle>Associate Director</JobTitle>
            <UserFirstName>Peter</UserFirstName>
            <UserId>1879049119</UserId>
            <UserLastName>Chitwood</UserLastName>
            <UserPostalAddressLine>P.O. Box 35</UserPostalAddressLine>
            <UserPostalCity>Clearwater Bay</UserPostalCity>
            <UserPostalCountry>Australia</UserPostalCountry>
            <UserPostalPostCode>658811</UserPostalPostCode>
            <UserPostalState>New Devonshire</UserPostalState>
            <UserTitle>Mr</UserTitle>
        </User>
    </SearchResults>
</UserResults>

Error Codes Specific to the Service

Prerequisites

Required Permissions

There are no required permissions to use this service.

Preferences/Module Setup

Not applicable.

Constraints

As with the Aconex GUI, the service returns only the details of users who are visible to the authorizing user. For example, disabled users will not be returned in the response message.

Get Organization Logo

The service returns the current logo associated with the specified organization.

URL Structure

HTTP GET: https://{hostname}/api/organization/logo?{parameters}

Parameters

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/organization/logo?organization_id=15

Response Fields

Not applicable. The response is a binary stream of the logo associated with the organization.

Sample response

Not applicable.

Error Codes Specific to the Service

Prerequisites

Required Permissions

None

Preferences/Module Setup

Not applicable.

Constraints

None

Create New User

The service creates a new user for an organization.

URL structure

HTTP POST: https://{hostname}/api/organizations/{organizationid}/users

Parameters

Interface

HTTP Request Header variables

As the request body has content that is multipart/mixed, a boundary identifier must be specified in the request header (as a key/value pair). This boundary is used to separate data of different types, e.g. text and binary.

Sample Header

Content-Type=multipart/mixed; boundary="myboundary"

Request Fields

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional.

The number of *'s indicate the parent-child depth.

* Denotes a mandatory field

Using part boundaries

Boundaries are marked using

The exception to this is the final boundary in the POST content, which terminates with

Refer to the sample request(s) below for further detail.

Sample request

Response Fields

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

Sample response

Error Codes Specific to the Service

Prerequisites

Required Permissions

The authorizing user (specified in the request header) must have been granted the secured asset to create user.

Preferences/Module Setup

N/A

Constraints

The request will fail if the specified project is not activated.

The request will fail if the authorizing user does not have access to the specified project.

The request will fail if the division is not owned by the organization.

List Organisation Users

The service provides a list of the users within an organisation.

URL structure

HTTP GET: https://{hostname}/api/organizations/{organizationId}/users[?page_size={pageSizeValue}&page_number={pageNumberValue}]

Query Parameters

Interface

HTTP Request Header variables

Sample Request

https://au1.aconex.com/api/organizations/123456789/users

https://au1.aconex.com/api/organizations/123456789/users?page_size=30&page_number=2

Response Fields

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

Sample response

<OrganizationUsers TotalResultsOnPage="7" TotalResults="33" TotalPages="5" PageSize="7" CurrentPage="1">

    <SearchResults>
        <User>
            <AccessEnabled>ENABLED</AccessEnabled>
            <GuestUser>N</GuestUser>
            <LastLogon>2022-02-02T11:52:38.593+11:00</LastLogon>
            <Locked>LOCKED</Locked>
            <OrganizationAdminRole>Y</OrganizationAdminRole>
            <OrganizationId>1879048492</OrganizationId>
            <OrganizationName>Majestic Project &amp; Construction Management Limited</OrganizationName>
            <Email>Patrick@Majestic.com</Email>
            <UserFirstName>Patrick</UserFirstName>
            <UserId>1879049107</UserId>
            <UserLastName>O'Leary</UserLastName>
        </User>

        <User>

            <AccessEnabled>ENABLED</AccessEnabled>
            <GuestUser>N</GuestUser>
            <LastLogon>N/A</LastLogon>
            <Locked>UNLOCKED</Locked>
            <OrganizationAdminRole>N</OrganizationAdminRole>
            <OrganizationId>1879048492</OrganizationId>
            <OrganizationName>Majestic Project &amp; Construction Management Limited</OrganizationName>
            <Email>document@MajesticController.com</Email>
            <UserFirstName>Document</UserFirstName>
            <UserId>1879049121</UserId>
            <UserLastName>Controller</UserLastName>
        </User>
    </SearchResults>
</OrganizationUsers>

Error Codes Specific to the Service

Prerequisites

Required Permissions

The authorizing user (specified in the Authorization header) must have been granted Organisation Administrator role for the Organisation.

Preferences/Module Setup

N/A

Constraints

The request will fail if the authorizing user is not a member of the organisation.

The request will fail if the authorizing user is not an Administrator of the organisation.

Enable/Disable Users

Ability to disable/enable (an) existing active user(s) via external API without the need to login to Aconex

URL structure

HTTP POST: https://{hostname}/api/userstatus

Field parameters

Sample request

curl --location --request POST 'https://localhost:8443/api/userstatus' \

--header 'Authorization: Basic YWNueEFkbWluOmFjMG4zeDcy' \
--header 'Content-Type: application/xml' \
--header 'Cookie: com.aconex.locale=en_AU' \
--data-raw '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Users>
<User>
    <id>1879049121</id>
    <loginName>jdoe</loginName>
    <enabled>true</enabled>
</User>
<User>
    <id>1879049135</id>
    <loginName>katey</loginName>
    <enabled>true</enabled>
</User>
</Users>'        

Sample response

HTTP 200 OK

Error Codes specific to the service

Prerequisites

Required Permissions

• The authorising user must be an Org Admin and should belong to the same Organization of the Users.
• A user cannot enable/disable oneself.

Create Mailing Groups in Project

This API is available from the February 2024 release. See release notes.

This service creates mailing Groups in Project using provided project ID

URL structure

HTTP POST - Create Mailing Groups in Project 

Parameters

Input Payload Template

Input Payload template to Update user role name and properties

Single Group creation {
"groups": [
{
"groupName":,
"isLocked":
}
]
}

or 

Multiple group Creation

{
"groups": [
{
"groupName": ,
"isLocked": ""
},
{
"groupName": ,
"isLocked":
},
{
"groupName": ,
"isLocked":
},
{
"groupName": ,
"isLocked":
}
]
}

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as empty body

 with HTTP status code 201 Created

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459

Request Body -Json

{
"groups": [
{
"groupName": "TeamMarvel1",
"isLocked": "false"
}
]
}

or

{
"groups": [
{
"groupName": "TeamMarvel",
"isLocked": "false"
},
{
"groupName": "Team DC",
"isLocked": "false"
},
{
"groupName": "QA regression",
"isLocked": "true"
},
{
"groupName": "BedRocks",
"isLocked": "true"
}
]
}

Sample Response with HTTP status code 201 Created

Error Codes Specific to the Service

Delete Mailing Group in Project

This API is available from the February 2024 release. See release notes.

This service deletes  mailing Groups in Project using provided project ID

URL structure

HTTP DELETE - Delete Mailing Groups in Project 

Parameters

Input Payload Template

Input Payload template to Update user role name and properties

   {

  "groupName": "",
  "groupId": ""
}

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

groupID

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as 

{
"message": "Group Deleted Successfully",
"status": "OK"
}

 with HTTP status code 200 OK

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459

Request Body -Json

{
    "groupName": "Architetural Group"

    "groupId": 1879048366,
  
}

Sample Response 

{
"message": "Group Deleted Successfully",
"status": "OK"
}

with HTTP status code 200 OK

Error Codes Specific to the Service

Read Mailing Groups in Project

This API is available from the February 2024 release. See release notes.

This service fetches Mailing Groups in Project using provided project ID

URL structure

HTTP GET -Fetch Mailing Groups in Project 

Parameters

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as 

 with HTTP status code 200 Ok

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459

Sample Response below :

{
"mailingGroups": [
{
"groupId": 1879053401,
"groupName": "Copy Mailing Group (TEST_1+2-9$) CHECK SPACE CONST",
"groupOwnerUserId": 1879053360,
"users": [
{
"userId": 1879053360,
"userName": "ashsree"
},
{
"userId": 1879054464,
"userName": "2312.mssql"
},
{
"userId": 1879053398,
"userName": "marvel.crash"
},
{
"userId": 1879053399,
"userName": "signage.crash"
}
],
"locked": false
},
{
"groupId": 1879053404,
"groupName": "FINAL ADDITION OF MAILING GROUPS IS IT OK INCLUDED",
"groupOwnerUserId": 1879053360,
"users": [
{
"userId": 1879053391,
"userName": "sandra.pearl"
},
{
"userId": 1879053379,
"userName": "windsor.manor"
},
{
"userId": 1879053398,
"userName": "marvel.crash"
}
],
"locked": true
},
{
"groupId": 1879053439,
"groupName": "TEST2",
"groupOwnerUserId": 1879053360,
"users": null,
"locked": true
}
]
}

 with HTTP status code 200 Ok

Error Codes Specific to the Service

Update Mailing Group in Project

This API is available from the February 2024 release. See release notes.

This service updates  mailing Groups in Project using provided project ID

URL structure

HTTP PUT - Update Mailing Groups in Project 

Parameters

Input Payload Template

Input Payload template to Update user role name and properties

{

    "groupId": ,
    "groupName": "",
    "newGroupName": "",
    "locked":
}

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

groupID

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as

{
"message": "Group details updated successfully",
"status": "OK"
}

 with HTTP status code 200 OK

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459

Request Body -Json

{

    "groupId": 1879048366,
    "groupName": "Architetural Group",
    "newGroupName": "Architetural Group123",
    "locked": false
}

Sample Response

{
"message": "Group details updated successfully",
"status": "OK"
}

 with HTTP status code 20O OK

Error Codes Specific to the Service

Add users to the Mailing Groups in Project

This API is available from the February 2024 release. See release notes.

This service add users in the mailing Groups in Project using provided project ID

URL structure

HTTP PUT -Update-adding users in  Mailing Groups in Project 

Parameters

Input Payload Template

Input Payload template to Update user role name and properties

{

   {
    "addOrRemoveUsersGroupRequest": [
        {
            "groupId":,
            "userId":[]
        },
        {
            "groupName": "",
            "userId":[]
        }
    ]
}
}

or 

{

   {
    "addOrRemoveUsersGroupRequest": [
        {
            "groupId":,
            "userId":[]
        }
    ]
}
}

or 
{
   {
    "addOrRemoveUsersGroupRequest": [
       
        {
            "groupName": "",
            "userId":[]
        }
    ]
}
}

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

groupID

groupID 
mandatory

groupID
mandatory

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as

{
"message": "All Users added successfully",
"status": "OK"
}

or 

{

"message":"The given User ID(s) - [] added successfully. The given User ID(s) - [] is either invalid or not part of the project. Please check and update the request",

"status":"OK"

}

 with HTTP status code 200 OK 

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459/addUsers

Request Body -Json

{

    "addOrRemoveUsersGroupRequest": [
        {
            "groupId": 1879048366,
            "userId":[1879049272, 1879049129, 123]
        },
        {
            "groupName": "Design Meeting Group",
            "userId":[1879049119, 1879049120]
        }
    ]
}

Sample Response 

An  response body as

{
"message": "Users added successfully",
"status": "OK"
}

or 

{

"message":"The given User ID(s) - [18790533272] added successfully. The given User ID(s) - [1879053360, 1879053391] is either invalid or not part of the project. Please check and update the request",

"status":"OK"

}

with HTTP status code 20O OK

Error Codes Specific to the Service

Remove users from the Mailing Groups in Project

This API is available from the February 2024 release. See release notes.

This service remove users in the mailing Groups in Project using provided project ID

URL structure

HTTP PUT - Update - Removing users Mailing Groups in Project 

Parameters

Input Payload Template

Input Payload template to Update user role name and properties

{

   {
    "addOrRemoveUsersGroupRequest": [
        {
            "groupId":,
            "userId":[]
        },
        {
            "groupName": "",
            "userId":[]
        }
    ]
}
}

or 

{

   {
    "addOrRemoveUsersGroupRequest": [
        {
            "groupId":,
            "userId":[]
        }
    ]
}
}

or 
{
   {
    "addOrRemoveUsersGroupRequest": [
       
        {
            "groupName": "",
            "userId":[]
        }
    ]
}
}

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

groupID

groupID Mandatory

Expected Response

Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear in the response.

The number of *'s indicate the parent-child depth.

An  response body as

{
"message": "All Users removed successfully",
"status": "OK"
}

or 

{

"message":"The given User ID(s) - [] removed successfully. The given User ID(s) - [] is either invalid or not part of the project. Please check and update the request",

"status":"OK"

}

 with HTTP status code 200 OK 

Examples/Samples

Sample Request

• Create a user role in a project
  Sample request for creating a user role in project

  https://au1.aconex.com/api/mailinggroups/1879053459/removeUsers

Request Body -Json

{

    "addOrRemoveUsersGroupRequest": [
        {
            "groupId": 1879048366,
            "userId":[1879049272, 1879049129, 123]
        },
        {
            "groupName": "Design Meeting Group",
            "userId":[1879049119, 1879049120]
        }
    ]
}

Sample Response 

An  response body as

{
"message": "Users removed successfully",
"status": "OK"
}

or 

{

"message":"The given User ID(s) - [18790533272] removed successfully. The given User ID(s) - [1879053360, 1879053391] is either invalid or not part of the project. Please check and update the request",

"status":"OK"

}

with HTTP status code 20O OK

Error Codes Specific to the Service