Getting Site Information

From Enterprise Help
Revision as of 16:21, 12 February 2015 by Jkarg (Talk | contribs) (Created page with "After user provides authorization for the first time and access token is obtained, the first thing the client needs to do is get the user's Site ID(s). The Site ID will be ne...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

After user provides authorization for the first time and access token is obtained, the first thing the client needs to do is get the user's Site ID(s). The Site ID will be necessary to make subsequent calls because it will be part of the request URL for endpoints other than Sites.


Note: It is possible for a user to have more than 1 site. If the user is managing multiple business entities under different names, each can be set up in its own site.


Example:

  GET https://enterprise.qa.fishbowl.com/api/odata/v1/Sites HTTP/1.1
  Accept: application/json
  Authorization: Bearer u7kBYz1UhHkoRSc7V4gruBs-4sEpIkFV-F4LGiFMwfGwJNnT_JzNft
  g6_Zm0yWi8P m60iPlmCCHUSwCX5Uru-OJq2jzhbT-E6nAc1OwzghTCmeoo0K69ubDBMFX5hyKlc
  AjA9H3Vs-ZNjNYKarpSO5rA5ubG5-Va5Aigm9mp-Pre-EaGAY_HBdxZi-LBMSQ_mSjyIDPBpLFYP
  BNzK3cu0xGobGsFLxPtDG3urs_4abXZtvxN8wm9rpsgr


Example Response:

  {  
     "odata.metadata":"http://enterprise.qa.fishbowl.com/API/odata/v1/
                       $metadata#Sites",
     "value":[  
        {  
           "SiteID":"2147485429",
           "Name":"Fishbowl Local",
           "SiteGUID":"32cc6c0f-92a2-4548-94b6-123944c0d7bb",
           "WebDomainName":"fishbowllocal.fbmta.com",
           "MailDomainName":"fishbowllocal.fbmta.com" 
        }
     ]
  }