Attributes

JSON Request

{
  "RequestType":"CoPersonRoles",
  "Version":"1.0",
  "CoPersonRoles":
  [
    {
      "Version":"1.0",
      "Person":
      {
        "Type":"CO",
        "Id":"<ID>"
      },
      "CouId":"<CouId>",
      "Affiliation":"<Affiliation>",
      "Title":"<Title>",
      "O":"<O>",
      "Ordr":"<Order>",
      "Ou":"<Ou>",
      "SponsorCoPersonId":"<SponsorCoPersonId>",
      "ManagerCoPersonId":"<ManagerCoPersonId>",
      "Status":("Active"|"Approved"|"Confirmed"|"Declined"|"Deleted"|"Denied"|"Duplicate"|"Expired"|"GracePeriod"|"Invited"|"Pending"|"PendingApproval"|"PendingConfirmation"|"PendingVetting"|"Suspended"),
      "ValidFrom":"<ValidFrom>",
      "ValidThrough":"<ValidThrough>",
      "ExtendedAttributes":
      {
        "<Attribute>":"<Value>",
        {...}
      }
    }
  ]
}

XML Request

<!ELEMENT CoPersonRoles (CoPersonRole)>
 <!ATTLIST CoPersonRoles Version CDATA #FIXED "1.0">
 <!ELEMENT CoPersonRole (CoPersonId,CouId?,EduPersonAffiliation,Title?,O?,Ou?,Status,ValidFrom?,ValidThrough?,ExtendedAttributes?)>
 <!ATTLIST CoPersonRole Version CDATA #FIXED "1.0">
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Type (CO)>
   <!ELEMENT Id (#PCDATA)>
  <!ELEMENT CouId (#PCDATA)>
  <!ELEMENT Affiliation (faculty|student|staff|alum|member|affiliate|employee|library-walk-in)>
  <!ELEMENT Title (#PCDATA)>
  <!ELEMENT O (#PCDATA)>
  <!ELEMENT Ordr (#PCDATA)>
  <!ELEMENT Ou (#PCDATA)>
  <!ELEMENT SponsorCoPersonId (#PCDATA)>
  <!ELEMENT ManagerCoPersonId (#PCDATA)>
  <!ELEMENT Status (Active|Approved|Confirmed|Declined|Deleted|Denied|Duplicate|Expired|GracePeriod|Invited|Pending|PendingApproval|PendingConfirmation|PendingVetting|Suspended)>
  <!ELEMENT ValidFrom (#PCDATA)>
  <!ELEMENT ValidThrough (#PCDATA)>
  <!ELEMENT ExtendedAttributes (Attribute,...)>
   <!ELEMENT Attribute (#PCDATA)>

JSON Response

{
  "ResponseType":"CoPersonRoles",
  "Version":"1.0",
  "CoPersonRoles":
  [
    {
      "Version":"1.0",
      "Id":"<Id>",
      "Person":
      {
        "Type":"CO",
        "Id":"<ID>"
      },
      "CouId":"<CouId>",
      "Affiliation":"<Affiliation>",
      "Title":"<Title>",
      "O":"<O>",
      "Ordr":"<Order>",
      "Ou":"<Ou>",
      "SponsorCoPersonId":"<SponsorCoPersonId>",
      "ManagerCoPersonId":"<ManagerCoPersonId>", 
      "Status":("Active"|"Approved"|"Confirmed"|"Declined"|"Deleted"|"Denied"|"Duplicate"|"Expired"|"GracePeriod"|"Invited"|"Pending"|"PendingApproval"|"PendingConfirmation"|"PendingVetting"|"Suspended"),
      "ValidFrom":"<ValidFrom>",
      "ValidThrough":"<ValidThrough>",
      "Created":"<CreateTime>",
      "Modified":"<ModTime>",
      "ExtendedAttributes":
      {
        "<Attribute>":"<Value>",
        {...}
      }
    },
    {...}
  ]
}

XML Response

<!ELEMENT CoPersonRoles (CoPersonRole+)>
 <!ATTLIST CoPersonRoles Version CDATA #FIXED "1.0">
 <!ELEMENT CoPersonRole (CoPersonId,CouId?,EduPersonAffiliation,Title?,O?,Ou?,Status,ValidFrom?,ValidThrough?,ExtendedAttributes?)>
  <!ATTLIST CoPersonRole Version CDATA #FIXED "1.0">
  <!ATTLIST CoPersonRole Id ID>
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Type (CO)>
   <!ELEMENT Id (#PCDATA)>
  <!ELEMENT CouId (#PCDATA)>
  <!ELEMENT Affiliation (faculty|student|staff|alum|member|affiliate|employee|library-walk-in)>
  <!ELEMENT Title (#PCDATA)>
  <!ELEMENT O (#PCDATA)>
  <!ELEMENT Ordr (#PCDATA)>
  <!ELEMENT Ou (#PCDATA)>
  <!ELEMENT SponsorCoPersonId (#PCDATA)>
  <!ELEMENT ManagerCoPersonId (#PCDATA)> 
  <!ELEMENT Status (Active|Approved|Confirmed|Declined|Deleted|Denied|Duplicate|Expired|GracePeriod|Invited|Pending|PendingApproval|PendingConfirmation|PendingVetting|Suspended)>
  <!ELEMENT ValidFrom (#PCDATA)>
  <!ELEMENT ValidThrough (#PCDATA)>
  <!ELEMENT Created (#PCDATA)>
  <!ELEMENT Modified (#PCDATA)>
  <!ELEMENT ExtendedAttributes (Attribute,...)>
   <!ELEMENT Attribute (#PCDATA)>
  • No labels