Get Site Data

Describes the API specifications for retrieving all site data.

Request

URI: https://<SAP Fieldglass envionment URL>/api/v1/admin/v1/sites/<siteID>

HTTP Method: GET

Request Parameters

Parameter Required Data Type Description Parameter Type
siteID Yes String The unique ID of the site. Path

Request Example

GET https://company.com/api/v1/admin/v1/sites/41D7F065113448FF8C664E69
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Body

Response Payload Content
Element Name Data Type Description
activeFlag Boolean Indicates if the site is active.
address1 String Line 1 of the site’s address.
allowCandidateAnonoymityFlag Boolean Indicates whether candidate personal information remains anonymous until after a work order has been activated.
allowToSubmitResumeFlag Boolean Indicates whether supplier is allowed to submit a candidate Resume/CV.
buyerCode String Code describing the Business Unit.
code String Code for the site.
createTime String The day and time the site record was created.
displayStatus String The Site status displayed in the UI.
divisionCodeAssociationType String  
invoiceTaxInfoRequiredFlag Boolean Indicates whether invoice tax information is required.
legalEntityAssociation String

Indicates if the site applies to more than one legal entity. Valid values:

  • None

  • Single

  • Multiple

  • All
name String Name of the site.
parentSiteId String The ID of the parent site.
revisionTime String The day and time ht site record was revised.
selectableSiteFlag Boolean Indicates whether the site is selectable.
siteId String The unique identifier of the site.
uploadedFlag Boolean  
Response Payload Links
Element Name Data Type Description
rel String

Related sub-modules. Example:

  • self

  • billing-schedules

  • custom-fields

  • invoice-adjustments

  • locations

  • offboarding-checklists

  • onboarding-checklists

  • suppliers

  • users

  • xsl-templates
link String The URI of the link.
id String Globally unique database-level identifier of the site record. Only valid when rel=self.

Response Example

{
    "header": {
        "server": "Fieldglass API Server",
        "responseStatus": "OK",
        "noOfRecordsPresent": 1,
        "noOfRecordsServed": 1,
        "moreRecordsExists": false,
        "localeString": "en_US",
        "version": "v1"
    },
    "responsePayload": {
        "content": {
            "activeFlag": false,
            "address1": "125 S. Wacker",
            "allowCandidateAnonoymityFlag": false,
            "allowToSubmitResumeFlag": true,
            "buyerCode": "ANTE",
            "code": "ANTE_ANTE",
            "createTime": "01/16/2014 00:25",
            "displayStatus": "Closed",
            "divisionCodeAssociationType": "NONE",
            "invoiceTaxInfoRequiredFlag": false,
            "legalEntityAssociation": "None",
            "name": "ANTE",
            "parentSiteId": "0",
            "revisionTime": "07/14/2021 20:43",
            "selectableSiteFlag": false,
            "siteId": "41D7F065113448FF8C664E69",
            "uploadedFlag": false
        },
        "links": [
            {
                "rel": "self",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69",
                "id": "41D7F065113448FF8C664E69"
            },
            {
                "rel": "billing-schedules",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/billing-schedules"
            },
            {
                "rel": "custom-fields",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/custom-fields"
            },
            {
                "rel": "invoice-adjustments",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/invoice-adjustments"
            },
            {
                "rel": "locations",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/locations"
            },
            {
                "rel": "offboarding-checklists",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/offboarding-checklists"
            },
            {
                "rel": "onboarding-checklists",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/onboarding-checklists"
            },
            {
                "rel": "suppliers",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/suppliers"
            },
            {
                "rel": "users",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/users"
            },
            {
                "rel": "xsl-templates",
                "link": "api/v1/admin/v1/sites/41D7F065113448FF8C664E69/xsl-templates"
            }
        ]
    }
}