GET api/Project/GetProjectByExternalCode/{id}

Gets the project by external code.

Access

Requires authentication.

Requires SSL.

Request Information

Parameters

NameDescriptionAdditional information
id 
The external code.

Define this parameter in the request URI.

Response Information

Response body formats

application/xml, text/xml

Sample: 
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ResponseCode>1</ResponseCode>
  <ResponseDescription>sample string 2</ResponseDescription>
  <MethodExpirationDate>2025-12-14T03:40:31.2803263+01:00</MethodExpirationDate>
  <ResponseObject>
    <Id>1</Id>
    <Readonly>true</Readonly>
    <ProjectName>sample string 6</ProjectName>
    <ExternalCode>sample string 7</ExternalCode>
    <ProjectTypeId>8</ProjectTypeId>
    <TransportDescription1>sample string 9</TransportDescription1>
    <TransportDescription2>sample string 10</TransportDescription2>
    <TransportDescription3>sample string 11</TransportDescription3>
    <TransportDescription4>sample string 12</TransportDescription4>
    <CurrentUserProjectRoleString>sample string 1</CurrentUserProjectRoleString>
    <ModifiedAt>2025-12-14T03:40:31.2803263+01:00</ModifiedAt>
    <SalesRepName>sample string 2</SalesRepName>
    <SalesRepPhone>sample string 3</SalesRepPhone>
    <SalesRepEmail>sample string 4</SalesRepEmail>
    <CustomerProjectId>sample string 5</CustomerProjectId>
  </ResponseObject>
</ApiResponse>

application/json, text/json

Sample: 
{
  "ResponseCode": 1,
  "ResponseDescription": "sample string 2",
  "MethodExpirationDate": "2025-12-14T03:40:31.2803263+01:00",
  "ResponseObject": {
    "CurrentUserProjectRoleString": "sample string 1",
    "ModifiedAt": "2025-12-14T03:40:31.2803263+01:00",
    "SalesRepName": "sample string 2",
    "SalesRepPhone": "sample string 3",
    "SalesRepEmail": "sample string 4",
    "CustomerProjectId": "sample string 5",
    "ProjectName": "sample string 6",
    "ExternalCode": "sample string 7",
    "ProjectTypeId": 8,
    "TransportDescription1": "sample string 9",
    "TransportDescription2": "sample string 10",
    "TransportDescription3": "sample string 11",
    "TransportDescription4": "sample string 12",
    "Id": 1,
    "Readonly": true
  }
}