Skip to main content

SiteRegistration - PM web service

  1. Last updated
  2. Save as PDF

Avatar PM WEBSVC.SiteRegistration web service. This web service can be used to file Site Registrations into myAvatar .

  1. AddSiteRegistration
  2. GetDictionaryItems
  3. UpdateSiteRegistration

AddSiteRegistration call

The following tables list the AddSiteRegistration parameters,properties,accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserName N/A Avatar User ID  
Password N/A Avatar Password  

Parameters with Properties

Parameter Property Value Accepted Notes
SiteRegistrationInfo AssociatedPrograms Dictionary # 150 in SITE file  
  CopyInfoFromExistingSite Dictionary # 10051 in SITE file  
  CountiesRoutinelyServed Dictionary 108 in SITE file  
  SSSiteRegDate1 Date  
  SSSiteRegDate2 Date  
  SSSiteRegDate3 Date  
  SSSiteRegDate4 Date  
  SSSiteRegDate5 Date  
  SSSiteRegDictionary1 Dictionary 21007.1 in SITE file  
  SSSiteRegDictionary2 Dictionary 21007.2 in SITE file  
  SSSiteRegDictionary3 Dictionary 21007.3 in SITE file  
  SSSiteRegDictionary4 Dictionary 21007.4 in SITE file  
  SSSiteRegDictionary5 Dictionary 21007.5 in SITE file  
  SSSiteRegFreeText101 Free Text, 10 character max  
  SSSiteRegFreeText102 Free Text, 10 character max  
  SSSiteRegFreeText103 Free Text, 10 character max  
  SSSiteRegFreeText104 Free Text, 10 character max  
  SSSiteRegFreeText105 Free Text, 10 character max  
  SSSiteRegFreeText201 Free Text, 20 character max  
  SSSiteRegFreeText202 Free Text, 20 character max  
  SSSiteRegFreeText203 Free Text, 20 character max  
  SSSiteRegFreeText204 Free Text, 20 character max  
  SSSiteRegFreeText205 Free Text, 20 character max  
  SSSiteRegFreeText401 Free Text, 40 character max  
  SSSiteRegFreeText402 Free Text, 40 character max  
  SSSiteRegFreeText403 Free Text, 40 character max  
  SSSiteRegFreeText404 Free Text, 40 character max  
  SSSiteRegFreeText405 Free Text, 40 character max  
  SSSiteRegMultiSelectDict1 Dictionary Field 21008.1  
  SSSiteRegMultiSelectDict2 Dictionary Field 21008.2  
  SSSiteRegMultiSelectDict3 Dictionary Field 21008.3  
  SSSiteRegMultiSelectDict4 Dictionary Field 21008.4  
  SSSiteRegMultiSelectDict5 Dictionary Field 21008.5  
  SSSiteRegPractLookup1 Practitioner lookup field 21006.1  
  SSSiteRegPractLookup2 Practitioner lookup field 21006.2  
  SSSiteRegPractLookup3 Practitioner lookup field 21006.3  
  SSSiteRegPractLookup4 Practitioner lookup field 21006.4  
  SSSiteRegPractLookup5 Practitioner lookup field 21006.5  
  SSSiteRegScrollFreeText1 Free Text Field  
  SSSiteRegScrollFreeText2 Free Text Field  
  SSSiteRegScrollFreeText3 Free Text Field  
  SSSiteRegScrollFreeText4 Free Text Field  
  SSSiteRegScrollFreeText5 Free Text Field  
  SSRegTime1 Time  
  SSRegTime2 Time  
  SSRegTime3 Time  
  SSRegTime4 Time  
  SSRegTime5 Time  
  SelectExistingSite Site lookup  
  SiteCity Free Text  
  SiteContactPerson Free Text  
  SiteFax Phone Number  
  SiteName Free Text  
  SitePhone Phone Number  
  SiteRegistrationDate Date  
  SiteState State  
  SiteStreetAddress1 Free Text  
  SiteStreetAddress2 Free Text  
  SiteZipCode Numeric  
  DefaultEffectiveDate Date  
  DefaultExpirationDate Date  
  DefaultDaysOfWeek Dictionary Field 10002 in SITE file  
  DefaultWeekOfMonth Dictionary Field 12024 in SITE file  
  SlotTimeDuration Numeric  
  DefaultOverbookingAllowed Dictionary Field 12033 in SITE file  
  DefaultRestricted Dictionary Field 10232 in SITE file  
  DefaultDiscipline Dictionary Field 75 in STAFF file  
  DefaultServiceCode Dictionary Field 209  
  SiteHours WEBSVC.SiteHours Extended Web Service Object, see below for properties
  SiteHolidays WEBSVC.SiteHolidays Extended Web Service Object, see below for properties
  MissedVisits WEBSVC.MissedVisits Extended Web Service Object, see below for properties
  TimeSlots WEBSVC.TimeSlots Extended Web Service Object, see below for properties

 

GetDictionaryItems call

The following tables list the GetDictionaryItems parameters,properties,accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserName N/A Avatar User ID  
Password N/A Avatar Password  

 

UpdateSiteRegistration call

The following tables list the UpdateSiteRegistration parameters, properties, accepted values, and associated dictionaries

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserName N/A Avatar User ID  
Password N/A Avatar Password  

 

Parameters with Properties

Parameter Property Value Accepted Notes
SiteRegistrationInfo AssociatedPrograms Dictionary # 150 in SITE file  
  CopyInfoFromExistingSite Dictionary # 10051 in SITE file  
  CountiesRoutinelyServed Dictionary 108 in SITE file  
  SSSiteRegDate1 Date  
  SSSiteRegDate2 Date  
  SSSiteRegDate3 Date  
  SSSiteRegDate4 Date  
  SSSiteRegDate5 Date  
  SSSiteRegDictionary1 Dictionary 21007.1 in SITE file  
  SSSiteRegDictionary2 Dictionary 21007.2 in SITE file  
  SSSiteRegDictionary3 Dictionary 21007.3 in SITE file  
  SSSiteRegDictionary4 Dictionary 21007.4 in SITE file  
  SSSiteRegDictionary5 Dictionary 21007.5 in SITE file  
  SSSiteRegFreeText101 Free Text, 10 character max  
  SSSiteRegFreeText102 Free Text, 10 character max  
  SSSiteRegFreeText103 Free Text, 10 character max  
  SSSiteRegFreeText104 Free Text, 10 character max  
  SSSiteRegFreeText105 Free Text, 10 character max  
  SSSiteRegFreeText201 Free Text, 20 character max  
  SSSiteRegFreeText202 Free Text, 20 character max  
  SSSiteRegFreeText203 Free Text, 20 character max  
  SSSiteRegFreeText204 Free Text, 20 character max  
  SSSiteRegFreeText205 Free Text, 20 character max  
  SSSiteRegFreeText401 Free Text, 40 character max  
  SSSiteRegFreeText402 Free Text, 40 character max  
  SSSiteRegFreeText403 Free Text, 40 character max  
  SSSiteRegFreeText404 Free Text, 40 character max  
  SSSiteRegFreeText405 Free Text, 40 character max  
  SSSiteRegMultiSelectDict1 Dictionary Field 21008.1  
  SSSiteRegMultiSelectDict2 Dictionary Field 21008.2  
  SSSiteRegMultiSelectDict3 Dictionary Field 21008.3  
  SSSiteRegMultiSelectDict4 Dictionary Field 21008.4  
  SSSiteRegMultiSelectDict5 Dictionary Field 21008.5  
  SSSiteRegPractLookup1 Practitioner lookup field 21006.1  
  SSSiteRegPractLookup2 Practitioner lookup field 21006.2  
  SSSiteRegPractLookup3 Practitioner lookup field 21006.3  
  SSSiteRegPractLookup4 Practitioner lookup field 21006.4  
  SSSiteRegPractLookup5 Practitioner lookup field 21006.5  
  SSSiteRegScrollFreeText1 Free Text Field  
  SSSiteRegScrollFreeText2 Free Text Field  
  SSSiteRegScrollFreeText3 Free Text Field  
  SSSiteRegScrollFreeText4 Free Text Field  
  SSSiteRegScrollFreeText5 Free Text Field  
  SSRegTime1 Time  
  SSRegTime2 Time  
  SSRegTime3 Time  
  SSRegTime4 Time  
  SSRegTime5 Time  
  SelectExistingSite Site lookup  
  SiteCity Free Text  
  SiteContactPerson Free Text  
  SiteFax Phone Number  
  SiteName Free Text  
  SitePhone Phone Number  
  SiteRegistrationDate Date  
  SiteState State  
  SiteStreetAddress1 Free Text  
  SiteStreetAddress2 Free Text  
  SiteZipCode Numeric  
  DefaultEffectiveDate Date  
  DefaultExpirationDate Date  
  DefaultDaysOfWeek Dictionary Field 10002 in SITE file  
  DefaultWeekOfMonth Dictionary Field 12024 in SITE file  
  SlotTimeDuration Numeric  
  DefaultOverbookingAllowed Dictionary Field 12033 in SITE file  
  DefaultRestricted Dictionary Field 10232 in SITE file  
  DefaultDiscipline Dictionary Field 75 in STAFF file  
  DefaultServiceCode Dictionary Field 209  
  SiteHours WEBSVC.SiteHours Extended Web Service Object, see below for properties
  SiteHolidays WEBSVC.SiteHolidays Extended Web Service Object, see below for properties
  MissedVisits WEBSVC.MissedVisits Extended Web Service Object, see below for properties
  TimeSlots WEBSVC.TimeSlots Extended Web Service Object, see below for properties

Object class - WEBSVC.SiteHours

 

Parameter Property Value Accepted Notes
WEBSVC.SiteHours HoursEffectiveDate Date  
  HoursEndDate Date  
  Day Dictionary field 10002 in SITE file  
  StartTime Time  
  EndTime Time  
  ServiceCodeSearch Service Codes  
  AllowOverbooking Dictionary field 10051 in SITE file  
  NumOfOverbookAllowed Numeric  

 

Object class - WEBSVC.SiteHolidays

Parameter Property Value Accepted Notes
WEBSVC.SiteHolidays HolidayDate Date  
  HolidayDescription Free Text  
  ClosedEntireDaySelectTime Dictionary field 10007 in SITE file  
  HolidayStartTime Time  
  HolidayEndTime Time  
  RecurringOrIndSiteExcep Dictionary 10015 in SITE file  
  NumSessionsOrDateRange Dictionary 10016 in SITE file  
  NumberOfSessions Numeric  
  ExceptionEndDate Date  
  RecurrencePattern Dictionary field 10019 in SITE file  
  RecurEveryWeek Numeric  
  DayOfTheWeek Dictionary field 10026 in SITE file  
  DayOfMonthlyRecurPattern Dictionary field 10029 in SITE file  
  MonthlyFreqSelectedDay Dictionary field 10030 in SITE file  
  SpecificDateOrOther Dictionary field 10033 in SITE file  
  MonthDay Free Text  
  DayYearlyRecurPattern Dictionary field 10035 in SITE file  
  YearlyFreqSelectedDay Dictionary field 10036 in SITE file  
  Month Dictionary field 10037 in SITE file  

 

Object class - WEBSVC.MissedVisits

Parameter Property Value Accepted Notes
WEBSVC.MissedVisits MissedVisitServiceCode Service Code  

 

Object class - WEBSVC.TimeSlots

 

Parameter Property Value Accepted Notes
WEBSVC.TimeSlots EffectiveDate Date  
  ExpirationDate Date  
  DaysOfWeek Dictionary field 203 in SITE file  
  WeeksOfMonth Dictionary field 12024 in SITE file  
  StartTime Time  
  Duration Numeric  
  NumOfTimeSlots Numeric  
  EndTime Time  
  ApptSlotsAvailable Numeric  
  ValidDiscipline Dictionary field 75 in STAFF file  
  ValidService Service code  
  Restricted Dictionary field 12032 in SITE file  
  AllowOverbooking Dictionary field 12033 in SITE file  
  Notes Free Text