PUT v1/{Client}/Matters/{MatterId}
Updates one Matter.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Client |
The code of the Client database to connect to. |
string |
Required |
MatterId |
The Id of the Matter. |
integer |
Required |
Body Parameters
GranicusMatter object to be updated. Note that MatterID is not required to be set.
GranicusMatterName | Description | Type | Additional information |
---|---|---|---|
MatterId | integer |
None. |
|
MatterGuid | string |
None. |
|
MatterLastModifiedUtc | date |
None. |
|
MatterRowVersion | Collection of byte |
None. |
|
MatterFile | string |
None. |
|
MatterName | string |
None. |
|
MatterTitle | string |
None. |
|
MatterTypeId | integer |
Required |
|
MatterTypeName | string |
None. |
|
MatterStatusId | integer |
Required |
|
MatterStatusName | string |
None. |
|
MatterBodyId | integer |
Required |
|
MatterBodyName | string |
None. |
|
MatterIntroDate | date |
None. |
|
MatterAgendaDate | date |
None. |
|
MatterPassedDate | date |
None. |
|
MatterEnactmentDate | date |
None. |
|
MatterEnactmentNumber | string |
None. |
|
MatterRequester | string |
None. |
|
MatterNotes | string |
None. |
|
MatterVersion | string |
None. |
|
MatterCost | decimal number |
None. |
|
MatterText1 | string |
None. |
|
MatterText2 | string |
None. |
|
MatterText3 | string |
None. |
|
MatterText4 | string |
None. |
|
MatterText5 | string |
None. |
|
MatterDate1 | date |
None. |
|
MatterDate2 | date |
None. |
|
MatterEXText1 | string |
None. |
|
MatterEXText2 | string |
None. |
|
MatterEXText3 | string |
None. |
|
MatterEXText4 | string |
None. |
|
MatterEXText5 | string |
None. |
|
MatterEXText6 | string |
None. |
|
MatterEXText7 | string |
None. |
|
MatterEXText8 | string |
None. |
|
MatterEXText9 | string |
None. |
|
MatterEXText10 | string |
None. |
|
MatterEXText11 | string |
None. |
|
MatterEXDate1 | date |
None. |
|
MatterEXDate2 | date |
None. |
|
MatterEXDate3 | date |
None. |
|
MatterEXDate4 | date |
None. |
|
MatterEXDate5 | date |
None. |
|
MatterEXDate6 | date |
None. |
|
MatterEXDate7 | date |
None. |
|
MatterEXDate8 | date |
None. |
|
MatterEXDate9 | date |
None. |
|
MatterEXDate10 | date |
None. |
|
MatterAgiloftId | integer |
None. |
|
MatterReference | string |
None. |
|
MatterRestrictViewViaWeb | boolean |
None. |
|
MatterReports | Collection of GranicusMatterReport |
None. |
Request Formats
application/json, text/json
Sample:
{ "MatterId": 1, "MatterGuid": "sample string 2", "MatterLastModifiedUtc": "2024-12-21T10:46:38.0277003-05:00", "MatterRowVersion": "QEA=", "MatterFile": "sample string 3", "MatterName": "sample string 4", "MatterTitle": "sample string 5", "MatterTypeId": 6, "MatterTypeName": "sample string 7", "MatterStatusId": 8, "MatterStatusName": "sample string 9", "MatterBodyId": 10, "MatterBodyName": "sample string 11", "MatterIntroDate": "2024-12-21T10:46:38.0277003-05:00", "MatterAgendaDate": "2024-12-21T10:46:38.0277003-05:00", "MatterPassedDate": "2024-12-21T10:46:38.0277003-05:00", "MatterEnactmentDate": "2024-12-21T10:46:38.0277003-05:00", "MatterEnactmentNumber": "sample string 12", "MatterRequester": "sample string 13", "MatterNotes": "sample string 14", "MatterVersion": "sample string 15", "MatterCost": 1.0, "MatterText1": "sample string 16", "MatterText2": "sample string 17", "MatterText3": "sample string 18", "MatterText4": "sample string 19", "MatterText5": "sample string 20", "MatterDate1": "2024-12-21T10:46:38.0277003-05:00", "MatterDate2": "2024-12-21T10:46:38.0277003-05:00", "MatterEXText1": "sample string 21", "MatterEXText2": "sample string 22", "MatterEXText3": "sample string 23", "MatterEXText4": "sample string 24", "MatterEXText5": "sample string 25", "MatterEXText6": "sample string 26", "MatterEXText7": "sample string 27", "MatterEXText8": "sample string 28", "MatterEXText9": "sample string 29", "MatterEXText10": "sample string 30", "MatterEXText11": "sample string 31", "MatterEXDate1": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate2": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate3": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate4": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate5": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate6": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate7": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate8": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate9": "2024-12-21T10:46:38.0433287-05:00", "MatterEXDate10": "2024-12-21T10:46:38.0433287-05:00", "MatterAgiloftId": 32, "MatterReference": "sample string 33", "MatterRestrictViewViaWeb": true, "MatterReports": [ { "ReportName": "Legislation Details", "ReportURL": "https://example.com/ViewReport.ashx?M=R&N=Master&GID=000&LEGID=0000&Title=Legislation+Details", "ReportType": "InSite" }, { "ReportName": "Legislation Details", "ReportURL": "https://example.com/ViewReport.ashx?M=R&N=Master&GID=000&LEGID=0000&Title=Legislation+Details", "ReportType": "InSite" } ] }
application/xml, text/xml
Sample:
<GranicusMatter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LegistarWebAPI.Models.v1"> <MatterAgendaDate>2024-12-21T10:46:38.0277003-05:00</MatterAgendaDate> <MatterAgiloftId>32</MatterAgiloftId> <MatterBodyId>10</MatterBodyId> <MatterBodyName>sample string 11</MatterBodyName> <MatterCost>1</MatterCost> <MatterDate1>2024-12-21T10:46:38.0277003-05:00</MatterDate1> <MatterDate2>2024-12-21T10:46:38.0277003-05:00</MatterDate2> <MatterEXDate1>2024-12-21T10:46:38.0433287-05:00</MatterEXDate1> <MatterEXDate10>2024-12-21T10:46:38.0433287-05:00</MatterEXDate10> <MatterEXDate2>2024-12-21T10:46:38.0433287-05:00</MatterEXDate2> <MatterEXDate3>2024-12-21T10:46:38.0433287-05:00</MatterEXDate3> <MatterEXDate4>2024-12-21T10:46:38.0433287-05:00</MatterEXDate4> <MatterEXDate5>2024-12-21T10:46:38.0433287-05:00</MatterEXDate5> <MatterEXDate6>2024-12-21T10:46:38.0433287-05:00</MatterEXDate6> <MatterEXDate7>2024-12-21T10:46:38.0433287-05:00</MatterEXDate7> <MatterEXDate8>2024-12-21T10:46:38.0433287-05:00</MatterEXDate8> <MatterEXDate9>2024-12-21T10:46:38.0433287-05:00</MatterEXDate9> <MatterEXText1>sample string 21</MatterEXText1> <MatterEXText10>sample string 30</MatterEXText10> <MatterEXText11>sample string 31</MatterEXText11> <MatterEXText2>sample string 22</MatterEXText2> <MatterEXText3>sample string 23</MatterEXText3> <MatterEXText4>sample string 24</MatterEXText4> <MatterEXText5>sample string 25</MatterEXText5> <MatterEXText6>sample string 26</MatterEXText6> <MatterEXText7>sample string 27</MatterEXText7> <MatterEXText8>sample string 28</MatterEXText8> <MatterEXText9>sample string 29</MatterEXText9> <MatterEnactmentDate>2024-12-21T10:46:38.0277003-05:00</MatterEnactmentDate> <MatterEnactmentNumber>sample string 12</MatterEnactmentNumber> <MatterFile>sample string 3</MatterFile> <MatterGuid>sample string 2</MatterGuid> <MatterId>1</MatterId> <MatterIntroDate>2024-12-21T10:46:38.0277003-05:00</MatterIntroDate> <MatterLastModifiedUtc>2024-12-21T10:46:38.0277003-05:00</MatterLastModifiedUtc> <MatterName>sample string 4</MatterName> <MatterNotes>sample string 14</MatterNotes> <MatterPassedDate>2024-12-21T10:46:38.0277003-05:00</MatterPassedDate> <MatterReference>sample string 33</MatterReference> <MatterReports> <GranicusMatterReport> <ReportName>Legislation Details</ReportName> <ReportType>InSite</ReportType> <ReportURL>https://example.com/ViewReport.ashx?M=R&N=Master&GID=000&LEGID=0000&Title=Legislation+Details</ReportURL> </GranicusMatterReport> <GranicusMatterReport> <ReportName>Legislation Details</ReportName> <ReportType>InSite</ReportType> <ReportURL>https://example.com/ViewReport.ashx?M=R&N=Master&GID=000&LEGID=0000&Title=Legislation+Details</ReportURL> </GranicusMatterReport> </MatterReports> <MatterRequester>sample string 13</MatterRequester> <MatterRestrictViewViaWeb>true</MatterRestrictViewViaWeb> <MatterRowVersion>QEA=</MatterRowVersion> <MatterStatusId>8</MatterStatusId> <MatterStatusName>sample string 9</MatterStatusName> <MatterText1>sample string 16</MatterText1> <MatterText2>sample string 17</MatterText2> <MatterText3>sample string 18</MatterText3> <MatterText4>sample string 19</MatterText4> <MatterText5>sample string 20</MatterText5> <MatterTitle>sample string 5</MatterTitle> <MatterTypeId>6</MatterTypeId> <MatterTypeName>sample string 7</MatterTypeName> <MatterVersion>sample string 15</MatterVersion> </GranicusMatter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns Id of the updated Matter as a string value when Accept header is "text/plain"; otherwise returns updated Matter as an object.
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |