Site

You need the Manage Site permission to manage sites.

• Sites - Sites Manage
  • GET global/sites - Get the list of Sites
  • GET global/sites/{id} - Get a single Site
  • POST global/sites - Create a new Site
  • PUT global/sites/{id} - Update the Site
  • POST global/sites/{id}:changeSiteStatus - Change the site's status

Site JSON Format

Site is represented as simple flat JSON objects with the following keys:

Get the list of Sites

GET global/sites

Parameters:

Response:

An arrary of Site

Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites?externalId=DA2E1FF1-A151-4FFE-9701-C1C8F234C632 \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

[
  {
    "id": 10001,
    "externalId": "DA2E1FF1-A151-4FFE-9701-C1C8F234C632",
    "partnerId": 10000,
    "platformId":100,
    "firstName": "Jason",
    "lastName": "Statham",
    "company": "Comm100",
    "website": "https://www.comm100.com",
    "companySize": "101-180",
    "countryOrRegion": "Canada",
    "stateOrProvince": "British Columbia",
    "status": "Open",
    "subDomain": "",
    "customDomain": "",
    "phone": "88654987",
    "fax": "58469215",
    "mailingAddress": "mail@comm100.com",
    "postalOrZipCode": "V7J",
    "city": "Vancouver",
    "languageId": "en",
    "datetimeFormat": "MM/DD/YYYY HH:mm:ss",
    "timeZone": "Atlantic Standard Time",
    "industry": "Educational Services",
    "otherIndustryDescription": "",
    "isDeleted": false
  } 
]

Get a single Site

GET global/sites/{id}

Parameters:

No Parameters

Response:

Site

Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites/10001 \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

 {
    "id": 10001,
    "externalId": "DA2E1FF1-A151-4FFE-9701-C1C8F234C632",
    "partnerId": 10000,
    "platformId":100,
    "firstName": "Jason",
    "lastName": "Statham",
    "company": "Comm100",
    "website": "https://www.comm100.com",
    "companySize": "101-180",
    "countryOrRegion": "Canada",
    "stateOrProvince": "British Columbia",
    "status": "Open",
    "subDomain": "",
    "customDomain": "",
    "phone": "88654987",
    "fax": "58469215",
    "mailingAddress": "mail@comm100.com",
    "postalOrZipCode": "V7J",
    "city": "Vancouver",
    "languageId": "en",
    "datetimeFormat": "MM/DD/YYYY HH:mm:ss",
    "timeZone": "Atlantic Standard Time",
    "industry": "Educational Services",
    "otherIndustryDescription": "",
    "isDeleted": false
  } 

Create a new Site

POST global/sites

Parameters:

Response:

Site Object

Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \
    -D '{"platformId":100,"externalId":"DA2E1FF1-A151-4FFE-9701-C1C8F234C632","email":"mail@comm100.com","password":"12345","planId":233}'

Response:

HTTP/1.1 200 OK

{
  "siteId": 10001,
  "email": "mail@comm100.com",
  "externalId": "DA2E1FF1-A151-4FFE-9701-C1C8F234C632"
} 

Update the Site

PUT global/sites/{id}

Parameters:

Response:

Updated Site

Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites/10001 \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -D '{"id": 10001,"externalId": "sadasdc32ada123sd2","firstName": "Jason","lastName": "Statham","company": "Comm100","website": "https://www.comm100.com","phone": "88654987","fax": "58469215","companySize": "101-180","mailingAddress": "mail@comm100.com","city": "Vancouver","stateOrProvince": "British Columbia","postalOrZipCode": "V7J","countryOrRegion": "Canada","datetimeFormat": "MM/DD/YYYY HH:mm:ss","timeZone": "Atlantic Standard Time"} '

Response:

HTTP/1.1 200 OK

{
  "id": 10001,
  "externalId": "sadasdc32ada123sd2",
  "partnerId": 10000,
  "platformId": 100,
  "firstName": "Jason",
  "lastName": "Statham",
  "company": "Comm100",
  "website": "https://www.comm100.com",
  "phone": "88654987",
  "fax": "58469215",
  "companySize": "101-180",
  "mailingAddress": "mail@comm100.com",
  "city": "Vancouver",
  "languageId": "en",
  "stateOrProvince": "British Columbia",
  "postalOrZipCode": "V7J",
  "countryOrRegion": "Canada",
  "datetimeFormat": "MM/DD/YYYY HH:mm:ss",
  "timeZone": "Atlantic Standard Time",
  "status": "Open",
  "subDomain": "",
  "customDomain": "",
  "industry": "Educational Services",
  "otherIndustryDescription": "",
  "isDeleted": false
} 

Change Site Status

POST global/sites/{id}:changeSiteStatus

Parameters:

Response:

Updated Site

Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites/10001:changeSiteStatus \ 
    -X 'POST' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -D '{"status":"open"}'

Response:

HTTP/1.1 200 OK

{
  "id": 10001,
  "externalId": "sadasdc32ada123sd2",
  "status": "open"
}