POST api/DelegateGroups

Saves a new delegate group.

Request Information

URI Parameters

None.

Body Parameters

Returns the delegate group.

Name	Description	Type	Additional information
Id	The ID of the group.	integer	None.
TenantId	The ID of the Tenant that the group belongs to.	integer	None.
Name	The name of the group (for identifying it in the UI).	string	None.
Address	The address where the group is located, if applicable.	string	None.
GroupType	The type of the group, e.g. family, facility.	DelegateGroupType	None.
Phone	The group's phone number (if applicable).	string	None.
Description	A description of the group.	string	None.
FundingSourceId	References a funding source (if the group is associated with a funding source).	integer	None.
ServiceTypeId	References a funding source using a service type ID. As of TSPPORT-3920, we now support multiple service types via the ServiceTypeIds property instead.	integer	None.
ServiceTypeIds	References a funding source using service type Id(s).	Collection of integer	None.
LocationId	References a location in the paratransit app (PASS/NOVUS).	integer	None.
SecuritySettings	The default security settings and permissions for delegates in this group.	DelegateSecurity	None.
FundingSource	The funding source associated with the delegate group, if applicable. Determined using the .	FundingSource	None.
Location	Additional information about the location of the delegate group, including address and contact information. Determined using the .	Location	None.
RequiredClientInformation	Gets the information that a delegate in this group needs to know in order to look up a client to add them to the group	ClientFields	None.
NumClients	Gets or sets the number of clients that are in this delegate group. Does not include expired clients.	integer	None.
NumDelegates	Gets or sets the number of delegates that are in this delegate group.	integer	None.
AgencyIds	References the agency ids if delegate group type is Agency	Collection of integer	None.
Agencies	The agency associated with the deleate group, if applicable. Determined using the	Collection of Agency	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "tenantId": 5,
  "name": "Sample",
  "address": "521 Main Street",
  "groupType": 1,
  "phone": "555-555-2152",
  "description": "Sample Group",
  "fundingSourceId": 4,
  "serviceTypeId": null,
  "serviceTypeIds": null,
  "locationId": 432897,
  "securitySettings": {
    "canBookSubscriptions": false,
    "canBookTrips": true,
    "canEditProfile": false,
    "canViewProfile": true,
    "canCancelTrips": false,
    "canManagePassengerFeedback": false,
    "canEditCasualTrips": false,
    "canEditSubscriptionTrips": false,
    "canTopUpAccount": false,
    "canViewTransactionHistory": false
  },
  "fundingSource": {
    "id": 4,
    "name": "Community Fund",
    "description": "This is a sample funding source",
    "address": {
      "id": 432897,
      "description": "",
      "category": null,
      "categoryId": null,
      "name": "TripSpark Technologies",
      "latitude": 50.0713114,
      "longitude": -113.9944227,
      "streetNumber": "2175",
      "onStreet": "29 Street Northeast",
      "atStreet": null,
      "city": "Calgary",
      "state": "AB",
      "postalCode": "T1Y 7H8",
      "itemType": 0,
      "internalType": 0,
      "unit": null,
      "comments": "Address Comment",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "1",
        "contactType": "Main",
        "firstName": "Jane",
        "lastName": "Doe",
        "comments": null,
        "details": [
          {
            "id": 2,
            "contactString": "555-555-3760",
            "type": {
              "code": "Home",
              "name": "Home Phone",
              "type": 0
            },
            "isPreferred": false
          }
        ]
      },
      "country": null,
      "stopCode": null,
      "procedureModifier": null,
      "timeZoneId": null
    }
  },
  "location": {
    "id": 432897,
    "description": "",
    "category": null,
    "categoryId": null,
    "name": "TripSpark Technologies",
    "latitude": 50.0713114,
    "longitude": -113.9944227,
    "streetNumber": "2175",
    "onStreet": "29 Street Northeast",
    "atStreet": null,
    "city": "Calgary",
    "state": "AB",
    "postalCode": "T1Y 7H8",
    "itemType": 0,
    "internalType": 0,
    "unit": null,
    "comments": "Address Comment",
    "isGeocoded": true,
    "contact": {
      "id": 1,
      "referenceId": "1",
      "contactType": "Main",
      "firstName": "Jane",
      "lastName": "Doe",
      "comments": null,
      "details": [
        {
          "id": 2,
          "contactString": "555-555-3760",
          "type": {
            "code": "Home",
            "name": "Home Phone",
            "type": 0
          },
          "isPreferred": false
        }
      ]
    },
    "country": null,
    "stopCode": null,
    "procedureModifier": null,
    "timeZoneId": null
  },
  "requiredClientInformation": 0,
  "numClients": 0,
  "numDelegates": 0,
  "agencyIds": null,
  "agencies": null
}

application/xml, text/xml

Sample:

<DelegateGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <Address>521 Main Street</Address>
  <Agencies xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources" i:nil="true" />
  <AgencyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Description>Sample Group</Description>
  <FundingSource xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
    <d2p1:Address>
      <d2p1:AtStreet i:nil="true" />
      <d2p1:Category i:nil="true" />
      <d2p1:CategoryId i:nil="true" />
      <d2p1:City>Calgary</d2p1:City>
      <d2p1:Comments>Address Comment</d2p1:Comments>
      <d2p1:Contact>
        <d2p1:Comments i:nil="true" />
        <d2p1:ContactType>Main</d2p1:ContactType>
        <d2p1:Details>
          <d2p1:ContactDetail>
            <d2p1:ContactString>555-555-3760</d2p1:ContactString>
            <d2p1:ID>2</d2p1:ID>
            <d2p1:IsPreferred>false</d2p1:IsPreferred>
            <d2p1:Type>
              <d2p1:Code>Home</d2p1:Code>
              <d2p1:Name>Home Phone</d2p1:Name>
              <d2p1:Type>Phone</d2p1:Type>
            </d2p1:Type>
          </d2p1:ContactDetail>
        </d2p1:Details>
        <d2p1:FirstName>Jane</d2p1:FirstName>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:LastName>Doe</d2p1:LastName>
        <d2p1:ReferenceId>1</d2p1:ReferenceId>
      </d2p1:Contact>
      <d2p1:Country i:nil="true" />
      <d2p1:Description></d2p1:Description>
      <d2p1:ID>432897</d2p1:ID>
      <d2p1:InternalType>Location</d2p1:InternalType>
      <d2p1:IsGeocoded>true</d2p1:IsGeocoded>
      <d2p1:ItemType>Location</d2p1:ItemType>
      <d2p1:Latitude>50.0713114</d2p1:Latitude>
      <d2p1:Longitude>-113.9944227</d2p1:Longitude>
      <d2p1:Name>TripSpark Technologies</d2p1:Name>
      <d2p1:OnStreet>29 Street Northeast</d2p1:OnStreet>
      <d2p1:PostalCode>T1Y 7H8</d2p1:PostalCode>
      <d2p1:ProcedureModifier i:nil="true" />
      <d2p1:State>AB</d2p1:State>
      <d2p1:StopCode i:nil="true" />
      <d2p1:StreetNumber>2175</d2p1:StreetNumber>
      <d2p1:TimeZoneId i:nil="true" />
      <d2p1:Unit i:nil="true" />
    </d2p1:Address>
    <d2p1:Description>This is a sample funding source</d2p1:Description>
    <d2p1:Id>4</d2p1:Id>
    <d2p1:Name>Community Fund</d2p1:Name>
  </FundingSource>
  <FundingSourceId>4</FundingSourceId>
  <GroupType>Facility</GroupType>
  <Id>1</Id>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
    <d2p1:AtStreet i:nil="true" />
    <d2p1:Category i:nil="true" />
    <d2p1:CategoryId i:nil="true" />
    <d2p1:City>Calgary</d2p1:City>
    <d2p1:Comments>Address Comment</d2p1:Comments>
    <d2p1:Contact>
      <d2p1:Comments i:nil="true" />
      <d2p1:ContactType>Main</d2p1:ContactType>
      <d2p1:Details>
        <d2p1:ContactDetail>
          <d2p1:ContactString>555-555-3760</d2p1:ContactString>
          <d2p1:ID>2</d2p1:ID>
          <d2p1:IsPreferred>false</d2p1:IsPreferred>
          <d2p1:Type>
            <d2p1:Code>Home</d2p1:Code>
            <d2p1:Name>Home Phone</d2p1:Name>
            <d2p1:Type>Phone</d2p1:Type>
          </d2p1:Type>
        </d2p1:ContactDetail>
      </d2p1:Details>
      <d2p1:FirstName>Jane</d2p1:FirstName>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:LastName>Doe</d2p1:LastName>
      <d2p1:ReferenceId>1</d2p1:ReferenceId>
    </d2p1:Contact>
    <d2p1:Country i:nil="true" />
    <d2p1:Description></d2p1:Description>
    <d2p1:ID>432897</d2p1:ID>
    <d2p1:InternalType>Location</d2p1:InternalType>
    <d2p1:IsGeocoded>true</d2p1:IsGeocoded>
    <d2p1:ItemType>Location</d2p1:ItemType>
    <d2p1:Latitude>50.0713114</d2p1:Latitude>
    <d2p1:Longitude>-113.9944227</d2p1:Longitude>
    <d2p1:Name>TripSpark Technologies</d2p1:Name>
    <d2p1:OnStreet>29 Street Northeast</d2p1:OnStreet>
    <d2p1:PostalCode>T1Y 7H8</d2p1:PostalCode>
    <d2p1:ProcedureModifier i:nil="true" />
    <d2p1:State>AB</d2p1:State>
    <d2p1:StopCode i:nil="true" />
    <d2p1:StreetNumber>2175</d2p1:StreetNumber>
    <d2p1:TimeZoneId i:nil="true" />
    <d2p1:Unit i:nil="true" />
  </Location>
  <LocationId>432897</LocationId>
  <Name>Sample</Name>
  <NumClients>0</NumClients>
  <NumDelegates>0</NumDelegates>
  <Phone>555-555-2152</Phone>
  <RequiredClientInformation>None</RequiredClientInformation>
  <SecuritySettings>
    <CanBookSubscriptions>false</CanBookSubscriptions>
    <CanBookTrips>true</CanBookTrips>
    <CanCancelTrips>false</CanCancelTrips>
    <CanEditCasualTrips>false</CanEditCasualTrips>
    <CanEditProfile>false</CanEditProfile>
    <CanEditSubscriptionTrips>false</CanEditSubscriptionTrips>
    <CanManagePassengerFeedback>false</CanManagePassengerFeedback>
    <CanTopUpAccount>false</CanTopUpAccount>
    <CanViewProfile>true</CanViewProfile>
    <CanViewTransactionHistory>false</CanViewTransactionHistory>
  </SecuritySettings>
  <ServiceTypeId i:nil="true" />
  <ServiceTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <TenantId>5</TenantId>
</DelegateGroup>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DelegateGroup

Name	Description	Type	Additional information
Id	The ID of the group.	integer	None.
TenantId	The ID of the Tenant that the group belongs to.	integer	None.
Name	The name of the group (for identifying it in the UI).	string	None.
Address	The address where the group is located, if applicable.	string	None.
GroupType	The type of the group, e.g. family, facility.	DelegateGroupType	None.
Phone	The group's phone number (if applicable).	string	None.
Description	A description of the group.	string	None.
FundingSourceId	References a funding source (if the group is associated with a funding source).	integer	None.
ServiceTypeId	References a funding source using a service type ID. As of TSPPORT-3920, we now support multiple service types via the ServiceTypeIds property instead.	integer	None.
ServiceTypeIds	References a funding source using service type Id(s).	Collection of integer	None.
LocationId	References a location in the paratransit app (PASS/NOVUS).	integer	None.
SecuritySettings	The default security settings and permissions for delegates in this group.	DelegateSecurity	None.
FundingSource	The funding source associated with the delegate group, if applicable. Determined using the .	FundingSource	None.
Location	Additional information about the location of the delegate group, including address and contact information. Determined using the .	Location	None.
RequiredClientInformation	Gets the information that a delegate in this group needs to know in order to look up a client to add them to the group	ClientFields	None.
NumClients	Gets or sets the number of clients that are in this delegate group. Does not include expired clients.	integer	None.
NumDelegates	Gets or sets the number of delegates that are in this delegate group.	integer	None.
AgencyIds	References the agency ids if delegate group type is Agency	Collection of integer	None.
Agencies	The agency associated with the deleate group, if applicable. Determined using the	Collection of Agency	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "tenantId": 5,
  "name": "Sample",
  "address": "521 Main Street",
  "groupType": 1,
  "phone": "555-555-2152",
  "description": "Sample Group",
  "fundingSourceId": 4,
  "serviceTypeId": null,
  "serviceTypeIds": null,
  "locationId": 432897,
  "securitySettings": {
    "canBookSubscriptions": false,
    "canBookTrips": true,
    "canEditProfile": false,
    "canViewProfile": true,
    "canCancelTrips": false,
    "canManagePassengerFeedback": false,
    "canEditCasualTrips": false,
    "canEditSubscriptionTrips": false,
    "canTopUpAccount": false,
    "canViewTransactionHistory": false
  },
  "fundingSource": {
    "id": 4,
    "name": "Community Fund",
    "description": "This is a sample funding source",
    "address": {
      "id": 432897,
      "description": "",
      "category": null,
      "categoryId": null,
      "name": "TripSpark Technologies",
      "latitude": 50.0713114,
      "longitude": -113.9944227,
      "streetNumber": "2175",
      "onStreet": "29 Street Northeast",
      "atStreet": null,
      "city": "Calgary",
      "state": "AB",
      "postalCode": "T1Y 7H8",
      "itemType": 0,
      "internalType": 0,
      "unit": null,
      "comments": "Address Comment",
      "isGeocoded": true,
      "contact": {
        "id": 1,
        "referenceId": "1",
        "contactType": "Main",
        "firstName": "Jane",
        "lastName": "Doe",
        "comments": null,
        "details": [
          {
            "id": 2,
            "contactString": "555-555-3760",
            "type": {
              "code": "Home",
              "name": "Home Phone",
              "type": 0
            },
            "isPreferred": false
          }
        ]
      },
      "country": null,
      "stopCode": null,
      "procedureModifier": null,
      "timeZoneId": null
    }
  },
  "location": {
    "id": 432897,
    "description": "",
    "category": null,
    "categoryId": null,
    "name": "TripSpark Technologies",
    "latitude": 50.0713114,
    "longitude": -113.9944227,
    "streetNumber": "2175",
    "onStreet": "29 Street Northeast",
    "atStreet": null,
    "city": "Calgary",
    "state": "AB",
    "postalCode": "T1Y 7H8",
    "itemType": 0,
    "internalType": 0,
    "unit": null,
    "comments": "Address Comment",
    "isGeocoded": true,
    "contact": {
      "id": 1,
      "referenceId": "1",
      "contactType": "Main",
      "firstName": "Jane",
      "lastName": "Doe",
      "comments": null,
      "details": [
        {
          "id": 2,
          "contactString": "555-555-3760",
          "type": {
            "code": "Home",
            "name": "Home Phone",
            "type": 0
          },
          "isPreferred": false
        }
      ]
    },
    "country": null,
    "stopCode": null,
    "procedureModifier": null,
    "timeZoneId": null
  },
  "requiredClientInformation": 0,
  "numClients": 0,
  "numDelegates": 0,
  "agencyIds": null,
  "agencies": null
}

application/xml, text/xml

Sample:

<DelegateGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
  <Address>521 Main Street</Address>
  <Agencies xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources" i:nil="true" />
  <AgencyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Description>Sample Group</Description>
  <FundingSource xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
    <d2p1:Address>
      <d2p1:AtStreet i:nil="true" />
      <d2p1:Category i:nil="true" />
      <d2p1:CategoryId i:nil="true" />
      <d2p1:City>Calgary</d2p1:City>
      <d2p1:Comments>Address Comment</d2p1:Comments>
      <d2p1:Contact>
        <d2p1:Comments i:nil="true" />
        <d2p1:ContactType>Main</d2p1:ContactType>
        <d2p1:Details>
          <d2p1:ContactDetail>
            <d2p1:ContactString>555-555-3760</d2p1:ContactString>
            <d2p1:ID>2</d2p1:ID>
            <d2p1:IsPreferred>false</d2p1:IsPreferred>
            <d2p1:Type>
              <d2p1:Code>Home</d2p1:Code>
              <d2p1:Name>Home Phone</d2p1:Name>
              <d2p1:Type>Phone</d2p1:Type>
            </d2p1:Type>
          </d2p1:ContactDetail>
        </d2p1:Details>
        <d2p1:FirstName>Jane</d2p1:FirstName>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:LastName>Doe</d2p1:LastName>
        <d2p1:ReferenceId>1</d2p1:ReferenceId>
      </d2p1:Contact>
      <d2p1:Country i:nil="true" />
      <d2p1:Description></d2p1:Description>
      <d2p1:ID>432897</d2p1:ID>
      <d2p1:InternalType>Location</d2p1:InternalType>
      <d2p1:IsGeocoded>true</d2p1:IsGeocoded>
      <d2p1:ItemType>Location</d2p1:ItemType>
      <d2p1:Latitude>50.0713114</d2p1:Latitude>
      <d2p1:Longitude>-113.9944227</d2p1:Longitude>
      <d2p1:Name>TripSpark Technologies</d2p1:Name>
      <d2p1:OnStreet>29 Street Northeast</d2p1:OnStreet>
      <d2p1:PostalCode>T1Y 7H8</d2p1:PostalCode>
      <d2p1:ProcedureModifier i:nil="true" />
      <d2p1:State>AB</d2p1:State>
      <d2p1:StopCode i:nil="true" />
      <d2p1:StreetNumber>2175</d2p1:StreetNumber>
      <d2p1:TimeZoneId i:nil="true" />
      <d2p1:Unit i:nil="true" />
    </d2p1:Address>
    <d2p1:Description>This is a sample funding source</d2p1:Description>
    <d2p1:Id>4</d2p1:Id>
    <d2p1:Name>Community Fund</d2p1:Name>
  </FundingSource>
  <FundingSourceId>4</FundingSourceId>
  <GroupType>Facility</GroupType>
  <Id>1</Id>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
    <d2p1:AtStreet i:nil="true" />
    <d2p1:Category i:nil="true" />
    <d2p1:CategoryId i:nil="true" />
    <d2p1:City>Calgary</d2p1:City>
    <d2p1:Comments>Address Comment</d2p1:Comments>
    <d2p1:Contact>
      <d2p1:Comments i:nil="true" />
      <d2p1:ContactType>Main</d2p1:ContactType>
      <d2p1:Details>
        <d2p1:ContactDetail>
          <d2p1:ContactString>555-555-3760</d2p1:ContactString>
          <d2p1:ID>2</d2p1:ID>
          <d2p1:IsPreferred>false</d2p1:IsPreferred>
          <d2p1:Type>
            <d2p1:Code>Home</d2p1:Code>
            <d2p1:Name>Home Phone</d2p1:Name>
            <d2p1:Type>Phone</d2p1:Type>
          </d2p1:Type>
        </d2p1:ContactDetail>
      </d2p1:Details>
      <d2p1:FirstName>Jane</d2p1:FirstName>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:LastName>Doe</d2p1:LastName>
      <d2p1:ReferenceId>1</d2p1:ReferenceId>
    </d2p1:Contact>
    <d2p1:Country i:nil="true" />
    <d2p1:Description></d2p1:Description>
    <d2p1:ID>432897</d2p1:ID>
    <d2p1:InternalType>Location</d2p1:InternalType>
    <d2p1:IsGeocoded>true</d2p1:IsGeocoded>
    <d2p1:ItemType>Location</d2p1:ItemType>
    <d2p1:Latitude>50.0713114</d2p1:Latitude>
    <d2p1:Longitude>-113.9944227</d2p1:Longitude>
    <d2p1:Name>TripSpark Technologies</d2p1:Name>
    <d2p1:OnStreet>29 Street Northeast</d2p1:OnStreet>
    <d2p1:PostalCode>T1Y 7H8</d2p1:PostalCode>
    <d2p1:ProcedureModifier i:nil="true" />
    <d2p1:State>AB</d2p1:State>
    <d2p1:StopCode i:nil="true" />
    <d2p1:StreetNumber>2175</d2p1:StreetNumber>
    <d2p1:TimeZoneId i:nil="true" />
    <d2p1:Unit i:nil="true" />
  </Location>
  <LocationId>432897</LocationId>
  <Name>Sample</Name>
  <NumClients>0</NumClients>
  <NumDelegates>0</NumDelegates>
  <Phone>555-555-2152</Phone>
  <RequiredClientInformation>None</RequiredClientInformation>
  <SecuritySettings>
    <CanBookSubscriptions>false</CanBookSubscriptions>
    <CanBookTrips>true</CanBookTrips>
    <CanCancelTrips>false</CanCancelTrips>
    <CanEditCasualTrips>false</CanEditCasualTrips>
    <CanEditProfile>false</CanEditProfile>
    <CanEditSubscriptionTrips>false</CanEditSubscriptionTrips>
    <CanManagePassengerFeedback>false</CanManagePassengerFeedback>
    <CanTopUpAccount>false</CanTopUpAccount>
    <CanViewProfile>true</CanViewProfile>
    <CanViewTransactionHistory>false</CanViewTransactionHistory>
  </SecuritySettings>
  <ServiceTypeId i:nil="true" />
  <ServiceTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <TenantId>5</TenantId>
</DelegateGroup>