Schemas

Session

{
  "sessionName": "string",
  "sessionId": "string",
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
sessionName	string	true	none	Session Name
sessionId	string	true	none	Session Id
username	string	true	none	Username

Grade

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true
}

Properties

Name	Type	Required	Restrictions	Description
clientCode	string	true	none	Grade client code
name	string	true	none	Grade name
gradeTypeCode	string	true	none	Grade type
description	string	true	none	Grade description
gradeStatusCode	string	true	none	Grade status
isSensitive	boolean	true	none	Grade is sensitive

Enumerated Values

Property	Value
gradeStatusCode	ACTIVE
gradeStatusCode	INACTIVE

GradeExtra

{
  "clientCode": "string",
  "name": "string",
  "gradeTypeCode": "string",
  "description": "string",
  "gradeStatusCode": "ACTIVE",
  "isSensitive": true,
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	Grade	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» dateCreated	string	false	none	Created Date
» creator	string	false	none	Creator
» dateModified	string	false	none	Modified Date
» modifier	string	false	none	Modifier

Grades

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "gradeTypeCode": "string",
      "description": "string",
      "gradeStatusCode": "ACTIVE",
      "isSensitive": true,
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalResultsAvailable	integer	false	none	Total Results Available
firstResultPosition	integer	false	none	First Result Position
resultsPerPage	integer	false	none	Results Per Page
results	[GradeExtra]	false	none	Grades

ResourceStatus

{
  "clientCode": "string",
  "statusCode": "ACTIVE"
}

Properties

Name	Type	Required	Restrictions	Description
clientCode	string	true	none	Client Code
statusCode	string	true	none	Status

Enumerated Values

Property	Value
statusCode	ACTIVE
statusCode	INACTIVE

LocationBase

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string",
  "clientCode": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	Location	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» clientCode	string	false	none	Client code
» dateCreated	string	false	none	Created Date
» creator	string	false	none	Creator
» dateModified	string	false	none	Modified Date
» modifier	string	false	none	Modifier

Locations

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "name": "string",
      "countryCode": "US",
      "geoRegionCode": "string",
      "latitudeDeg": 0,
      "latitudeMin": 0,
      "latitudeSec": 0,
      "latitudeNs": "N",
      "longitudeDeg": 0,
      "longitudeMin": 0,
      "longitudeSec": 0,
      "longitudeWe": "W",
      "statusCode": "ACTIVE",
      "restrictions": "string",
      "generalComments": "string",
      "clientCode": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalResultsAvailable	integer	false	none	Total Results Available
firstResultPosition	integer	false	none	First Result Position
resultsPerPage	integer	false	none	Results Per Page
results	[LocationBase]	false	none	Locations

Location

{
  "name": "string",
  "countryCode": "US",
  "geoRegionCode": "string",
  "latitudeDeg": 0,
  "latitudeMin": 0,
  "latitudeSec": 0,
  "latitudeNs": "N",
  "longitudeDeg": 0,
  "longitudeMin": 0,
  "longitudeSec": 0,
  "longitudeWe": "W",
  "statusCode": "ACTIVE",
  "restrictions": "string",
  "generalComments": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Location name
countryCode	countryCode	true	none	Country Code
geoRegionCode	string	true	none	Geo Region Code
latitudeDeg	integer	true	none	Latitude Degree
latitudeMin	integer	true	none	Latitude Minute
latitudeSec	integer	true	none	Latitude Second
latitudeNs	string	true	none	Latitude Hemisphere
longitudeDeg	integer	true	none	Longitude Degree
longitudeMin	integer	true	none	Longitude Minute
longitudeSec	integer	true	none	Longitude Second
longitudeWe	string	true	none	Longitude Hemisphere
statusCode	string	true	none	Location status code
restrictions	string	true	none	Restrictions
generalComments	string	true	none	Comments

Enumerated Values

Property	Value
latitudeNs	N
latitudeNs	S
longitudeWe	W
longitudeWe	E
statusCode	ACTIVE
statusCode	INACTIVE

countryCode

"US"

Country Code

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Country Code

Enumerated Values

Value	Property
US	United States
CA	Canada
AX	Åland Islands
AF	Afghanistan
AL	Albania
DZ	Algeria
AS	American Samoa
AD	Andorra
AO	Angola
AI	Anguilla
AQ	Antarctica
AG	Antigua And Barbuda
AR	Argentina
AM	Armenia
AW	Aruba
AU	Australia
AT	Austria
AZ	Azerbaijan
BS	Bahamas
BH	Bahrain
BD	Bangladesh
BB	Barbados
BY	Belarus
BE	Belgium
BZ	Belize
BJ	Benin
BM	Bermuda
BT	Bhutan
BO	Bolivia, Plurinational State Of
BQ	Bonaire, Sint Eustatius And Saba
BA	Bosnia And Herzegovina
BW	Botswana
BV	Bouvet Island
BR	Brazil
IO	British Indian Ocean Territory
BN	Brunei Darussalam
BG	Bulgaria
BF	Burkina Faso
BI	Burundi
KH	Cambodia
CM	Cameroon
CV	Cape Verde
KY	Cayman Islands
CF	Central African Republic
TD	Chad
CL	Chile
CN	China
CX	Christmas Island
CC	Cocos (Keeling) Islands
CO	Colombia
KM	Comoros
CG	Congo
CD	Congo, The Democratic Republic Of The
CK	Cook Islands
CR	Costa Rica
CI	Cote D'Ivoire
HR	Croatia
CU	Cuba
CW	Curacao
CY	Cyprus
CZ	Czech Republic
DK	Denmark
DJ	Djibouti
DM	Dominica
DO	Dominican Republic
TL	Timor-Leste
EC	Ecuador
EG	Egypt
SV	El Salvador
GQ	Equatorial Guinea
ER	Eritrea
EE	Estonia
ET	Ethiopia
FK	Falkland Islands (Malvinas)
FO	Faroe Islands
FJ	Fiji
FI	Finland
FR	France
GF	French Guiana
PF	French Polynesia
TF	French Southern Territories
GA	Gabon
GM	Gambia
GE	Georgia
DE	Germany
GH	Ghana
GI	Gibraltar
GR	Greece
GL	Greenland
GD	Grenada
GP	Guadeloupe
GU	Guam
GT	Guatemala
GG	Guernsey
GN	Guinea
GW	Guinea-Bissau
GY	Guyana
HT	Haiti
HM	Heard Island And McDonald Islands
HN	Honduras
HK	Hong Kong
HU	Hungary
IS	Iceland
IN	India
ID	Indonesia
IR	Iran, Islamic Republic Of
IQ	Iraq
IE	Ireland
IM	Isle Of Man
IL	Israel
IT	Italy
JM	Jamaica
JP	Japan
JE	Jersey
JO	Jordan
KZ	Kazakhstan
KE	Kenya
KI	Kiribati
KP	Korea, Democratic People's Republic Of
KR	Korea, Republic Of
KW	Kuwait
KG	Kyrgyzstan
LA	Lao People's Democratic Republic
LV	Latvia
LB	Lebanon
LS	Lesotho
LR	Liberia
LY	Libya
LI	Liechtenstein
LT	Lithuania
LU	Luxembourg
MO	Macao
MK	Macedonia, The Former Yugoslav Republic Of
MG	Madagascar
MW	Malawi
MY	Malaysia
MV	Maldives
ML	Mali
MT	Malta
MH	Marshall Islands
MQ	Martinique
MR	Mauritania
MU	Mauritius
YT	Mayotte
MX	Mexico
FM	Micronesia, Federated States Of
MD	Moldova, Republic Of
MC	Monaco
MN	Mongolia
ME	Montenegro
MS	Montserrat
MA	Morocco
MZ	Mozambique
MM	Myanmar
NA	Namibia
NR	Nauru
NP	Nepal
NL	Netherlands
AN	Netherlands Antilles
NC	New Caledonia
NZ	New Zealand
NI	Nicaragua
NE	Niger
NG	Nigeria
NU	Niue
NF	Norfolk Island
MP	Northern Mariana Islands
NO	Norway
OM	Oman
PK	Pakistan
PW	Palau
PS	Palestinian Territory, Occupied
PA	Panama
PG	Papua New Guinea
PY	Paraguay
PE	Peru
PH	Philippines
PN	Pitcairn
PL	Poland
PT	Portugal
PR	Puerto Rico
QA	Qatar
RE	Reunion
RO	Romania
RU	Russian Federation
RW	Rwanda
WS	Samoa
SM	San Marino
ST	Sao Tome And Principe
SA	Saudi Arabia
SN	Senegal
RS	Serbia
SC	Seychelles
SL	Sierra Leone
SG	Singapore
SK	Slovakia
SI	Slovenia
SB	Solomon Islands
SO	Somalia
ZA	South Africa
GS	South Georgia And The South Sandwich Islands
SS	South Sudan
ES	Spain
LK	Sri Lanka
BL	Saint Barthélemy
SH	Saint Helena, Ascension And Tristan Da Cunha
KN	Saint Kitts And Nevis
LC	Saint Lucia
MF	Saint Martin (French Part)
PM	Saint Pierre And Miquelon
VC	Saint Vincent And The Grenadines
SX	Sint Maarten (Dutch Part)
SD	Sudan
SR	Suriname
SJ	Svalbard And Jan Mayen
SZ	Swaziland
SE	Sweden
CH	Switzerland
SY	Syrian Arab Republic
TW	Taiwan
TJ	Tajikistan
TZ	Tanzania, United Republic Of
TH	Thailand
TG	Togo
TK	Tokelau
TO	Tonga
TT	Trinidad And Tobago
TN	Tunisia
TR	Turkey
TM	Turkmenistan
TC	Turks And Caicos Islands
TV	Tuvalu
UG	Uganda
UA	Ukraine
AE	United Arab Emirates
GB	United Kingdom
UM	United States Minor Outlying Islands
UY	Uruguay
UZ	Uzbekistan
VU	Vanuatu
VA	Holy See (Vatican City State)
VE	Venezuela, Bolivarian Republic Of
VN	Viet Nam
VG	Virgin Islands, British
VI	Virgin Islands, U.S.
WF	Wallis And Futuna
EH	Western Sahara
YE	Yemen
ZM	Zambia
ZW	Zimbabwe

CompanyBase

{
  "clientCode": "string",
  "name": "string",
  "statusCode": "ACTIVE",
  "companyRoles": [
    "string"
  ],
  "headOfficeName": "string",
  "headOfficeDescription": "string",
  "dateCreated": "string",
  "creator": "string",
  "dateModified": "string",
  "modifier": "string"
}

Properties

Name	Type	Required	Restrictions	Description
clientCode	string	false	none	Company client code
name	string	false	none	Company name
statusCode	string	false	none	Company status code
companyRoles	[string]	false	none	Company role
headOfficeName	string	false	none	Head office name
headOfficeDescription	string	false	none	Head office description
dateCreated	string	false	none	Created Date
creator	string	false	none	Creator
dateModified	string	false	none	Modified Date
modifier	string	false	none	Modifier

Enumerated Values

Property	Value
statusCode	ACTIVE
statusCode	INACTIVE

Companies

{
  "totalResultsAvailable": 0,
  "firstResultPosition": 0,
  "resultsPerPage": 0,
  "results": [
    {
      "clientCode": "string",
      "name": "string",
      "statusCode": "ACTIVE",
      "companyRoles": [
        "string"
      ],
      "headOfficeName": "string",
      "headOfficeDescription": "string",
      "dateCreated": "string",
      "creator": "string",
      "dateModified": "string",
      "modifier": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
totalResultsAvailable	integer	false	none	Total Results Available
firstResultPosition	integer	false	none	First Result Position
resultsPerPage	integer	false	none	Results Per Page
results	[CompanyBase]	false	none	Companies

Company

{
  "name": "string",
  "headOffice": {
    "name": "string",
    "description": "string",
    "contact": {
      "addresses": [
        {
          "isPreferred": true,
          "address": "string",
          "city": "string",
          "state": "string",
          "postalCode": "string",
          "countryCode": "US",
          "addressTypeCode": "WORK"
        }
      ],
      "emails": [
        {
          "isPreferred": true,
          "address": "string",
          "emailTypeCode": "WORK"
        }
      ],
      "urls": [
        {
          "isPreferred": true,
          "address": "string",
          "urlTypeCode": "WORK"
        }
      ],
      "phones": [
        {
          "isPreferred": true,
          "phoneNumber": "string",
          "phoneTypeCode": "WORK"
        }
      ]
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Company name
headOffice	Office	true	none	none

Office

{
  "name": "string",
  "description": "string",
  "contact": {
    "addresses": [
      {
        "isPreferred": true,
        "address": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "countryCode": "US",
        "addressTypeCode": "WORK"
      }
    ],
    "emails": [
      {
        "isPreferred": true,
        "address": "string",
        "emailTypeCode": "WORK"
      }
    ],
    "urls": [
      {
        "isPreferred": true,
        "address": "string",
        "urlTypeCode": "WORK"
      }
    ],
    "phones": [
      {
        "isPreferred": true,
        "phoneNumber": "string",
        "phoneTypeCode": "WORK"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
description	string	true	none	none
contact	Contact	true	none	none

Contact

{
  "addresses": [
    {
      "isPreferred": true,
      "address": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "countryCode": "US",
      "addressTypeCode": "WORK"
    }
  ],
  "emails": [
    {
      "isPreferred": true,
      "address": "string",
      "emailTypeCode": "WORK"
    }
  ],
  "urls": [
    {
      "isPreferred": true,
      "address": "string",
      "urlTypeCode": "WORK"
    }
  ],
  "phones": [
    {
      "isPreferred": true,
      "phoneNumber": "string",
      "phoneTypeCode": "WORK"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
addresses	[Address]	true	none	none
emails	[Email]	true	none	none
urls	[Url]	true	none	none
phones	[Phone]	true	none	none

Address

{
  "isPreferred": true,
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "countryCode": "US",
  "addressTypeCode": "WORK"
}

Properties

Name	Type	Required	Restrictions	Description
isPreferred	boolean	true	none	none
address	string	true	none	none
city	string	true	none	none
state	string	true	none	none
postalCode	string	true	none	none
countryCode	countryCode	true	none	Country Code
addressTypeCode	AddressType	true	none	none

Url

{
  "isPreferred": true,
  "address": "string",
  "urlTypeCode": "WORK"
}

Properties

Name	Type	Required	Restrictions	Description
isPreferred	boolean	true	none	none
address	string	true	none	none
urlTypeCode	UrlType	true	none	none

Phone

{
  "isPreferred": true,
  "phoneNumber": "string",
  "phoneTypeCode": "WORK"
}

Properties

Name	Type	Required	Restrictions	Description
isPreferred	boolean	true	none	none
phoneNumber	string	true	none	none
phoneTypeCode	PhoneType	true	none	none

Email

{
  "isPreferred": true,
  "address": "string",
  "emailTypeCode": "WORK"
}

Properties

Name	Type	Required	Restrictions	Description
isPreferred	boolean	true	none	none
address	string	true	none	none
emailTypeCode	EmailType	true	none	none

AddressType

"WORK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	WORK
anonymous	HOME
anonymous	MAIN
anonymous	MAILING
anonymous	OTHER

EmailType

"WORK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	WORK
anonymous	HOME
anonymous	OTHER
anonymous	NOL
anonymous	OFF_SPEC
anonymous	SCORECARD
anonymous	VEF_REPORT

PhoneType

"WORK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	WORK
anonymous	HOME
anonymous	MOBILE
anonymous	PAGER
anonymous	WORKFAX
anonymous	HOMEFAX
anonymous	MAIN
anonymous	AFTERHRS1
anonymous	AFTERHRS2
anonymous	AFTERHRS3
anonymous	HOTLINE
anonymous	SAT - A/B
anonymous	SAT - C
anonymous	TELEX
anonymous	REUTERS
anonymous	CARPHONE
anonymous	CALLSIGN
anonymous	PHONE

UrlType

"WORK"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	WORK
anonymous	HOME
anonymous	BLOG
anonymous	OTHER