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

Property	Value
anonymous	US
anonymous	CA
anonymous	AX
anonymous	AF
anonymous	AL
anonymous	DZ
anonymous	AS
anonymous	AD
anonymous	AO
anonymous	AI
anonymous	AQ
anonymous	AG
anonymous	AR
anonymous	AM
anonymous	AW
anonymous	AU
anonymous	AT
anonymous	AZ
anonymous	BS
anonymous	BH
anonymous	BD
anonymous	BB
anonymous	BY
anonymous	BE
anonymous	BZ
anonymous	BJ
anonymous	BM
anonymous	BT
anonymous	BO
anonymous	BQ
anonymous	BA
anonymous	BW
anonymous	BV
anonymous	BR
anonymous	IO
anonymous	BN
anonymous	BG
anonymous	BF
anonymous	BI
anonymous	KH
anonymous	CM
anonymous	CV
anonymous	KY
anonymous	CF
anonymous	TD
anonymous	CL
anonymous	CN
anonymous	CX
anonymous	CC
anonymous	CO
anonymous	KM
anonymous	CG
anonymous	CD
anonymous	CK
anonymous	CR
anonymous	CI
anonymous	HR
anonymous	CU
anonymous	CW
anonymous	CY
anonymous	CZ
anonymous	DK
anonymous	DJ
anonymous	DM
anonymous	DO
anonymous	TL
anonymous	EC
anonymous	EG
anonymous	SV
anonymous	GQ
anonymous	ER
anonymous	EE
anonymous	ET
anonymous	FK
anonymous	FO
anonymous	FJ
anonymous	FI
anonymous	FR
anonymous	GF
anonymous	PF
anonymous	TF
anonymous	GA
anonymous	GM
anonymous	GE
anonymous	DE
anonymous	GH
anonymous	GI
anonymous	GR
anonymous	GL
anonymous	GD
anonymous	GP
anonymous	GU
anonymous	GT
anonymous	GG
anonymous	GN
anonymous	GW
anonymous	GY
anonymous	HT
anonymous	HM
anonymous	HN
anonymous	HK
anonymous	HU
anonymous	IS
anonymous	IN
anonymous	ID
anonymous	IR
anonymous	IQ
anonymous	IE
anonymous	IM
anonymous	IL
anonymous	IT
anonymous	JM
anonymous	JP
anonymous	JE
anonymous	JO
anonymous	KZ
anonymous	KE
anonymous	KI
anonymous	KP
anonymous	KR
anonymous	KW
anonymous	KG
anonymous	LA
anonymous	LV
anonymous	LB
anonymous	LS
anonymous	LR
anonymous	LY
anonymous	LI
anonymous	LT
anonymous	LU
anonymous	MO
anonymous	MK
anonymous	MG
anonymous	MW
anonymous	MY
anonymous	MV
anonymous	ML
anonymous	MT
anonymous	MH
anonymous	MQ
anonymous	MR
anonymous	MU
anonymous	YT
anonymous	MX
anonymous	FM
anonymous	MD
anonymous	MC
anonymous	MN
anonymous	ME
anonymous	MS
anonymous	MA
anonymous	MZ
anonymous	MM
anonymous	NA
anonymous	NR
anonymous	NP
anonymous	NL
anonymous	AN
anonymous	NC
anonymous	NZ
anonymous	NI
anonymous	NE
anonymous	NG
anonymous	NU
anonymous	NF
anonymous	MP
anonymous	NO
anonymous	OM
anonymous	PK
anonymous	PW
anonymous	PS
anonymous	PA
anonymous	PG
anonymous	PY
anonymous	PE
anonymous	PH
anonymous	PN
anonymous	PL
anonymous	PT
anonymous	PR
anonymous	QA
anonymous	RE
anonymous	RO
anonymous	RU
anonymous	RW
anonymous	WS
anonymous	SM
anonymous	ST
anonymous	SA
anonymous	SN
anonymous	RS
anonymous	SC
anonymous	SL
anonymous	SG
anonymous	SK
anonymous	SI
anonymous	SB
anonymous	SO
anonymous	ZA
anonymous	GS
anonymous	ES
anonymous	LK
anonymous	BL
anonymous	SH
anonymous	KN
anonymous	LC
anonymous	MF
anonymous	PM
anonymous	VC
anonymous	SX
anonymous	SD
anonymous	SR
anonymous	SJ
anonymous	SZ
anonymous	SE
anonymous	CH
anonymous	SY
anonymous	TW
anonymous	TJ
anonymous	TZ
anonymous	TH
anonymous	TG
anonymous	TK
anonymous	TO
anonymous	TT
anonymous	TN
anonymous	TR
anonymous	TM
anonymous	TC
anonymous	TV
anonymous	UG
anonymous	UA
anonymous	AE
anonymous	GB
anonymous	UM
anonymous	UY
anonymous	UZ
anonymous	VU
anonymous	VA
anonymous	VE
anonymous	VN
anonymous	VG
anonymous	VI
anonymous	WF
anonymous	EH
anonymous	YE
anonymous	ZM
anonymous	ZW

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