API Documentation

GET Requests 

curl -X GET -H ": " "https://scaffolding-readonly-development-apim.azure-api.net/api/requests?since=2021-01-01 00:00:00"
GET https://scaffolding-readonly-development-apim.azure-api.net/api/requests HTTP/1.1
Host: scaffolding-readonly-development-apim.azure-api.net
:
Header Params SubscriptionId Required parameter to allow the API to process the requested data
Query Params since (DateTime UTC) Optional parameter to retrieve data created or changed since the given value
Status 200 OK
Content-Type application/json; charset=utf-8
Content-Encoding gzip 
[
    {
        "requestId": "string",
        "vendorName": "string",
        "areaCode": "string",
        "sapSystemCode": "string ("NULLABLE")",
        "invoiceApproverEmail": "string",
        "workAuthorization": "string ("NULLABLE")",
        "workOrder": "string",
        "workAuthorizationRequestor": "string ("NULLABLE")",
        "contact": "string ("NULLABLE")",
        "authorName": "string",
        "authorEmail": "string",
        "hierarchyOfFacilities": [
            {
                "level": "number",
                "name": "string"
            }
        ],
        "locationDescription": "string ("NULLABLE")",
        "exxonMobilComments": "string ("NULLABLE")",
        "timeMaterialPurchaseOrder": "string ("NULLABLE")",
        "unitPricePurchaseOrder": "string ("NULLABLE")",
        "scaffoldsCount": "number" (DEFAULT: 0),
        "scaffoldIds": "string[]" (DEFAULT: []),
        "isBreakIn": "boolean ("DEFAULT: False")",
        "useTimeMaterialPurchaseOrder": "boolean ("DEFAULT: False")",
        "fulfilledDate": "date/time ("NULLABLE")",
        "requestedStartDate": "date/time",
        "requestedEndDate": "date/time",
        "modifiedDate": "date/time ("NULLABLE")",
    }
]

GET Request By Id 

curl -X GET -H ": " "https://scaffolding-readonly-development-apim.azure-api.net/api/requests/{{id}}"
GET https://scaffolding-readonly-development-apim.azure-api.net/api/requests/{{id}} HTTP/1.1
Host: scaffolding-readonly-development-apim.azure-api.net
:
Header Params SubscriptionId Required parameter to allow the API to process the requested data
Status 200 OK
Content-Type application/json; charset=utf-8
Content-Encoding gzip 
{
        "requestId": "string",
        "vendorName": "string",
        "areaCode": "string",
        "sapSystemCode": "string ("NULLABLE")",
        "invoiceApproverEmail": "string",
        "workAuthorization": "string ("NULLABLE")",
        "workOrder": "string",
        "workAuthorizationRequestor": "string ("NULLABLE")",
        "contact": "string ("NULLABLE")",
        "authorName": "string",
        "authorEmail": "string",
        "hierarchyOfFacilities": [
            {
                "level": "number",
                "name": "string"
            }
        ],
        "locationDescription": "string ("NULLABLE")",
        "exxonMobilComments": "string ("NULLABLE")",
        "timeMaterialPurchaseOrder": "string ("NULLABLE")",
        "unitPricePurchaseOrder": "string ("NULLABLE")",
        "scaffoldsCount": "number" (DEFAULT: 0),
        "scaffoldIds": "string[]" (DEFAULT: []),
        "isBreakIn": "boolean ("DEFAULT: False")",
        "useTimeMaterialPurchaseOrder": "boolean ("DEFAULT: False")",
        "fulfilledDate": "date/time ("NULLABLE")",
        "requestedStartDate": "date/time",
        "requestedEndDate": "date/time",
        "modifiedDate": "date/time ("NULLABLE")",
}

GET Scaffolds 

curl -X GET "https://scaffolding-readonly-development-apim.azure-api.net/api/scaffolds?since=2021-01-01 00:00:00"
GET https://scaffolding-readonly-development-apim.azure-api.net/api/scaffolds HTTP/1.1
Host: scaffolding-readonly-development-apim.azure-api.net
:
Header Params SubscriptionId Required parameter to allow the API to process the requested data
Query Params since (DateTime UTC) Optional parameter to retrieve data created or changed since the given value
Status 200 OK
Content-Type application/json; charset=utf-8
Content-Encoding gzip
Vary Accept-Encoding 
[
    {
        "scaffoldId": "string",
        "requestId": "string",
        "scaffoldStatus": "string ("Enums": "on-rent", "scoped", "inspection-needed", "inspection-expired", "demo-requested", "demoed")",
        "scaffoldTag": "string ("NULLABLE")",
        "scaffoldType": "string",
        "scaffoldLastInspector": "string ("NULLABLE")",
        "height": "number",
        "width": "number",
        "length": "number",
        "legs": "number",
        "elevation": "number",
        "billableLegFeet": "number",
        "deckCount": "number",
        "deckArea": "number",
        "modifyPurchaseOrderType": "string ("Enums": "UPPO", "TMPO") ("NULLABLE")",
        "modifyPurchaseOrder": "string ("NULLABLE")",
        "modifyComments": "string ("NULLABLE")",
        "offRentPurchaseOrderType": "string ("Enums": "UPPO", "TMPO") ("NULLABLE")",
        "offRentPurchaseOrder": "string ("NULLABLE")",
        "offRentComments": "string ("NULLABLE")",
        "coordinates": {
            "latitude": "number",
            "longitude": "number"
        },
        "craneRequired": "boolean ("DEFAULT: False")",
        "naturalDisasterConcern": "boolean ("DEFAULT: False")",
        "skidPanRequired": "boolean ("DEFAULT: False")",
        "createdOn": "date/time",
        "updatedOn": "date/time",
        "latestInspectionDate": "date/time ("NULLABLE")",
        "buildDate": "date/time ("NULLABLE")",
        "offRentedOn": "date/time ("NULLABLE")",
        "fulfilledDate": "date/time ("NULLABLE")",
        "demoedOn": "date/time ("NULLABLE")",
        "earliestDemoDate": "date/time ("NULLABLE")",
        "latestDemoDate": "date/time ("NULLABLE")",
        "modifyDate": "date/time ("NULLABLE")",
    }
]

GET Scaffold By Id 

curl -X GET -H ": " "https://scaffolding-readonly-development-apim.azure-api.net/api/scaffolds/{{id}}"
GET https://scaffolding-readonly-development-apim.azure-api.net/api/scaffolds/{{id}} HTTP/1.1
Host: scaffolding-readonly-development-apim.azure-api.net
:
Header Params SubscriptionId Required parameter to allow the API to process the requested data
Status 200 OK
Content-Type application/json; charset=utf-8
Content-Encoding gzip 
{
        "scaffoldId": "string",
        "requestId": "string",
        "scaffoldStatus": "string ("Enums": "on-rent", "scoped", "inspection-needed", "inspection-expired", "demo-requested", "demoed")",
        "scaffoldTag": "string ("NULLABLE")",
        "scaffoldType": "string",
        "scaffoldLastInspector": "string ("NULLABLE")",
        "height": "number",
        "width": "number",
        "length": "number",
        "legs": "number",
        "elevation": "number",
        "billableLegFeet": "number",
        "deckCount": "number",
        "deckArea": "number",
        "modifyPurchaseOrderType": "string ("Enums": "UPPO", "TMPO") ("NULLABLE")",
        "modifyPurchaseOrder": "string ("NULLABLE")",
        "modifyComments": "string ("NULLABLE")",
        "offRentPurchaseOrderType": "string ("Enums": "UPPO", "TMPO") ("NULLABLE")",
        "offRentPurchaseOrder": "string ("NULLABLE")",
        "offRentComments": "string ("NULLABLE")",
        "coordinates": {
            "latitude": "number",
            "longitude": "number"
        },
        "craneRequired": "boolean ("DEFAULT: False")",
        "naturalDisasterConcern": "boolean ("DEFAULT: False")",
        "skidPanRequired": "boolean ("DEFAULT: False")",
        "createdOn": "date/time",
        "updatedOn": "date/time",
        "latestInspectionDate": "date/time ("NULLABLE")",
        "buildDate": "date/time ("NULLABLE")",
        "offRentedOn": "date/time ("NULLABLE")",
        "fulfilledDate": "date/time ("NULLABLE")",
        "demoedOn": "date/time ("NULLABLE")",
        "earliestDemoDate": "date/time ("NULLABLE")",
        "latestDemoDate": "date/time ("NULLABLE")",
        "modifyDate": "date/time ("NULLABLE")",
}