Retrieves company office addresses for a specific sub-contractor.
Qualifications
GET
qualifications/{companyId}/company-office-addresses
Retrieve a general list of company office addresses for a specific sub-contractor, processed in TradeTapp and based on the data input by a sub-contractor during the completion of their questionnaire.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/tradetapp/v2/qualifications/{companyId}/company-office-addresses |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
* Required
Request
Query String Parameters
cursorState string | An opaque cursor token that identifies where the next page of paginated results should start. It is returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.
Omit this parameter to initiate a paginated request or to restart pagination. |
limit int | The maximum number of records that the endpoint may return per page.
Note that a returned page may contain fewer records than the limit under either of these conditions:
Default value: |
Response
HTTP Status Code Summary
200 OK | OK |
400 Bad Request | The parameters of the requested operation are invalid. |
401 Unauthorized | The provided bearer token is not valid. |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation. |
404 Not Found | The requested resource could not be found. |
429 Too Many Requests | Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait. |
500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (200)
Expand all
pagination object | The pagination details of a nested response. |
limit int | The maximum number of records to return per page.
Note that a returned page may contain fewer records than the limit under either of these conditions:
Default value: |
cursorState string | An opaque cursor token that identifies where the next page of paginated results should start. It is returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.
Omit this parameter to initiate a paginated request or to restart pagination. |
totalResults int | The total number of records returned overall. |
nextUrl string | Link that will return the next page of data. If not included, this is the last page of data. It is allowed that a page may be empty but contain a next paging link. Consumers should stop paging only when the next link no longer appears. |
previousUrl string | Link that will return the previous page of data. If the previous link is supported, then the absence indicates the first page of results. |
results array: object | |
isMainOffice boolean | Indicates if this office is the sub-contractor’s main office. |
address1 string | The first line of the sub-contractor office’s street address. |
address2 string | The second line of the sub-contractor office’s street address. |
city string | The sub-contractor office’s city. |
state string | The sub-contractor office’s state. |
zipCode string | The sub-contractor office’s zip code. |
Example
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/tradetapp/v2/qualifications/:companyId/company-office-addresses' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"cursorState": "cD0xMTA4Ng==",
"totalResults": 120,
"nextUrl": "",
"previousUrl": ""
},
"results": [
{
"isMainOffice": true,
"address1": "925 Mission Street",
"address2": "Suite 109",
"city": "San Francisco",
"state": "California",
"zipCode": "94103"
}
]
}
Show More